openapi: 3.0.2
info:
  title: Documentação da API Belvo
  version: 1.221.0
  description: >-
    # Introdução


    Alcance novos públicos e converta mais usuários conectando-se fácil e
    seguramente aos dados financeiros deles, entendendo seu comportamento e
    possibilitando pagamentos instantâneos com open finance. Através da nossa
    API, você pode acessar:


    ## Informações Disponíveis e Métodos de Pagamento


    A Belvo é uma API de open banking para a América Latina que permite que
    empresas acessem informações bancárias e fiscais de maneira segura e ágil.


    Através da nossa API, você pode acessar:


    - Informações Bancárias no Brasil

    - Informações de Emprego no Brasil

    - Informações de Emprego no México

    - Informações Fiscais no México

    - Informações Fiscais no Chile


    Você também pode usar nossa API para realizar pagamentos em:


    - Brasil

    - México


    ## Dicionários de Dados


    Se você deseja a documentação de resposta em formato Excel ou CSV, por
    favor, faça o download a partir do nosso Repositório Público no GitHub: <a
    href="https://github.com/belvo-finance-opensource/documentation"
    target="_blank">Belvo Open Finance Data Dictionaries</a>.


    Nossos arquivos EXCEL e CSV estão adicionalmente localizados em Espanhol e
    Português (Brasil).


    ## Ambientes


    Atualmente, oferecemos dois ambientes: sandbox e produção.


    ### Sandbox


    Disponível para:


    - 🟢 Agregação e Enriquecimento

    - ⚪️ Iniciação de Pagamento


    Use nosso ambiente Sandbox para construir sua integração. Oferecemos dados
    fictícios que imitam casos de uso do mundo real, o que significa que você
    pode testar todos os endpoints, usar o widget e implementar webhooks -
    exatamente como faria com dados reais!


    Tudo o que você precisa para começar com o ambiente Sandbox é obter suas
    chaves de API. Recomendamos fortemente que você comece a criar sua
    integração neste ambiente.


    ### Produção


    Disponível para:


    - 🟢 Agregação e Enriquecimento

    - 🟢 Iniciação de Pagamento


    Depois de testar sua integração no ambiente Sandbox e estar pronto para
    entrar em operação, você precisará solicitar acesso ao nosso ambiente de
    Produção. Após solicitar o acesso, nossa equipe de Vendas entrará em contato
    para agendar uma reunião apenas para garantir que suas necessidades sejam
    atendidas, e então você precisará passar por um processo de certificação com
    um de nossos engenheiros para garantir que sua integração esteja funcionando
    de forma otimizada. Para se preparar para a reunião de certificação, basta
    seguir nossa lista de verificação de Integração.


    Uma vez que sua integração esteja certificada, tudo o que você precisará
    fazer é:

     - [ ] Solicitar chaves de API de Produção (e alterar suas chaves de API do Sandbox no código para estas novas).
     - [ ] Alterar a URL base para a qual você faz solicitações de `sandbox.belvo.com` para `api.belvo.com`.
     - [ ] Se você estiver usando webhooks, certifique-se de definir uma URL de Produção para seus webhooks.

    ## Códigos de Resposta


    Usamos o seguinte código de status HTTP na resposta, dependendo do sucesso
    ou falha:


    | Código de Status | Descrição |

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

    | `200` | ✅ **Sucesso** - O conteúdo está disponível no corpo da resposta. |

    | `201` | ✅ **Sucesso** - O conteúdo foi criado com sucesso na Belvo. |

    | `204` | ✅ **Sucesso** - Nenhum conteúdo para retornar. |

    | `400` | ❌ **Erro de Solicitação Inválida** - A solicitação retornou um
    erro, detalhe no conteúdo.|

    | `401` | ❌ **Não Autorizado** - As credenciais da Belvo fornecidas não são
    válidas.|

    | `404` | ❌ **Não Encontrado** - O recurso que você tentou acessar não pode
    ser encontrado.|

    | `405` | ❌ **Método Não Permitido** - O método HTTP que você está usando
    não é aceito para este recurso.|

    | `408` | ❌ **Tempo de Solicitação Esgotado** - A solicitação expirou e foi
    encerrada pelo servidor.|

    | `428` | ❌ **Token MFA Necessário** - O token MFA foi exigido pela
    instituição para conectar. |

    | `500` | ❌ **Erro Interno do Servidor** - O detalhe do erro está disponível
    no corpo da resposta.|


    ## Tratamento de Erros


    Os erros da API Belvo são retornados em formato JSON. Por exemplo, um erro
    pode ser assim:


    ```json

    [
        {
          "request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
          "message": "Este campo é obrigatório.",
          "code": "required",
          "field": "link"
        }
    ]

    ```


    Normalmente, uma resposta de erro terá os seguintes parâmetros:


    - `request_id`: um ID único para a solicitação, você deve compartilhá-lo com
    a equipe de suporte da Belvo para investigações.

    - `message`: descrição legível do erro.

    - `code`: um código único para o erro. Verifique a tabela abaixo para ver
    como lidar com cada código de erro.

    - `field` *(opcional)*: O campo específico no corpo da solicitação que tem
    um problema.


    ### Identificador de Solicitação


    Quando você precisar de ajuda com um erro específico, inclua o identificador
    de solicitação (`request_id`) em sua mensagem para a equipe de suporte da
    Belvo. Isso acelerará as investigações e fará com que você volte a funcionar
    rapidamente.


    ### Códigos de Erro e Solução de Problemas


    Para uma lista completa de erros e como solucioná-los, consulte nosso artigo
    dedicado <a href="../developer_resources/resources-belvo-api-errors"
    target="_blank">Tratamento de Erros</a>.


    ### Política de Repetição


    #### Erros 50x


    Implemente uma repetição automática exponencial de até cinco tentativas.
    Recomendamos usar um intervalo base de três segundos com um fator de dois.
    Por exemplo, a primeira repetição deve ser após três segundos, a segunda
    repetição após seis segundos (2 * 3), a terceira repetição após 12 segundos
    (2 * 6), a quarta repetição após 24 segundos (2 * 12) e a quinta repetição
    após 48 segundos (2 * 24).


    #### Erros 40x


    Você não deve tentar novamente fazer solicitações se receber uma resposta
    40x, pois isso é um erro do cliente.


    A única exceção é o erro "Muitas Sessões", pois isso significa que seu
    usuário final está acessando a conta de outro navegador ao mesmo tempo.
    Nesse caso, implemente a mesma política de repetição que para erros 50x.


    ## Campos Obsoletos


    Em nosso esquema, você pode ver que um campo foi marcado como `deprecated`.
    Isso significa que este campo não é mais mantido pela equipe da Belvo. Você
    ainda pode receber dados para este campo dependendo da instituição, no
    entanto, você não deve **confiar** neste campo.


    ## OpenAPI: campos obrigatórios e anuláveis


    Em nossa especificação de API, você verá que alguns parâmetros de resposta
    terão uma anotação **required**. De acordo com a especificação OpenAPI,
    quando um parâmetro de resposta é marcado como **required**, isso significa
    que a chave de resposta deve ser retornada. No entanto, o valor desse
    parâmetro de resposta pode ser `null`.


    > 📘 Informação

    > 

    > Em resumo, qualquer parâmetro de resposta marcado como obrigatório será
    retornado pela nossa API, mas o valor pode ser definido como nulo.
  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: Ambiente de Testes
security:
  - basicAuth: []
tags:
  - name: Institutions
    description: >-
      Uma **instituição** é uma entidade da qual a Belvo pode acessar
      informações. Pode ser uma:


      - instituição bancária, como o Nubank Brasil.

      - instituição fiscal, como o *Servicio de Administración Tributaria (SAT)*
      no México.

      - instituição de emprego, como o *Instituto Mexicano del Seguro Social
      (IMSS)* no México ou o *Instituto Nacional do Seguro Social (INSS)* no
      Brasil.
  - name: Links
    description: >-
      Um **Link** é um conjunto de credenciais associado ao acesso de um usuário
      final a uma **instituição**. Você precisará registrar um **Link** antes de
      acessar informações desse usuário final específico, como detalhes de conta
      ou transações.


      Recomendamos usar o Belvo Hosted Widget para gerenciar o processo de
      conexão.
  - name: Consents
    description: >-
      Um consentimento é uma permissão dada pelo usuário final para acessar seus
      dados financeiros na Rede de Open Finance no Brasil.
  - name: Accounts
    description: >-
      Uma **conta** é a representação de uma conta bancária dentro de uma
      instituição financeira. Um usuário pode ter uma ou mais contas em uma
      instituição.


      Por exemplo, um usuário (ou link) pode ter uma conta corrente, vários
      cartões de crédito e uma conta de empréstimo.


      Consultar as informações da conta de um usuário é útil, pois você pode
      obter informações sobre:


      - quais tipos de contas o usuário possui.

      - o saldo de cada conta (poupança, corrente, cartão de crédito,
      empréstimo, etc.).

      - informações detalhadas sobre os gastos com cartão de crédito.

      - a situação atual de quaisquer empréstimos que possam ter.
  - name: Transactions
    description: >-
      Uma **transação** contém as informações detalhadas de cada movimento
      dentro de uma conta. Por exemplo, uma compra em uma loja ou em um
      restaurante.
  - name: Owners
    description: >-
      Um **proprietário** representa a pessoa que tem acesso a um Link e é o
      proprietário de todas as contas dentro do Link.


      Você pode usar este endpoint para obter informações úteis sobre seu
      cliente, como:


      - seu nome completo

      - informações de contato principais

      - informações sobre o documento de identidade que usaram ao abrir a conta
  - name: Bills
    description: >-
      Uma **bill** refere-se à fatura do cartão de crédito que um usuário recebe
      para uma determinada conta.
  - name: Balances
    description: >-
      Um saldo é a quantidade de dinheiro disponível em uma determinada conta
      bancária (corrente ou poupança) em um determinado momento.
  - name: Employments Brazil
    description: >-
      Nosso recurso de empregos para o Brasil permite que você obtenha uma visão
      abrangente do histórico de emprego atual e das informações salariais do
      seu usuário.


      Para cada usuário, nós retornamos:


      - histórico de trabalho (incluindo ocupações e dados do empregador)

      - informações salariais históricas e atuais (por empregador)


      No momento, o recurso de empregos está disponível para:


      - 🇧🇷 Brasil (INSS)
  - name: Employment Records Mexico
    description: >-
      Nosso recurso de registros de emprego para o México permite que você
      obtenha uma visão abrangente das contribuições atuais para a seguridade
      social e do histórico de emprego do seu usuário.


      Com o recurso de registros de emprego da Belvo para o México, você pode
      acessar informações sobre as contribuições atuais para a seguridade social
      e o histórico de emprego do seu usuário. Para cada usuário, retornamos:


      - dados pessoais

      - histórico de trabalho

      - salário base diário histórico e atual

      - e mais!


      No momento, o recurso de registros de emprego está disponível para:


      - 🇲🇽 México (IMSS)

      - 🇲🇽 México (ISSSTE)
  - name: Incomes
    description: >-
      Use o endpoint Incomes para obter insights sobre as fontes de renda de uma
      conta nos últimos 365 dias. O endpoint é particularmente útil quando você
      deseja verificar a renda de uma pessoa.


      > 📘 Info

      >

      > O recurso incomes está **disponível apenas** para contas Corrente e
      Poupança associadas a links bancários.
  - name: Recurring Expenses
    description: >-
      A API de Despesas Recorrentes da Belvo permite que você identifique os
      pagamentos regulares de um usuário para serviços de assinatura, como
      Netflix ou assinaturas de academia, bem como pagamentos de serviços
      públicos, como contas de eletricidade ou telefone. Nós retornamos
      informações de até 365 dias.


      > 📘 Informação

      >

      > O recurso de despesas recorrentes está **disponível apenas** para contas
      Corrente, Poupança e de Cartão de Crédito associadas a links bancários.
  - name: Payment Institutions (Brazil)
    description: >-
      Uma **instituição de pagamento** é uma entidade da qual a Belvo pode
      acessar informações. Você pode ver uma lista completa de instituições
      disponíveis para pagamentos fazendo uma solicitação de List para este
      endpoint.
  - name: Customers (Brazil)
    description: >-
      Um **customer** é o pagador que vai transferir fundos para sua conta
      bancária. Você precisa criar um customer para receber pagamentos de
      entrada na conta bancária da sua organização.
  - name: Bank Accounts (Brazil)
    description: >-
      Para receber pagamentos de entrada na conta bancária da sua organização,
      você deve registrar as contas bancárias (individuais e empresariais)
      usando a Payments API da Belvo.


      - Contas bancárias **individuais** devem ser criadas para cada pagador
      (seu cliente).

      - Contas bancárias **empresariais** precisam ser criadas para o
      beneficiário do pagamento (sua organização).
  - name: Payment Links (Brazil)
    description: Este é um link de pagamento.
  - name: Payment Intents (Brazil)
    description: >-
      Um **payment intent** é um ponto único de acesso para criar pagamentos
      usando qualquer método de pagamento oferecido pela Belvo.


      Um payment intent captura todas as informações de pagamento (como o valor
      a ser cobrado, a descrição do pagamento, o provedor, etc.) e guia seus
      clientes através do fluxo de pagamento.


      > **Nota:** Para instituições que exigem o `username_type` no array
      `form_fields`, você deve enviar esse valor na sua solicitação PATCH.
  - name: Payment Authorizations (Brazil)
    description: >-
      Uma Autorização de Pagamento é o consentimento que seu usuário dá para que
      você debite dinheiro de suas contas. Você precisa realizar uma Autorização
      de Pagamento por ‘contrato’ (por exemplo, se sua empresa fornece tanto
      eletricidade quanto água, mas elas são cobradas separadamente, então você
      criará duas Autorizações de Pagamento separadas).


      Assim que o usuário confirmar a autorização, você precisará escutar um
      webhook `PAYMENT_AUTHORIZATION` com o status definido como `AUTHORIZED`.
      Assim que você receber esse webhook, o processo de autorização estará
      completo, e você poderá cobrar seu usuário.


      {% admonition type="info" name="O que é uma cobrança?" %}

      Uma **cobrança** representa o pagamento individual (débito) que seu
      cliente fará.

      {% /admonition %}


      {% admonition type="danger" name="Cabeçalho de Versão" %}
        O recurso de Autorização de Pagamento requer que você envie o cabeçalho `X-Belvo-API-Resource-Version` configurado para `Payments-BR.V2`.
      {% /admonition %}
  - name: Biometric Pix Widget Access Token (Brazil)
    description: >-
      Use as solicitações de Token do Biometric Pix Widget para criar um token
      de acesso para Pagamentos Biométricos.
  - name: Payment Transactions (Brazil)
    description: >-
      Cada vez que você recebe um pagamento de entrada de um cliente, uma
      **transação** é criada no banco de dados da Belvo.


      Você pode usar o recurso de Transações de Pagamento para obter informações
      úteis sobre uma transação, bem como a cobrança específica associada a ela.
paths:
  /api/institutions/:
    get:
      tags:
        - Institutions
      operationId: ListInstitutions
      summary: Listar instituições
      description: >-
        ## ▶️ Uso


        Com o método List Institutions, você pode:


        1. Listar todas as instituições disponíveis no Belvo.


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas do
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de instituição.
                        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: Obter os detalhes de uma instituição
      description: Obtenha os detalhes de uma instituição específica.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            O `institution.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            pattern: '[0-9]+'
      responses:
        '200':
          description: Ok
          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: Listar links
      description: >-
        ## ▶️ Uso


        Com o método List Links, você pode:


        1. Listar todos os links relacionados à sua conta Belvo (sem usar
        parâmetros de consulta).

        2. Obter os detalhes de um `link.id` específico (usando o parâmetro de
        consulta `id`).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de link.
                        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 um novo link
      description: >-
        ## ▶️ Uso


        Registre um novo link (uma conexão entre seu usuário e sua instituição)
        usando a API da Belvo.


        > 👍 Recomendamos fortemente o uso do nosso <a
        href="https://developers.belvo.com/docs/connect-widget"
        target="_blank">Connect Widget</a> para gerenciar a criação de links e
        atualizações de status de links.


        Para facilitar, incluímos exemplos personalizados para os links que você
        pode criar para cada um dos nossos produtos. Basta clicar no tipo de
        link que você deseja criar na seção **Body Params** abaixo.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/LinksRequestEmploymentBrazil'
                - $ref: '#/components/schemas/LinksRequestEmploymentMexico'
                - $ref: '#/components/schemas/LinksRequestFiscalMexico'
      responses:
        '201':
          description: Criado
          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: Solicitação completa de links
      description: >-
        Usado para retomar uma sessão de registro de Link que foi pausada porque
        um token MFA foi exigido pela instituição.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok
          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: Obter detalhes de um link
      description: Obtenha os detalhes de um link específico.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O `link.id` sobre o qual você deseja obter informações detalhadas.
      responses:
        '200':
          description: Ok
          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 a recuperação de dados de um link
      description: >-
        Modificar as configurações de recuperação de dados para um link
        específico. Atualmente, você pode:


        - Alterar o modo de acesso de um link de `single` para `recurrent` ou de
        `recurrent` para `single`.

        - Modificar o período `stale_in` para o link.

        - Modificar os recursos históricos que você deseja recuperar para o link
        (`fetch_resources`).


        ## Alterando o `access_mode` de um link


        Quando você altera um link de `single` para `recurrent`, no dia seguinte
        é acionada uma atualização histórica dos recursos principais para o link
        (resultando no recebimento de webhooks de `historical_update` para o
        link). Você será cobrado por essas atualizações históricas.


        ## Modificando `stale_in`


        Se você apenas modificar o período `stale_in` para um link, isso não
        acionará uma atualização histórica. Para acionar uma atualização
        histórica para o link, você deve alterar o `access_mode`.


        ## Modificando `fetch_resources`


        Se você apenas modificar o `fetch_resources` para um link, isso não
        acionará uma atualização histórica. Para acionar uma atualização
        histórica para o link, você deve alterar o `access_mode`.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
          description: O `link.id` para o qual você deseja alterar o `access_mode`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeAccessMode'
      responses:
        '200':
          description: Ok
          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: Atualizar as credenciais de um link
      description: >-
        Atualize as credenciais de um link específico. Se o link atualizado com
        sucesso for recorrente, acionamos automaticamente uma atualização do
        link. Se encontrarmos dados novos, você <a
        href="https://developers.belvo.com/docs/webhooks"
        target="_blank">receberá webhooks de atualização histórica</a>.


        > 👍 Use nosso Connect Widget

        >

        > Recomendamos usar nosso <a
        href="https://developers.belvo.com/docs/connect-widget"
        target="_blank">Connect Widget</a> para lidar com a atualização de links
        <code>invalid</code> ou <code>token_required</code>.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O `link.id` que você deseja atualizar.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinksPutRequest'
      responses:
        '200':
          description: Ok
          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: Excluir um link
      description: >-
        Exclua um link específico e todos os dados associados (por exemplo:
        transações, contas, faturas, declarações de impostos, empregos, etc.)
        desse link da sua conta Belvo. Esta ação é irreversível e você não
        poderá recuperar os dados excluídos.


        {% admonition type="success" name="Use o cabeçalho X-Belvo-Request-Mode:
        async" %}
          Recomendamos fortemente definir o cabeçalho `X-Belvo-Request-Mode` como `async` para habilitar a exclusão assíncrona. Dessa forma, você evitará o limite de taxa de 5 exclusões por minuto. Quando configurado, o endpoint responderá com um status `202 Accepted` e fornecerá um ID de solicitação para rastrear o processo de exclusão. Assim que o processo for concluído, você receberá uma notificação webhook `link_deleted`.
          
          Se você não definir este cabeçalho, o endpoint responderá com um status `204 No Content`, mas você estará sujeito ao limite de taxa de 5 exclusões por minuto. Se exceder esse limite, você receberá um erro `429 Too Many Requests`.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O `link.id` que você deseja excluir.
        - name: X-Belvo-Request-Mode
          in: header
          required: false
          schema:
            type: string
            enum:
              - async
          description: >-
            Defina como `async` para habilitar a exclusão assíncrona, que ignora
            a limitação de taxa. Quando configurado, o endpoint retorna uma
            resposta `202 Accepted` com um ID de solicitação. Você receberá
            posteriormente uma notificação de webhook quando a exclusão for
            concluída.
      responses:
        '202':
          description: Aceito
          content:
            application/json:
              schema:
                type: object
                properties:
                  request_id:
                    type: string
                    format: uuid
                    description: >-
                      O identificador único para rastrear a solicitação de
                      exclusão assíncrona.
                required:
                  - request_id
        '204':
          description: Sem conteúdo
        '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/consents/:
    get:
      tags:
        - Consents
      operationId: ListConsents
      summary: Listar consentimentos
      description: >-
        ## ▶️ Uso


        Com o método Consents, você pode:


        1. Listar todos os consentimentos relacionados à sua conta Belvo (sem
        usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de consentimento.
                        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: Obter os detalhes de um consentimento
      description: Obtenha os detalhes de um consentimento específico.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            O `consent.id` sobre o qual você deseja obter informações
            detalhadas.
      responses:
        '200':
          description: Ok
          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: Gerar um token de acesso para o widget
      operationId: GenerateWidgetAccessToken
      description: Gerar um token de acesso para o widget OFDA ou Banking Aggregation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/WidgetTokenRequestOFDA'
                - $ref: '#/components/schemas/WidgetTokenRequestBankingAggregation'
      responses:
        '200':
          description: Operação bem-sucedida
          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 contas
      description: >-
        ## ▶️ Uso


        Com o método List Accounts, você pode:


        1. Listar contas relacionadas a um `link.id` específico (usando o
        parâmetro de consulta `link`).

        2. Obter os detalhes de um `account.id` específico (usando o parâmetro
        de consulta `id`).

        3. **[Não Recomendado]** Listar todas as contas relacionadas à sua conta
        Belvo (sem usar nenhum parâmetro de consulta).


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a>.


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, veja nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🚨 Campos Obsoletos


        Este recurso pode retornar campos obsoletos. Na documentação de
        resposta, você pode ver que um campo foi marcado como **obsoleto**. Isso
        significa que este campo não é mais mantido pela equipe da Belvo. Você
        ainda pode receber dados para este campo dependendo da instituição, no
        entanto, não deve confiar neste 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: Ok
          content:
            application/json:
              schema:
                type: object
                title: Contas (OFDA Brasil)
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Um array de objetos de conta.
                        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 contas para um link
      description: |-
        Recupere contas de um link existente.

        {% admonition type="info" %}
          Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
        {% /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 (quando `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: Criado (quando `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: Concluir uma solicitação de contas
      description: >-
        Usado para retomar uma sessão de recuperação de Conta que foi pausada
        porque um token MFA foi exigido pela instituição.


        {% admonition type="info" %}
          Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
        {% /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 (quando `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: Criado (quando `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: Obter os detalhes de uma conta
      description: |-
        Obtenha os detalhes de uma conta específica.

        {% admonition type="info" %}
          Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `account.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma conta
      description: |-
        Excluir uma conta específica da sua conta Belvo.

        {% admonition type="danger" name="Rate Limited" %}
          Este endpoint possui limite de taxa. Você pode excluir apenas 5 itens por minuto. Se exceder esse limite, você receberá um código de status `429`.
        {% /admonition %}

        {% admonition type="info" %}
          Ao excluir uma conta, todas as transações associadas e informações do proprietário para essa conta também são removidas.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          description: O `account.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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


        Com o método Listar Saldos, você pode:


        1. **[Obrigatório]** Listar saldos relacionados a um `link.id`
        específico (usando o parâmetro de consulta `link`).

        2. **[Altamente Recomendado]** Listar saldos relacionados a um `link.id`
        e `account.id` específicos (usando os parâmetros de consulta `link` e
        `account`).

        3. Obter os detalhes de um `balance.id` específico (usando o parâmetro
        de consulta `id`).


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a>.


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, veja nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🚨 Campos Obsoletos


        Este recurso pode retornar campos obsoletos. Na documentação de
        resposta, você pode ver que um campo foi marcado como **obsoleto**. Isso
        significa que este campo não é mais mantido pela equipe da Belvo. Você
        ainda pode receber dados para este campo dependendo da instituição, no
        entanto, não deve confiar neste 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: Um array de objetos 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 o saldo atual de um link
      description: >-
        Recupere o saldo atual de todas as contas correntes e de poupança para
        um link existente. Recomendamos também enviar o `account.id` para que
        você receba os saldos de uma conta 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 - Saldo Recuperado (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BalanceOFDA'
        '201':
          description: OK - Saldo Recuperado (quando `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: Obter os detalhes de um saldo
      description: Obtenha os detalhes de um saldo específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `balance.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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 transações
      description: >-
        ## ▶️ Uso


        Com o método List Transactions, você pode:


        1. **[Obrigatório]** Listar transações relacionadas a um `link.id`
        específico (usando o parâmetro de consulta `link`).

        2. Filtrar as transações retornadas usando parâmetros de consulta (veja
        a seção Filtrando respostas abaixo).

        3. Obter os detalhes de um `transaction.id` específico (usando o
        parâmetro de consulta `id` junto com o parâmetro de consulta `link`).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                title: Transações (OFDA Brasil)
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de transação (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 transações para um link
      description: >-
        Recupere transações de uma ou mais contas a partir de um link
        específico.


        > 📘 Períodos de Transação e Recuperação

        >

        > Ao recuperar transações, é importante entender que os intervalos de
        dados de transações disponíveis dependem de cada instituição. Se você
        tentar acessar informações mais antigas do que podemos acessar,
        retornaremos todos os dados que conseguimos ler dentro desse intervalo
        de datas. Por exemplo, se você solicitar transações do último ano e só
        pudermos acessar os últimos seis meses, retornaremos as informações
        correspondentes a esses seis meses de dados.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Corpo da solicitação para o método Retrieve Transactions.
              required:
                - link
                - date_from
                - date_to
              properties:
                link:
                  $ref: '#/components/schemas/link_request'
                account:
                  type: string
                  format: uuid
                  description: Se fornecido, retornamos transações apenas desta conta.
                  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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionOpenFinanceBrazil'
        '201':
          description: Criado (quando `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: Concluir uma solicitação de transações
      description: >-
        Usado para retomar uma sessão de recuperação de Transação que foi
        pausada porque um token MFA foi exigido pela instituição.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionOpenFinanceBrazil'
        '201':
          description: Criado (quando `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: Obter os detalhes de uma transação
      description: Obtenha os detalhes de uma transação específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `transaction.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma transação
      description: >-
        Excluir uma transação específica da sua conta Belvo.


        > ❗️ Limite de taxa

        >

        > Este endpoint possui limite de taxa. Você pode excluir apenas 5 itens
        por minuto. Se exceder esse limite, você receberá um código de status
        `429`.
      parameters:
        - name: id
          in: path
          required: true
          description: O `transaction.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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 contas
      description: >-
        ## ▶️ Uso


        Com o método List Bills, você pode:


        1. **[Obrigatório]** Listar contas relacionadas a um link.id específico
        (usando o parâmetro de consulta `link`).

        2. Filtrar as contas retornadas usando parâmetros de consulta (veja a
        seção Filtrando respostas abaixo).

        3. Obter os detalhes de uma conta específica usando o parâmetro de
        consulta `id`.


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                title: Contas
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Um 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 faturas para um link
      description: >-
        Recupere faturas de uma ou mais contas para um link específico dentro de
        um intervalo de datas 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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Bill'
        '201':
          description: Criado (quando `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: Obter os detalhes de uma fatura
      description: Obtenha os detalhes de uma conta específica.
      parameters:
        - name: id
          in: path
          required: true
          description: O `bill.id` sobre o qual você deseja obter informações detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma fatura
      description: Excluir uma fatura específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `bill.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar proprietários
      description: >-
        ## ▶️ Uso


        Com o método List Owners, você pode:


        1. Listar proprietários relacionados a um `link.id` específico (usando o
        parâmetro de consulta `link`).

        2. Obter os detalhes de um `owners.id` específico (usando o parâmetro de
        consulta `id`).

        3. **[Não Recomendado]** Listar todos os proprietários relacionados à
        sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar nas respostas paginadas da Belvo,
        consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a>.


        ## 🚨 Campos Obsoletos


        Este recurso pode retornar campos obsoletos. Na documentação de
        resposta, você pode ver que um campo foi marcado como **obsoleto**. Isso
        significa que este campo não é mais mantido pela equipe da Belvo. Você
        ainda pode receber dados para este campo dependendo da instituição, no
        entanto, não deve confiar neste 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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: |-
                          Uma matriz de:

                            - objetos Owner Individual (OFDA Brazil)
                            - objetos Owner Business (OFDA Brazil)
                            - objetos Owner Standard (Multi-Region)
                            
                            > 🚧 Um tipo de esquema por resposta
                            >
                            > A resposta conterá uma matriz de **um** dos tipos de esquema descritos acima. Em outras palavras, **não haverá** uma mistura de tipos de esquema na resposta.
                        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 proprietários de um link
      description: |-
        Recupere informações do proprietário a partir de um link específico.

        {% admonition type="info" %}
          Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
        {% /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 (quando `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: Criado (quando `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: Concluir uma solicitação do proprietário
      description: >-
        Usado para retomar uma sessão de recuperação de Proprietário que foi
        pausada porque um token MFA foi exigido pela instituição.


        {% admonition type="info" %}
          Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
        {% /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 (quando `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: Criado (quando `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: Obter os detalhes de um proprietário
      description: |-
        Obtenha os detalhes de um proprietário específico.

        {% admonition type="info" %}
          Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          description: O `owner.id` sobre o qual você deseja obter informações detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir um proprietário
      description: Excluir um proprietário específico da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `owner.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar investimentos
      description: >-
        ## ▶️ Uso


        Com o método Listar Investimentos, você pode:


        1. **[Obrigatório]** Listar investimentos relacionados a um `link.id`
        específico (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `investment.id` específico (usando o
        parâmetro de consulta `id`).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de investimento.
                        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 investimentos para um link
      description: Recuperar investimentos para um link 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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvestmentBrazil'
        '201':
          description: Criado (quando `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: Obter os detalhes de um investimento
      description: Obtenha os detalhes de um investimento específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `investment.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir um investimento
      description: Excluir um investimento específico da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `investment.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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 transações de investimento
      description: >-
        ## ▶️ Uso


        Com o método Listar Transações de Investimento, você pode:


        1. **[Obrigatório]** Listar transações de investimento relacionadas a um
        `link.id` específico (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `investment-transaction.id` específico
        (usando o parâmetro de consulta `id`).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de transações de investimento.
                        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 investimentos para um link
      description: Recuperar investimentos para um link existente.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                O corpo da solicitação para transações de investimento no
                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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvestmentTransactionBrazil'
        '201':
          description: Criado (quando `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: Obter os detalhes de uma transação de investimento
      description: Obtenha os detalhes de uma transação de investimento específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `investment-transaction.id` sobre o qual você deseja obter
            informações detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma transação de investimento
      description: Excluir uma transação de investimento específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `investment-transaction.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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 emprego
      description: >-
        ## ▶️ Uso


        Com o método Listar Registros de Emprego, você pode:


        1. Listar registros de emprego relacionados a um `link.id` específico
        (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `employment-record.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todos os registros de emprego
        relacionados à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de registro de emprego.
                        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 detalhes do registro de emprego
      description: Recuperar detalhes do registro de emprego de um indivíduo.
      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
          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: Criado (quando `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: Obter os detalhes de um registro de emprego
      description: Obtenha os detalhes de um registro de emprego específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `employment-record.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir um registro de emprego
      description: >-
        Exclua um registro de emprego específico da sua conta Belvo.


        > ❗️ Limite de taxa

        >

        > Este endpoint tem limite de taxa. Você pode excluir apenas 5 itens por
        minuto. Se exceder esse limite, receberá um código de status `429`.
      parameters:
        - name: id
          in: path
          required: true
          description: O `employment-record.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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/employments/:
    get:
      tags:
        - Employments Brazil
      operationId: ListEmploymentsBrazil
      summary: Listar empregos
      description: >-
        ## ▶️ Uso


        Com o método List Employments, você pode:


        1. **[Obrigatório]** Listar empregos relacionados a um `link.id`
        específico (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `employment.id` específico (usando o
        parâmetro de consulta `id`).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas do
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de emprego.
                        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 empregos para um link
      description: Recuperar empregos de um link existente.
      parameters:
        - $ref: '#/components/parameters/async'
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Corpo da solicitação para recuperar informações de emprego do
                INSS do 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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmploymentBrazil'
        '201':
          description: Criado (quando `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: Obter os detalhes de um emprego
      description: Obtenha os detalhes de um emprego específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `employment.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir um emprego
      description: Excluir um emprego específico da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `employment.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar rendimentos
      description: >-
        ## ▶️ Uso


        Com o método List Incomes, você pode:


        1. Listar rendas relacionadas a um `link.id` específico (usando o
        parâmetro de consulta `link`).

        2. Obter os detalhes de uma `income.id` específica (usando o parâmetro
        de consulta `id`).

        3. **[Não Recomendado]** Listar todas as rendas relacionadas à sua conta
        Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar nas respostas paginadas da Belvo,
        consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de income.
                        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 rendimentos para um link
      description: >-
        Recupere insights de renda para <b>contas correntes e poupança</b> a
        partir de um link específico. Você pode receber insights para um período
        de até 365 dias, dependendo do histórico de transações disponível para
        cada instituição.
      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: >-
                    As categorias das receitas para as quais você deseja obter
                    informações.
                  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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Income'
        '201':
          description: Criado (quando `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: Concluir uma solicitação de rendimentos
      description: >-
        Usado para retomar uma sessão de recuperação de Renda que foi pausada
        porque um token MFA foi exigido pela instituição.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Income'
        '201':
          description: Criado (quando `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: Obter detalhes de uma renda
      description: Obtenha os detalhes de uma renda específica.
      parameters:
        - name: id
          in: path
          required: true
          description: O `income.id` sobre o qual você deseja obter informações detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma receita
      description: Exclua uma renda específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: o `income.id` que você deseja excluir
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar despesas recorrentes
      description: >-
        ## ▶️ Uso


        Com o método Listar Despesas Recorrentes, você pode:


        1. Listar despesas recorrentes relacionadas a um `link.id` específico
        (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `recurring-expense.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todas as despesas recorrentes
        relacionadas à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de despesas recorrentes.
                        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 despesas recorrentes para um link
      description: >-
        Recupere insights de despesas recorrentes para <b>contas correntes e de
        poupança</b> a partir de um link específico. Você pode receber insights
        para um período de até 365 dias, dependendo do histórico de transações
        disponível para cada instituição.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Corpo da solicitação para o 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 (quando save_data=false)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecurringExpenses'
        '201':
          description: Criado (quando 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: Concluir uma solicitação de despesas recorrentes
      description: >-
        Usado para retomar uma sessão de recuperação de Despesas Recorrentes que
        foi pausada porque um token MFA foi exigido pela instituição.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (quando save_data=false)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RecurringExpenses'
        '201':
          description: Criado (quando 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: Obter os detalhes de uma despesa recorrente
      description: Obtenha os detalhes de uma despesa recorrente específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `recurring-expenses.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma despesa recorrente
      description: Excluir uma despesa recorrente específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `recurring-expenses.id` que você deseja excluir
          schema:
            type: string
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar insights de risco
      description: >-
        ## ▶️ Uso


        Com o método List Risk Insights, você pode:


        1. Listar insights de risco relacionados a um `link.id` específico
        (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `risk-insight.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todos os insights de risco relacionados
        à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de insights de risco.
                        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 insights de risco para um link
      description: >-
        Solicite as informações de risco para um determinado ID de link.


        Se você precisar saber a moeda da conta, basta fazer um GET Details no
        endpoint de contas (usando o ID que você recebe da resposta das contas).
      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 (quando save_data=false)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskInsights'
        '201':
          description: Criado (quando 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: Concluir uma solicitação de insights de risco
      description: >-
        Usado para retomar uma sessão de recuperação de insights de risco que
        foi pausada porque um token MFA foi exigido pela instituição.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBody'
      responses:
        '200':
          description: Ok (quando save_data=false)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RiskInsights'
        '201':
          description: Criado (quando 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: Obter detalhes de uma análise de risco
      description: Obtenha os detalhes de uma percepção de risco específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `risk-insights.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma análise de risco
      description: Excluir uma análise de risco específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `risk-insights.id` que você deseja excluir
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar métricas de emprego
      description: >-
        ## ▶️ Uso


        Com o método Listar Métricas de Emprego, você pode:


        1. Listar métricas de emprego relacionadas a um `link.id` específico
        (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `employment-metric.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todas as métricas de emprego
        relacionadas à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de métricas de emprego.
                        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 emprego
      description: >-
        Recuperar métricas de emprego para um indivíduo.


        > **Nota:** Antes de solicitar métricas de emprego, certifique-se de
        primeiro fazer uma solicitação <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: >-
                    A data até a qual você deseja que as métricas de emprego
                    sejam calculadas, no formato `YYYY-MM-DD`. Por exemplo, se
                    você não quiser calcular as métricas de emprego para todo o
                    ano de 2023, adicione `2022-12-31` como o `reference_date`.


                    Se você não fornecer um `reference_date`, realizaremos os
                    cálculos até a data em que você fizer a solicitação.


                    **Nota:** Todos os cálculos serão relativos a esta data.
                  example: '2023-03-01'
                save_data:
                  $ref: '#/components/schemas/save_data'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmploymentMetric'
        '201':
          description: Criado (quando `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: Obter detalhes de uma métrica de emprego
      description: Obtenha os detalhes de uma métrica de emprego específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `employment-metric.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma métrica de emprego
      description: Excluir uma métrica de emprego específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `employment-metric.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar Demonstrações Financeiras
      description: >-
        ## ▶️ Uso


        Com o método Listar Demonstrações Financeiras, você pode:


        1. Listar demonstrações financeiras relacionadas a um `link.id`
        específico (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `financial-statement.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todas as demonstrações financeiras
        relacionadas à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de status de conformidade 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 Demonstrações Financeiras para um link
      description: >-
        Recupere as informações das Demonstrações Financeiras para um link
        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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FinancialStatement'
        '201':
          description: Criado (quando `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: Obter detalhes de uma Demonstração Financeira
      description: Obtenha os detalhes de um Demonstrativo Financeiro específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `financial-statement.id` sobre o qual você deseja obter
            informações detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma Demonstração Financeira
      description: Excluir um Demonstrativo Financeiro específico da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `financial-statement.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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


        Com o método Listar Faturas, você pode:


        1. Listar faturas relacionadas a um `link.id` específico (usando o
        parâmetro de consulta `link`).

        2. Obter os detalhes de um `invoice.id` específico (usando o parâmetro
        de consulta `id`).

        3. **[Não Recomendado]** Listar todas as faturas relacionadas à sua
        conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a>.


        ## 🚨 Campos Obsoletos


        Este recurso pode retornar campos obsoletos. Na documentação de
        resposta, você pode ver que um campo foi marcado como **obsoleto**. Isso
        significa que este campo não é mais mantido pela equipe da Belvo. Você
        ainda pode receber dados para este campo dependendo da instituição, no
        entanto, não deve confiar neste campo.
      summary: Listar faturas
      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: Ok
          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 faturas para um link
      description: >-
        Recupere informações de faturas a partir de um link fiscal específico.


        > 📘 Informação

        >

        > Você pode solicitar até **um** ano (365 dias) de faturas por
        solicitação. Se precisar de faturas por mais de um ano, basta fazer
        outra solicitação.


        > 🚧 Aviso

        >

        > Este recurso pode retornar campos obsoletos. Por favor, verifique a
        documentação da resposta para mais informações.
      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 (quando `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: Criado (quando `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: Concluir uma solicitação de faturas
      description: >-
        Usado para retomar uma sessão de recuperação de Fatura que foi pausada
        porque um token MFA foi exigido pela instituição.


        {% admonition type="info" %}
          Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
        {% /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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvoiceWithIdSat'
        '201':
          description: Criado (quando `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: Obter os detalhes de uma fatura
      description: |-
        Obtenha os detalhes de uma fatura específica.

        {% admonition type="info" %}
          Este recurso pode retornar campos obsoletos. Por favor, verifique a documentação da resposta para mais informações.
        {% /admonition %}
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `invoice.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma fatura
      description: Excluir uma fatura específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `invoice.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar status de conformidade fiscal
      description: >-
        ## ▶️ Uso


        Com o método Listar Status de Conformidade Fiscal, você pode:


        1. Listar status de conformidade fiscal relacionados a um `link.id`
        específico (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `tax-compliance-status.id` específico (usando
        o parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todos os status de conformidade fiscal
        relacionados à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de status de conformidade 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 status de conformidade fiscal para um link
      description: >-
        Recupere as informações de status de conformidade fiscal para um link
        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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxComplianceStatus'
        '201':
          description: Criado (quando `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: Obter os detalhes do status de conformidade fiscal
      description: Obtenha os detalhes de um status específico de conformidade fiscal.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `tax-compliance-status.id` sobre o qual você deseja obter
            informações detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir um status de conformidade fiscal
      description: Excluir um status de conformidade fiscal específico da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `tax-compliance-status.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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 declarações de imposto de renda
      description: >-
        ## ▶️ Uso


        Com o método List Tax Returns, você pode:


        1. Listar declarações de imposto relacionadas a um `link.id` específico
        (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `tax-return.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todas as declarações de imposto
        relacionadas à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a>.


        ## 🔔 Múltiplos Esquemas


        Como um link pode ter declarações de imposto anuais e mensais, a
        resposta incluirá uma mistura desses dois tipos de declarações de
        imposto (e, portanto, 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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: |-
                          Um array de:

                            - objetos Tax Return Personal (Yearly)
                            - objetos Tax Return Personal (Monthly)
                            - objetos Tax Return Business (Yearly)
                            - objetos Tax Return Business (Monthly)
                            
                            > 🚧 Múltiplos Schemas
                            >
                            > Como um link pode ter declarações de imposto tanto anuais quanto mensais, a resposta incluirá uma mistura desses dois tipos de declarações de imposto (e, portanto, diferentes schemas).
                        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 declarações de imposto para um link
      description: >-
        Recuperar informações da declaração de imposto para um link 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 (quando `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: Criado (quando `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: Obter os detalhes de uma declaração de imposto de renda
      description: Obtenha os detalhes de uma declaração de imposto específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `tax-return.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma declaração de imposto
      description: Excluir uma declaração de imposto específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O ID da declaração de imposto que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar retenções de impostos
      description: >-
        ## ▶️ Uso


        Com o método List Tax Retentions, você pode:


        1. Listar retenções de impostos relacionadas a um `link.id` específico
        (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `tax-retention.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todas as retenções de impostos
        relacionadas à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de retenções de impostos.
                        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 retenções de impostos para um link
      description: >-
        Recupere informações de retenção de impostos de um link específico. O
        número máximo de retenções de impostos que pode ser retornado para um
        período é 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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TaxRetentions'
        '201':
          description: Criado (quando `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: Obter os detalhes de uma retenção de imposto
      description: Obtenha os detalhes de uma retenção de imposto específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `tax-retention.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma retenção de imposto
      description: Exclua uma retenção de imposto específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `tax-retention.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar status fiscais
      description: >-
        ## ▶️ Uso


        Com o método Listar Status de Impostos, você pode:


        1. Listar status de impostos relacionados a um `link.id` específico
        (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `tax-status.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todos os status de impostos relacionados
        à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de status de imposto.
                        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 status de impostos para um link
      description: >-
        Recuperar informações sobre o status fiscal para um link fiscal
        específico.
      parameters:
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Corpo da solicitação para o 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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxStatusSat'
              examples:
                TaxStatusPersonal:
                  $ref: '#/components/examples/TaxStatusPersonalList'
                TaxStatusBusiness:
                  $ref: '#/components/examples/TaxStatusBusinessList'
        '201':
          description: Criado (quando `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: Obter os detalhes de um status fiscal
      description: Obtenha os detalhes de um status fiscal específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `tax-status.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir um status de imposto
      description: Excluir um status fiscal específico da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: o `tax-status.id` que você deseja excluir
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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


        Com o método Listar Faturas, você pode:


        1. Listar faturas relacionadas a um `link.id` específico (usando o
        parâmetro de consulta `link`).

        2. Obter os detalhes de um `invoice.id` específico (usando o parâmetro
        de consulta `id`).

        3. **[Não Recomendado]** Listar todas as faturas relacionadas à sua
        conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a>.
      summary: Listar faturas
      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: Ok
          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 faturas para um link
      description: >-
        Recuperar informações de faturas de um link fiscal específico do Chile.

        Você pode solicitar até <b>um</b> ano (365 dias) de faturas por
        solicitação. Se precisar de faturas por mais de um ano, basta fazer
        outra solicitação.

        > 📘 Altamente Recomendado > > Recomendamos fortemente que você use o
        parâmetro de cabeçalho `X-Belvo-Request-Mode` da Belvo e implemente um
        fluxo de trabalho assíncrono. Isso garantirá que você não receba erros
        de timeout ao recuperar dados de faturas.
      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 (quando `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: Criado (quando `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: Obter os detalhes de uma fatura
      description: Obtenha os detalhes de uma fatura específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `invoice.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir uma fatura
      description: Excluir uma fatura específica da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: O `invoice.id` que você deseja excluir.
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Listar status fiscais
      description: >-
        ## ▶️ Uso


        Com o método Tax Status, você pode:


        1. Listar status fiscais relacionados a um `link.id` específico (usando
        o parâmetro de consulta `link`).

        2. Obter os detalhes de um `tax-status.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todos os status fiscais relacionados à
        sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de status de imposto.
                        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 status de impostos para um link
      description: >-
        Recuperar informações sobre o status fiscal para um link 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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/tax_status_sii'
        '201':
          description: Criado (quando `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: Obter os detalhes de um status fiscal
      description: Obtenha os detalhes de um status fiscal específico.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `tax-status.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir um status de imposto
      description: Excluir um status fiscal específico da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: o `tax-status.id` que você deseja excluir
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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 relatórios de dívidas
      description: >-
        ## ▶️ Uso


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


        1. Listar relatórios de dívida relacionados a um `link.id` específico
        (usando o parâmetro de consulta `link`).

        2. Obter os detalhes de um `debt-report.id` específico (usando o
        parâmetro de consulta `id`).

        3. **[Não Recomendado]** Listar todos os relatórios de dívida
        relacionados à sua conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados até um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</a>.


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</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: Ok
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de relatório de dívida.
                        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 detalhes da dívida para um link
      description: >-
        Recuperar informações de relatórios de dívida para um link 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 (quando `save_data=false`)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/debt_chile'
        '201':
          description: Criado (quando `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: Obter os detalhes de uma dívida
      description: Obtenha os detalhes de uma dívida específica.
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            O `debt-report.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/omit'
        - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Ok
          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: Excluir um relatório de dívida
      description: Excluir um relatório de dívida específico da sua conta Belvo.
      parameters:
        - name: id
          in: path
          required: true
          description: o `debt-report.id` que você deseja excluir
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Sem conteúdo
        '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: Liste todas as instituições de pagamento
      description: Liste todas as instituições de pagamento disponíveis.
      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: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de instituição.
                        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: Criar um novo cliente
      description: Crie um novo cliente para enviar ou solicitar fundos.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerOfpi'
      responses:
        '201':
          description: OK (Criado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerOfpi'
              examples:
                OfpiPixIndividual:
                  $ref: '#/components/examples/ResponseCustomerOfpiIndividual'
                OfpiPixBusiness:
                  $ref: '#/components/examples/ResponseCustomerOfpiBusiness'
        '400':
          description: Erro de Validação
          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 os clientes
      description: Liste todos os clientes associados à sua conta 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: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de clientes.
                        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: Obter detalhes sobre um cliente
      description: Obter os detalhes sobre um cliente específico
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            O `customer.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          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 uma nova conta bancária
      description: >-
        Registre uma nova conta bancária da qual você pode enviar ou solicitar
        fundos.
      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 (Criado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccountOfpiResponse'
              examples:
                OfpiPixInfo:
                  $ref: '#/components/examples/ResponseBankAccountBusinessPixInfo'
                OfpiIndividualPixInfo:
                  $ref: '#/components/examples/ResponseBankAccountIndividualPixInfo'
        '400':
          description: Erro de Validação
          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: Listar todas as contas bancárias
      description: Liste todas as contas bancárias associadas à sua conta 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: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de conta bancária.
                        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: Obter detalhes sobre uma conta bancária
      description: Obtenha os detalhes sobre uma conta bancária específica.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            O `bank-account.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          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: Criar um link de pagamento
      description: >-
        Crie um novo link de pagamento para iniciar um pagamento com widget
        hospedado.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentLinkOfpi'
      responses:
        '201':
          description: OK (Criado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkOfpi'
        '400':
          description: Erro de Validação
          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: Listar todos os links de pagamento
      description: >-
        Liste todos os links de pagamento associados à sua conta Belvo. Por
        padrão, retornamos até 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: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de conta bancária.
                        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: Obter detalhes sobre um link de pagamento
      description: Obtenha os detalhes sobre um link de pagamento.
      parameters:
        - name: access_token
          required: true
          in: path
          description: >-
            O `access_token` do link de pagamento sobre o qual você deseja obter
            informações detalhadas.


            **Nota:** Você pode recuperar o `access_token` de um link de
            pagamento fazendo uma solicitação <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 (Criado)
          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: Criar uma nova intenção de pagamento
      description: >-
        Crie uma intenção de pagamento.


        **Nota**: Você pode usar este método para criar adicionalmente um
        cliente e uma intenção de pagamento em uma única solicitação (consulte a
        opção Cliente e Intenção de Pagamento).
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CreatePaymentIntentOfpi'
                - $ref: '#/components/schemas/CreatePaymentIntentAndCustomerOfpi'
      responses:
        '201':
          description: OK (Criado). Clique para ver os detalhes da resposta.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/PaymentIntentOfpi'
        '400':
          description: Erro de Validação
          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: Listar todas as payment intents
      description: Liste todas as intenções de pagamento associadas à sua conta 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: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de payment intent.
                        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: Concluir uma intenção de pagamento
      description: Concluir uma nova intenção de pagamento.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            O `payment-intent.id` sobre o qual você deseja obter informações
            detalhadas.
          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 (Criado)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentIntentOfpi'
        '400':
          description: Erro de Validação
          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: Obter detalhes sobre uma intenção de pagamento
      description: Obtenha os detalhes sobre uma intenção de pagamento específica.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            O `payment-intent.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          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 uma intenção de pagamento agendada
      description: >-
        Cancelar uma intenção de pagamento agendada (única).


        Respondemos com um `204 - No Content` e informaremos você via webhook
        que a intenção de pagamento foi cancelada com sucesso.


        > **Nota**: O prazo máximo para cancelar uma intenção de pagamento
        agendada é até **23:59:00 (GMT-3)** do dia **anterior** à data de
        pagamento agendada.
      parameters:
        - name: id
          required: true
          in: path
          description: O `payment-intent.id` agendado que você deseja cancelar.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '204':
          description: Sem conteúdo
        '400':
          description: Erro de Validação
          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: Liste todas as cobranças para uma intenção de pagamento
      description: Liste todas as cobranças associadas a uma intenção de pagamento.
      parameters:
        - name: payment_intent_id
          required: true
          in: path
          description: O `payment-intent.id` ao qual as cobranças pertencem.
          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: Retorne resultados apenas para este valor.
          schema:
            type: string
            example: SUCCEEDED
        - name: status__in
          in: query
          description: Retornar resultados para o status listado.
          schema:
            type: string
            example: PENDING,SUCCEEDED
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array 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: Obter detalhes sobre uma cobrança para uma intenção de pagamento
      description: >-
        Obtenha os detalhes sobre uma cobrança específica associada a uma
        intenção de pagamento.
      parameters:
        - name: payment_intent_id
          required: true
          in: path
          description: O `payment-intent.id` ao qual a cobrança pertence.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: O `charge.id` sobre o qual você deseja obter detalhes.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          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 uma cobrança agendada
      description: >-
        Cancelar uma cobrança agendada.


        Respondemos com um `204 - No Content` e informaremos você via webhook
        que a cobrança foi cancelada com sucesso.


        > **Nota**: O prazo máximo para cancelar uma cobrança agendada é até
        **23:59:00 (GMT-3)** do dia **anterior** à data de pagamento agendada.
      parameters:
        - name: payment_intent_id
          required: true
          in: path
          description: O `payment-intent.id` agendado ao qual a cobrança pertence.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: O `charge.id` agendado que você deseja cancelar.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '204':
          description: Sem conteúdo
        '400':
          description: Erro de Validação
          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: Criar uma nova Autorização de Pagamento
      description: |-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
        {% /admonition %}

        Crie uma Autorização de Pagamento.
      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 - Autorização de Pagamento criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAuthorization'
        '400':
          description: Erro de Validação
          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: Listar todas as Autorizações de Pagamento
      description: |-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante Belvo.
        {% /admonition %}

        Liste todas as Autorizações de Pagamento associadas à sua conta 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: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de autorização de pagamento.
                        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: Obter detalhes sobre uma Autorização de Pagamento
      description: |-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante Belvo.
        {% /admonition %}

        Obtenha os detalhes sobre uma Autorização de Pagamento específica.
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: >-
            O `payment-authorization.id` sobre o qual você deseja obter
            informações detalhadas.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          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 uma Autorização de Pagamento
      description: >-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
        {% /admonition %}


        Cancelar uma Autorização de Pagamento


        Respondemos com um `204 - No Content` e informaremos você via webhook
        que a Autorização de Pagamento foi cancelada com sucesso.


        {% admonition type="warning" name="Restrições de Horário para
        Cancelamento" %}

        O horário limite para cancelar uma Autorização de Pagamento é até as
        22:00:00 (GMT-3) do dia anterior à próxima data de Cobrança. Se você
        perder o prazo, a Autorização de Pagamento será cancelada, **mas a
        Cobrança ainda será processada**.

        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: O `payment-authorization.id` agendado que você deseja cancelar.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '204':
          description: Sem conteúdo
        '400':
          description: Erro de Validação
          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: Criar uma nova Charge
      description: |-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante Belvo.
        {% /admonition %}

        Crie uma nova Cobrança para uma Autorização de Pagamento.
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: O `payment-authorization.id` ao qual o Charge pertence.
          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 - Cobrança Criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargeV2'
        '400':
          description: Erro de Validação
          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: Listar todas as Cobranças para uma Autorização de Pagamento
      description: |-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
        {% /admonition %}

        Liste todas as Cobranças associadas a uma Autorização de Pagamento.
      parameters:
        - name: payment_authorization_id
          required: true
          in: path
          description: O `payment-authorization.id` ao qual as cobranças pertencem.
          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: Retorne resultados apenas para este valor.
          schema:
            type: string
            example: SUCCEEDED
        - name: status__in
          in: query
          description: Retornar resultados para o status listado.
          schema:
            type: string
            example: PENDING,SUCCEEDED
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array 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: Obter detalhes sobre uma Cobrança para uma Autorização de Pagamento
      description: >-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
        {% /admonition %}


        Obtenha os detalhes sobre uma Charge específica associada a uma Payment
        Authorization.
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: O `payment-authorization.id` ao qual o Charge pertence.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: O `charge.id` sobre o qual você deseja obter detalhes.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          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: Tentar novamente uma Cobrança falhada para uma Autorização de Pagamento
      description: >-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
        {% /admonition %}


        Tente novamente uma Cobrança falhada para uma determinada Autorização de
        Pagamento.


        {% admonition type="warning" name="Documentação adicional" %}
          Certifique-se de ler a documentação dedicada a Retentativas de Cobranças e Cobranças Vinculadas antes de tentar repetir uma cobrança.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: O `payment-authorization.id` ao qual o Charge pertence.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: O `charge.id` sobre o qual você deseja obter detalhes.
          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: >-
                    A data em que você deseja tentar novamente a Cobrança, no
                    formato `YYYY-MM-DD`. Deve ser pelo menos um dia no futuro.
                  example: '2025-06-30'
      responses:
        '201':
          description: OK
          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 uma Cobrança agendada
      description: >-
        {% admonition type="warning" name="Em BETA" %}
          Este endpoint está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante Belvo.
        {% /admonition %}


        Cancele uma Cobrança agendada.


        Respondemos com um `204 - No Content` e informaremos você via webhook
        que a cobrança foi cancelada com sucesso.


        {% admonition type="warning" name="Restrição de Tempo para Cancelamento"
        %}
          O horário limite para cancelar uma Cobrança agendada é até as 22:00:00 (GMT-3) do dia anterior à data da Cobrança. Se você perder o prazo, receberá um erro da API da Belvo e o pagamento será processado.
        {% /admonition %}
      parameters:
        - $ref: '#/components/parameters/header_version'
        - name: payment_authorization_id
          required: true
          in: path
          description: O `payment-authorization.id` agendado ao qual o Charge pertence.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
        - name: charge_id
          required: true
          in: path
          description: O `charge.id` agendado que você deseja cancelar.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '204':
          description: Sem conteúdo
        '400':
          description: Erro de Validação
          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: Listar todas as transações de pagamento
      description: Liste todas as transações de pagamento associadas à sua conta 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: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array de objetos de transação.
                        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: Obter detalhes sobre uma transação de pagamento
      description: Obtenha os detalhes sobre uma transação de pagamento específica.
      parameters:
        - name: id
          required: true
          in: path
          description: >-
            O `transaction.id` sobre o qual você deseja obter informações
            detalhadas.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          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 matrículas
      description: >-
        ## ▶️ Uso


        Com o método List Enrollments, você pode:


        1. (Recomendado) Listar inscrições relacionadas a um CPF específico
        (usando o parâmetro de consulta `customer__identifier`).

        2. Listar inscrições relacionadas a um `customer.id` e `institution.id`
        específicos (usando os parâmetros de consulta `customer` e
        `institution`).

        3. Listar inscrições de acordo com um status específico (usando o
        parâmetro de consulta `status`).

        4. **[Não Recomendado]** Listar todas as inscrições relacionadas à sua
        conta Belvo (sem usar nenhum parâmetro de consulta).


        ## 🔦 Filtrando Respostas


        Consulte a lista de consultas abaixo para ver uma lista de campos pelos
        quais você pode filtrar suas respostas. Para mais informações sobre como
        usar filtros, veja nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a>.


        ## 📖 Paginação


        Este método retorna uma resposta paginada (padrão: 100 itens por
        página). Você pode usar o parâmetro de consulta `page_size` para
        aumentar o número de itens retornados para um máximo de 1000 itens. Você
        pode usar o parâmetro de consulta `page` para navegar pelos resultados.
        Para mais detalhes sobre como navegar pelas respostas paginadas da
        Belvo, veja nosso artigo <a
        href="https://developers.belvo.com/docs/belvo-pagination-tips"
        target="_blank">Dicas de Paginação</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: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/payments_common_pagination_properties'
                  - properties:
                      results:
                        type: array
                        description: Array 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: Obter detalhes sobre uma inscrição
      description: Obtenha detalhes sobre um registro específico de dispositivo.
      parameters:
        - name: enrollment_id
          required: true
          in: path
          description: O `enrollment.id` para o qual você deseja obter detalhes.
          schema:
            type: string
            format: uuid
            example: a3b92311-1888-449f-acaa-49ae28d68fcd
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentBiometricPix'
        '400':
          description: Erro de Validação
          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: Gerar um token de acesso para o widget de pagamento
      operationId: GeneratePaymentWidgetAccessToken
      description: >-
        Gerar um token de acesso para o widget de pagamento para o processo de
        cadastro ou pagamento com Pix Biométrico.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/BiometricPaymentWidgetRequest'
      responses:
        '200':
          description: Operação bem-sucedida
          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: >-
        A Belvo utiliza **autenticação básica** usando suas chaves secretas
        (Você pode encontrar suas chaves secretas da API no seu Painel da Belvo,
        na seção **Desenvolvedores**).


        Para autenticar, você precisa usar seu `secretId` da API como `username`
        e seu `secretPassword` da API como `password`. Essas credenciais
        precisam ser codificadas em **Base64** e incluídas no cabeçalho
        `Authorization` das suas requisições HTTP. Por exemplo:


        ```shell

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


        Substitua `YOUR_SECRET_ID` e `YOUR_SECRET_PASSWORD` pelas suas
        credenciais reais. **Nunca exponha suas credenciais em código do lado do
        cliente ou em repositórios públicos**.
  parameters:
    page_size:
      name: page_size
      in: query
      description: >-
        Indica quantos resultados retornar por página. Por padrão, retornamos
        100 resultados por página.


        ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é
        1000. Se você inserir um valor maior que 1000, nossa API usará o valor
        máximo por padrão (1000).
      schema:
        type: integer
        format: int32
        default: 100
        minimum: 1
        maximum: 1000
        example: 100
    page:
      name: page
      in: query
      description: Um número de página dentro do conjunto de resultados paginados.
      schema:
        type: integer
        format: int32
        minimum: 1
        example: 1
    display_name:
      name: display_name
      in: query
      description: >-
        Retornar instituições que correspondam parcialmente a este nome de
        exibição.
      schema:
        type: string
        maxLength: 30
        example: Erebor Bank
    country_code:
      name: country_code
      in: query
      description: Retorne apenas instituições para este código de país de duas letras.
      schema:
        type: string
        pattern: ^[A-Z]{2}$
        example: MX
    country_code__in:
      name: country_code__in
      in: query
      description: Retorne instituições apenas para estes códigos de país de duas 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: Retorne instituições que apoiam esses recursos de combinação.
      style: form
      explode: false
      schema:
        type: array
        minimum: 2
        items:
          type: string
          example: OWNERS
    name:
      name: name
      in: query
      description: Retorne uma instituição com este nome designado pela 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: Retorne instituições com um ou mais desses nomes designados pela 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: >-
        Retorne instituições com o status fornecido. Você pode escolher entre
        `healthy` ou `down`.
      schema:
        type: string
        example: healthy
    status__in_institutions:
      name: status__in
      in: query
      description: >-
        Retorne instituições com um dos status fornecidos. Você pode escolher
        entre `healthy` ou `down`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: healthy
    type_institutions:
      name: type
      in: query
      description: >-
        Retorne instituições deste tipo. Você pode escolher entre `bank`,
        `fiscal` ou `employment`.
      schema:
        type: string
        enum:
          - bank
          - fiscal
          - employment
        example: fiscal
    type__in_institutions:
      name: type__in
      in: query
      description: >-
        Retorne instituições de um destes tipos. Você pode escolher entre
        `bank`, `fiscal` ou `employment`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - bank
            - fiscal
            - employment
          example: fiscal
    website:
      name: website
      in: query
      description: Retornar instituições com este URL de site.
      schema:
        type: string
        example: https://www.erebor.mx
    omit:
      name: omit
      in: query
      description: >-
        Omitir certos campos de serem retornados na resposta. Para mais
        informações, consulte nosso artigo <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a> no DevPortal.
      schema:
        type: string
    fields:
      name: fields
      in: query
      description: >-
        Retorne apenas os campos especificados na resposta. Para mais
        informações, consulte nosso artigo no DevPortal <a
        href="https://developers.belvo.com/docs/searching-and-filtering"
        target="_blank">Filtrando respostas</a>.
      schema:
        type: string
    id:
      name: id
      in: query
      description: Retorne informações apenas para este recurso `id`.
      schema:
        type: string
        format: uuid
        example: 24ccab1d-3a86-4136-a6eb-e04bf52b356f
    id__in:
      name: id__in
      in: query
      description: Retorne informações para esses `id`s de recurso.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          format: uuid
          example: 6b3dea0f-be29-49d1-aabe-1a6d588642e6
    institution:
      name: institution
      in: query
      description: >-
        Retorne resultados apenas para esta instituição (use o nome designado
        pela 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: >-
        Retorne resultados apenas para estas instituições (use os nomes
        designados pela Belvo, como `ofmockbank_br_retail` e
        `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: >-
        Retorne links apenas com este modo de acesso. Pode ser `single` ou
        `recurrent`.
      example: single
      schema:
        type: string
        enum:
          - single
          - recurrent
        example: single
    created_at:
      name: created_at
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo nesta data (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    created_at__gt:
      name: created_at__gt
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo após esta data (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    created_at__gte:
      name: created_at__gte
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo após ou nesta data (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-04'
    created_at__lt:
      name: created_at__lt
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo antes desta data (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-04-01'
    created_at__lte:
      name: created_at__lte
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo antes ou na data especificada (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-30'
    created_at__range:
      name: created_at__range
      in: query
      description: >-
        Retorne contas que foram atualizadas pela última vez no banco de dados
        do Belvo entre duas datas (no 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: Retorne links que não foram criados por esses usuários da 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: Retorne links com este ID externo.
      schema:
        type: string
        minLength: 3
        maxLength: 256
        example: InternalUser4000
    external_id__in:
      name: external_id__in
      in: query
      description: Retorne links com esses 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: Retorne links com este ID de usuário específico da instituição.
      schema:
        type: string
        example: ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0=
    institution_user_id__in:
      name: institution_user_id__in
      in: query
      description: Retorne links com esses IDs de usuário da instituição.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: ezFoxjPDr7YnASnOaft5F3zt7D0kurgDNlLtZFjxUo0=
    refresh_rate:
      name: refresh_rate
      in: query
      description: >-
        Retorne links com esta taxa de atualização. Escolha entre `6h`, `12h`,
        `24h`, `7d`, `30d` ou `null` (para links ú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: >-
        Retorne links com este status. Escolha entre `valid`, `invalid`,
        `unconfirmed` ou `token_required`.
      schema:
        type: string
        example: invalid
    status__in_links:
      name: status__in
      in: query
      description: >-
        Retorne links com esses status. Escolha entre `valid`, `invalid`,
        `unconfirmed` ou `token_required`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: invalid
    pageSize_query:
      name: page_size
      in: query
      description: >-
        Indica quantos resultados retornar por página. Por padrão, retornamos
        100 resultados por página.


        ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é
        1000. Se você inserir um valor maior que 1000, nossa API usará o valor
        máximo por padrão (1000).
      schema:
        type: integer
        format: int32
        default: 100
        minimum: 1
        maximum: 1000
        example: 100
    document_number:
      name: user_document
      required: true
      in: query
      description: >-
        O número de CPF ou CNPJ do usuário para o qual você deseja obter
        informações de consentimento.
      schema:
        type: string
        minLength: 11
        maxLength: 14
        example: '12345678900'
    link:
      name: link
      in: query
      description: >-
        O `link.id` pelo qual você deseja filtrar.


        ℹ️ Recomendamos fortemente adicionar o filtro `link.id` para melhorar
        seu desempenho.
      schema:
        type: string
        format: uuid
        example: 8848bd0c-9c7e-4f53-a732-ec896b11d4c4
    link__in:
      name: link__in
      in: query
      description: Retorne resultados apenas para esses `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: >-
        Retorne contas que tenham um `balance.available` correspondendo
        exatamente a 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: Retorne contas que tenham um `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: >-
        Retorne contas que tenham um `balance.available` menor ou 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: Retorne contas que tenham um `balance.available` maior 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: >-
        Retorne contas que tenham um `balance.available` maior ou 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: >-
        Retorne contas que tenham um `balance.available` dentro de um intervalo
        de dois 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: >-
        Retorne contas que tenham um `balance.current` correspondendo exatamente
        a 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: Retorne contas que tenham um `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: >-
        Retorne contas que tenham um `balance.available` menor ou 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: Retorne contas que tenham um `balance.current` maior 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: >-
        Retorne contas que tenham um `balance.available` maior ou 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: >-
        Retorne contas que tenham um `balance.current` dentro de um intervalo de
        dois 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: >-
        Retorne contas apenas para a categoria fornecida (por exemplo,
        `CHECKING_ACCOUNT` e `SAVINGS_ACCOUNT`).
      schema:
        type: string
        example: CREDIT_ACCOUNT
    category__in:
      name: category__in
      in: query
      description: >-
        Retorne contas apenas para as categorias fornecidas (por exemplo,
        `CHECKING_ACCOUNT` e `SAVINGS_ACCOUNT`).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: SAVINGS_ACCOUNT
    currency:
      name: currency
      in: query
      description: >-
        Retorne resultados que contenham finanças ou saldos apenas neste código
        de moeda de três letras.
      schema:
        type: string
        pattern: ^[A-Z]{3}$
        example: BRA
    currency__in:
      name: currency__in
      in: query
      description: >-
        Retorne resultados que tenham fundos ou saldos em um destes códigos de
        moeda de três letras.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          pattern: ^[A-Z]{3}$
          example: BRA
    name_accounts:
      name: name
      in: query
      description: >-
        Retorne contas com exatamente este nome interno (especificado pela
        instituição).
      schema:
        type: string
        example: Cuenta Perfiles- M.N. - MXN-666
    name__icontains:
      name: name__icontains
      in: query
      description: >-
        Retornar contas que correspondam parcialmente a este nome interno
        (especificado pela instituição).
      schema:
        type: string
        minLength: 3
        example: Perfiles
    number_accounts:
      name: number
      in: query
      description: >-
        Retorne informações apenas para este número de conta (conforme
        especificado pela instituição).
      schema:
        type: string
        example: '4057068115181'
    number__in_accounts:
      name: number__in
      in: query
      description: >-
        Retornar informações para esses números de conta (conforme especificado
        pela instituição).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: '4057068115181'
    public_identification_name:
      name: public_identification_name
      in: query
      description: >-
        Retorne informações apenas para este tipo de ID de conta. Por exemplo,
        contas CLABE.
      schema:
        example: CLABE
        type: string
    public_identification_value:
      name: public_identification_value
      in: query
      description: >-
        Retorne informações apenas para este ID de conta. Por exemplo, o número
        da conta para uma conta CLABE.
      schema:
        example: '150194683119900273'
        type: string
    type_accounts:
      name: type
      in: query
      description: >-
        Retorne informações apenas para contas que correspondam a este tipo de
        conta, conforme designado pela instituição.
      schema:
        type: string
        example: Cuentas de efectivo
    link__required:
      name: link
      in: query
      required: true
      description: O `link.id` pelo qual você deseja filtrar.
      schema:
        type: string
        format: uuid
        example: 8848bd0c-9c7e-4f53-a732-ec896b11d4c4
    account:
      name: account
      in: query
      description: >-
        O `account.id` pelo qual você deseja filtrar.


        ℹ️ Recomendamos fortemente adicionar os filtros `link.id` ou
        `account.id` para melhorar seu desempenho.
      schema:
        type: string
        format: uuid
        example: 8848bd0c-9c7e-4f53-a732-ec896b11d4c4
    account__in:
      name: account__in
      in: query
      description: Retorne resultados apenas para esses `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: >-
        Retorne itens que foram recuperados da instituição nesta data
        (`YYYY-MM-DD` ou timestamp completo `ISO-8601`).
      schema:
        type: string
        format: date
        example: '2022-05-01'
    collected_at__gt:
      name: collected_at__gt
      in: query
      description: >-
        Retorne itens que foram recuperados da instituição após esta data
        (`YYYY-MM-DD` ou timestamp completo `ISO-8601`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    collected_at__gte:
      name: collected_at__gte
      in: query
      description: >-
        Retorne itens que foram recuperados da instituição após ou nesta data
        (`YYYY-MM-DD` ou timestamp completo `ISO-8601`).
      schema:
        type: string
        format: date
        example: '2022-05-04'
    collected_at__lt:
      name: collected_at__lt
      in: query
      description: >-
        Retorne itens que foram recuperados da instituição antes desta data
        (`YYYY-MM-DD` ou timestamp completo `ISO-8601`).
      schema:
        type: string
        format: date
        example: '2022-04-01'
    collected_at__lte:
      name: collected_at__lte
      in: query
      description: >-
        Retorne itens que foram recuperados da instituição antes ou nesta data
        (`YYYY-MM-DD` ou timestamp completo `ISO-8601`).
      schema:
        type: string
        format: date
        example: '2022-03-30'
    collected_at__range:
      name: collected_at__range
      in: query
      description: >-
        Retorne itens que foram recuperados da instituição entre duas datas
        (`YYYY-MM-DD` ou timestamp completo `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: >-
        Retorne transações que tenham um `account.balance.available`
        correspondendo exatamente a 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: >-
        Retorne transações que tenham um `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: >-
        Retorne transações que tenham um `account.balance.available` menor ou
        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: >-
        Retorne transações que tenham um `account.balance.available` maior do
        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: >-
        Retorne transações que tenham um `account.balance.available` maior ou
        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: >-
        Retorne transações que tenham um `account.balance.available` dentro de
        um intervalo de dois 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: >-
        Retorne transações que tenham um `account.balance.current`
        correspondendo exatamente a 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: >-
        Retorne transações que tenham um `account.balance.current` maior 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: >-
        Retorne transações que tenham um `account.balance.current` maior ou
        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: >-
        Retorne transações que tenham um `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: >-
        Retorne transações que tenham um `account.balance.current` menor ou
        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: >-
        Retorne transações que tenham um `account.balance.current` dentro de um
        intervalo de dois valores.
      style: form
      explode: false
      schema:
        type: array
        maxItems: 2
        items:
          type: number
          example: 4350
    account_type:
      name: account_type
      in: query
      description: >-
        Retorne informações apenas para transações que correspondam a este tipo
        de conta, conforme designado pela instituição.
      schema:
        type: string
        example: Cuentas de efectivo
    account_type__in:
      name: account_type__in
      in: query
      description: >-
        Retorne informações apenas para transações que correspondam a esses
        tipos de conta, conforme designado pela instituição.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: Depositos Ahorro
    accounting_date:
      name: accounting_date
      in: query
      description: >-
        Retorne transações que foram processadas pela instituição exatamente
        nesta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    accounting_date__gt:
      name: accounting_date__gt
      in: query
      description: >-
        Retorne transações que foram processadas pela instituição após esta data
        (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-06'
    accounting_date__gte:
      name: accounting_date__gte
      in: query
      description: >-
        Retorne transações que foram processadas pela instituição nesta data
        (`YYYY-MM-DD`) ou posteriormente.
      schema:
        type: string
        format: date
        example: '2022-05-04'
    accounting_date__lt:
      name: accounting_date__lt
      in: query
      description: >-
        Retorne transações que foram processadas pela instituição antes desta
        data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-02'
    accounting_date__lte:
      name: accounting_date__lte
      in: query
      description: >-
        Retorne transações que foram processadas pela instituição nesta data
        (`YYYY-MM-DD`) ou anteriormente.
      schema:
        type: string
        format: date
        example: '2022-03-01'
    accounting_date__range:
      name: accounting_date__range
      in: query
      description: >-
        Retorne transações que foram processadas pela instituição neste
        intervalo de datas (`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: Retorne resultados apenas 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: Retorne resultados apenas para valores acima deste montante.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__gte:
      name: amount__gte
      in: query
      description: Retorne resultados apenas para e acima deste valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__lt:
      name: amount__lt
      in: query
      description: Retorne resultados apenas para menos do que este valor.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__lte:
      name: amount__lte
      in: query
      description: Retorne resultados apenas para este valor ou menos.
      schema:
        type: number
        format: float
        pattern: ^\d{1,15}\.\d{2,4}$
        example: 1000.02
    amount__range:
      name: amount__range
      in: query
      description: Retornar resultados dentro deste intervalo de valores.
      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: Retorne transações para um destes nomes de conta.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          maxLength: 50
          example: feb-2022
    reference:
      name: reference
      in: query
      description: >-
        Retorna transações com este número de referência atribuído pela
        instituição.
      schema:
        type: string
        example: 85904452810319230
    reference__in:
      name: reference__in
      in: query
      description: >-
        Retorna transações com esses números de referência atribuídos pela
        instituição.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: 85904452810319230
    status_transactions:
      name: status
      in: query
      description: >-
        Retorne transações com este status. Pode ser `PENDING`, `PROCESSED` ou
        `UNCATEGORIZED`.
      schema:
        type: string
        example: PENDING
    status__in_transactions:
      name: status__in
      in: query
      description: >-
        Retorne transações com estes status. Podem ser `PENDING`, `PROCESSED` ou
        `UNCATEGORIZED`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: PROCESSED
    type_transactions:
      name: type
      in: query
      description: Retorne transações com este tipo. Pode ser `INFLOW` ou `OUTFLOW`.
      schema:
        type: string
        enum:
          - OUTFLOW
          - INFLOW
        example: OUTFLOW
    type__in_transactions:
      name: type__in
      in: query
      description: Retorne transações com esses tipos. Pode ser `INFLOW` ou `OUTFLOW`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - OUTFLOW
            - INFLOW
          example: INFLOW
    value_date:
      name: value_date
      in: query
      description: Retornar resultados exatamente para esta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    value_date__gt:
      name: value_date__gt
      in: query
      description: Retorne resultados que ocorreram após esta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-06'
    value_date__gte:
      name: value_date__gte
      in: query
      description: Retorne resultados para esta data (`YYYY-MM-DD`) ou posterior.
      schema:
        type: string
        format: date
        example: '2022-05-04'
    value_date__lt:
      name: value_date__lt
      in: query
      description: Retornar resultados para antes desta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-02'
    value_date__lte:
      name: value_date__lte
      in: query
      description: Retorne resultados para esta data (`YYYY-MM-DD`) ou anterior.
      schema:
        type: string
        format: date
        example: '2022-03-01'
    value_date__range:
      name: value_date__range
      in: query
      description: Retornar resultados para este intervalo de datas (`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 cabeçalho recomendado para tornar sua solicitação POST
        assíncrona (evitando timeouts e melhorando o fluxo de dados).


        Quando você faz uma solicitação assíncrona, a Belvo responde com um
        payload `202 - Accepted`, incluindo o `request_id`. Assim que tivermos
        recuperado as informações solicitadas, você receberá um webhook com o
        link e os IDs de solicitação.
      schema:
        type: string
        enum:
          - async
        example: async
    due_date:
      name: due_date
      in: query
      description: Retorne itens que tenham uma `due_date` nesta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-01'
    due_date__gt:
      name: due_date__gt
      in: query
      description: Retorne itens que tenham um `due_date` após esta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    due_date__gte:
      name: due_date__gte
      in: query
      description: >-
        Retorne itens que tenham uma `due_date` nesta data ou após ela
        (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    due_date__lt:
      name: due_date__lt
      in: query
      description: Retorne itens que tenham uma `due_date` antes desta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    due_date__lte:
      name: due_date__lte
      in: query
      description: >-
        Retorne itens que tenham uma `due_date` antes ou no dia desta data
        (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    due_date__range:
      name: due_date__range
      in: query
      description: Retorne itens que tenham um `due_date` entre duas datas (`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: >-
        Retorna proprietários cujo endereço de e-mail corresponde à sua
        consulta.
      schema:
        type: string
        format: email
        example: lopes.d@gmail.com
    display_name__icontains:
      name: display_name__icontains
      in: query
      description: >-
        Retorne proprietários cujo nome completo de exibição corresponda
        parcialmente à sua consulta. Por exemplo, `mar` retornará resultados
        para Mark, Maria, Neymar, Remarque, e assim por diante.
      schema:
        type: string
        minLength: 3
        example: Daniela
    type_investments:
      name: type
      in: query
      description: >-
        Retorne investimentos com este tipo. Pode ser `BANCARIA`, `CREDITO`,
        `VARIABLE`, `FUND` ou `BOND`.
      schema:
        type: string
        example: VARIABLE
    type__in_investments:
      name: type__in
      in: query
      description: >-
        Retorno de investimentos deste tipo. Pode ser `BANCARIA`, `CREDITO`,
        `VARIABLE`, `FUND` ou `BOND`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: VARIABLE
    internal_identification:
      name: internal_identification
      in: query
      description: A `internal_identification` pelo qual você deseja filtrar.
      schema:
        type: string
        example: BLPM951331IONVGR54
    internal_identification__in:
      name: internal_identification__in
      in: query
      description: Um ou mais `internal_identification`s pelos quais você deseja filtrar.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: BLPM951331IONVGR54
    start_date:
      name: start_date
      in: query
      description: Retorne os empregos que começaram nesta data, no formato `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-05'
    start_date__gt:
      name: start_date__gt
      in: query
      description: >-
        Retorne os empregos que começaram após esta data, no formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-06'
    start_date__gte:
      name: start_date__gte
      in: query
      description: >-
        Retorne os empregos que começaram nesta data ou após, no formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-04'
    start_date__lt:
      name: start_date__lt
      in: query
      description: >-
        Retorne os empregos que começaram antes desta data, no formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-03-02'
    start_date__lte:
      name: start_date__lte
      in: query
      description: >-
        Retorne os empregos que começaram nesta data ou antes, no formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-03-01'
    start_date__range:
      name: start_date__range
      in: query
      description: >-
        Retorne os empregos que começaram entre essas duas datas, no 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: Retorne os empregos que terminaram nesta data, no formato `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-05'
    end_date__gt:
      name: end_date__gt
      in: query
      description: >-
        Retorne os empregos que terminaram após esta data, no formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-06'
    end_date__gte:
      name: end_date__gte
      in: query
      description: >-
        Retorne os empregos que terminaram nesta data ou depois, no formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-05-04'
    end_date__lt:
      name: end_date__lt
      in: query
      description: >-
        Retorne os empregos que terminaram antes desta data, no formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-03-02'
    end_date__lte:
      name: end_date__lte
      in: query
      description: >-
        Retorne os empregos que terminaram nesta data ou antes, no formato
        `YYYY-MM-DD`.
      schema:
        type: string
        format: date
        example: '2022-03-01'
    end_date__range:
      name: end_date__range
      in: query
      description: >-
        Retorne os empregos que terminaram entre essas duas datas, no 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: Retornar faturas emitidas exatamente nesta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    invoice_date__lt:
      name: invoice_date__lt
      in: query
      description: Retornar saldos emitidos antes desta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-02'
    invoice_date__lte:
      name: invoice_date__lte
      in: query
      description: Retornar saldos emitidos nesta data ou antes (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-01'
    invoice_date__gt:
      name: invoice_date__gt
      in: query
      description: Retorne faturas emitidas após esta data (`YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-06'
    invoice_date__gte:
      name: invoice_date__gte
      in: query
      description: Retornar faturas emitidas nesta data ou posteriormente (`YYYY-MM-DD`)
      schema:
        type: string
        format: date
        example: '2022-05-04'
    invoice_date__range:
      name: invoice_date__range
      in: query
      description: >-
        Retornar faturas emitidas dentro deste intervalo de datas
        (`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: Retorne uma fatura com este ID (conforme fornecido pela instituição).
      schema:
        type: string
        example: 862B9918-3K6H-4E0B-NAI9-2BE2D833B840
    invoice_identification__in:
      name: invoice_identification__in
      in: query
      description: Retorne as faturas com estes IDs (conforme fornecido pela instituição).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: 992B9918-3G6H-4E0B-DAI9-2BE2D833B833
    status_invoice:
      name: status
      in: query
      description: >-
        Retorne faturas com este status. Pode ser `Vigente` (válido) ou
        `Cancelado` (cancelado).
      schema:
        type: string
        example: Vigente
    status__in_invoice:
      name: status__in
      in: query
      description: >-
        Retorne faturas com estes status. Pode ser `Vigente` (válido) ou
        `Cancelado` (cancelado).
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: Cancelado
    type_invoice:
      name: type
      in: query
      description: Retorne faturas deste tipo. Pode ser `OUTFLOW` ou `INFLOW`.
      schema:
        type: string
        enum:
          - OUTFLOW
          - INFLOW
        example: OUTFLOW
    type__in_invoice:
      name: type__in
      in: query
      description: Retorne faturas desses tipos. Pode ser `OUTFLOW` ou `INFLOW`.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - OUTFLOW
            - INFLOW
          example: OUTFLOW
    total_amount:
      name: total_amount
      in: query
      description: Retornar faturas que correspondam exatamente a 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: Retornar faturas 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: Retornar faturas menores ou iguais 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: Retornar faturas maiores 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: Retornar faturas maiores ou iguais 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: Retornar faturas entre esses dois 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: Retorne declarações de imposto exatamente para este ano (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__lt:
      name: ejercicio__lt
      in: query
      description: Retorne declarações de imposto de anos anteriores a este ano (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__lte:
      name: ejercicio__lte
      in: query
      description: Retorne declarações de imposto para este ano e 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: Retornar declarações de imposto para depois deste ano (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__gte:
      name: ejercicio__gte
      in: query
      description: Retorne declarações de imposto para este ano ou posterior (`YYYY`).
      schema:
        type: integer
        pattern: ^[0-9]{4}$
        minimum: 1900
        minLength: 4
        maxLength: 4
        example: 2017
    ejercicio__range:
      name: ejercicio__range
      in: query
      description: Retorne declarações de imposto para este intervalo de anos (`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: Retorne declarações de impostos com este tipo de declaração.
      schema:
        type: string
        example: Normal
    tipo_declaracion__in:
      name: tipo_declaracion__in
      in: query
      description: Retorne declarações de imposto com esses tipos de declaração.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: Commercial
    name__payments:
      name: name
      in: query
      description: >-
        Retorne uma instituição com este nome designado pela Belvo.


        **Nota:**


        Este filtro suporta consultas de pesquisa completas e parciais, com um
        mínimo de três caracteres necessários.


        Por exemplo, ao pesquisar por `itau`, os seguintes valores podem ser
        correspondidos:

          - `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: >-
        Retorne resultados apenas para este tipo de instituição. Pode ser
        `INDIVIDUAL` ou `BUSINESS`.
      schema:
        type: string
        enum:
          - INDIVIDUAL
          - BUSINESS
        example: INDIVIDUAL
    institution_id__in:
      name: id__in
      in: query
      description: Retorne informações para esses `id`s de instituição.
      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: >-
        Retorne resultados apenas para este tipo de cliente (ou `INDIVIDUAL` ou
        `BUSINESS`).
      schema:
        type: string
        enum:
          - INDIVIDUAL
          - BUSINESS
        example: INDIVIDUAL
    external_id__payments:
      name: external_id
      in: query
      description: Retornar objetos com 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: Retorne objetos com esses 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: >-
        Retorne resultados que correspondam à descrição que você pesquisou.


        **Nota:**


        Este filtro suporta consultas de pesquisa completas e parciais, com um
        mínimo de três caracteres necessários.


        Por exemplo, pesquisar por `trai` pode corresponder aos seguintes
        valores:

          - `Awesome training sneakers` 
          - `Training equipment`

        Pesquisar por `car` pode corresponder aos seguintes valores:

          - `Carlos Vives`
          - `Carmen Domínguez` 
          - `carlos.vives@musicabrazil.br`
      schema:
        type: string
        minLength: 3
        example: trai
    number:
      name: number
      in: query
      description: Retorne resultados que correspondam exatamente a este valor.
      schema:
        type: string
        example: '1231564526'
    number__in:
      name: number__in
      in: query
      description: Retornar resultados para estes números de conta bancária.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: '1231564526'
    customer:
      name: customer
      in: query
      description: O `customer.id` para o qual você deseja obter resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    holder__type:
      name: holder__type
      in: query
      description: Retorne os resultados para o tipo de titular fornecido.
      schema:
        type: string
        enum:
          - INDIVIDUAL
          - BUSINESS
        example: INDIVIDUAL
    holder__type__in:
      name: holder__type__in
      in: query
      description: Retornar resultados para os tipos de titular listados.
      schema:
        type: array
        items:
          type: string
          enum:
            - INDIVIDUAL
            - BUSINESS
          example: INDIVIDUAL
    status_payment-links:
      name: status
      in: query
      description: >-
        Retorne links de pagamento com este status. Pode ser `ACTIVE` ou
        `INACTIVE`.
      schema:
        type: string
        enum:
          - ACTIVE
          - INACTIVE
        example: ACTIVE
    ordering__payment-links:
      name: ordering
      in: query
      description: |-
        Retorne os resultados em uma ordem de tempo especificada.

        Pode ser:
          - `created_at`: retorna links de pagamento do mais novo para o mais antigo (em ordem ascendente).
          - `-created_at`: retorna links de pagamento do mais antigo para o mais novo (em ordem descendente).
      schema:
        enum:
          - created_at
          - '-created_at'
        example: '-created_at'
        type: string
    customer__in:
      name: customer__in
      in: query
      description: Um ou mais `customer.id`s para os quais você deseja obter 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: |-
        Retorne os resultados em uma ordem de tempo especificada.

        Pode ser:
          - `updated_at`: retorna intents de pagamento do mais recentemente atualizado para o último (em ordem ascendente).
          - `-updated_at`: retorna intents de pagamento do último atualizado para o mais recentemente atualizado (em ordem descendente).
      schema:
        enum:
          - updated_at
          - '-updated_at'
        example: updated_at
        type: string
    provider:
      name: provider
      in: query
      description: >-
        Retorne resultados apenas para este provedor. No momento, você só pode
        ser `belvo`.
      schema:
        type: string
        enum:
          - belvo
        example: belvo
    payment_method_type:
      name: payment_method_type
      in: query
      description: >-
        Retorne resultados apenas para este tipo de método de pagamento. Pode
        ser `open_finance` ou `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: Retorne resultados apenas para este valor.
      schema:
        type: string
        example: SUCCEEDED
    status__in_payment-intents:
      name: status__in
      in: query
      description: Retorne intents de pagamento com um destes status.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: PROCESSING
    updated_at:
      name: updated_at
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo nesta data (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    updated_at__gt:
      name: updated_at__gt
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo após esta data (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-05'
    updated_at__gte:
      name: updated_at__gte
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo após ou nesta data (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-05-04'
    updated_at__lt:
      name: updated_at__lt
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo antes desta data (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-04-01'
    updated_at__lte:
      name: updated_at__lte
      in: query
      description: >-
        Retorne itens que foram atualizados pela última vez no banco de dados da
        Belvo antes ou na data especificada (no formato `YYYY-MM-DD`).
      schema:
        type: string
        format: date
        example: '2022-03-30'
    updated_at__range:
      name: updated_at__range
      in: query
      description: >-
        Retorne contas que foram atualizadas pela última vez no banco de dados
        do Belvo entre duas datas (no 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: >-
        Cabeçalho obrigatório que indica qual versão da API de Pagamentos você
        deseja usar. Atualmente, isso é aplicável apenas para Autorizações de
        Pagamento no Brasil e deve ser configurado como `Payments-BR.V2`.


        {% admonition type="warning" name="Em BETA" %}
          Esta versão está em BETA. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
        {% /admonition %}
      schema:
        type: string
        enum:
          - Payments-BR.V2
        example: Payments-BR.V2
    charge:
      name: charge
      in: query
      description: O `charge.id` para o qual você deseja obter resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    charge__in:
      name: charge__in
      in: query
      description: Um ou mais `charge.id`s para os quais você deseja obter 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: O `beneficiary.id` para o qual você deseja obter resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    beneficiary__in:
      name: beneficiary__in
      in: query
      description: Um ou mais `beneficiary.id`s para os quais você deseja obter 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: O `bank-account.id` do pagador para o qual você deseja obter resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    payer__in:
      name: payer__in
      in: query
      description: >-
        Um ou mais `bank-account.id`s do pagador para os quais você deseja obter
        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: O `payment-intent.id` para o qual você deseja obter resultados.
      schema:
        type: string
        format: uuid
        example: 24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d
    payment_intent__in:
      name: payment_intent__in
      in: query
      description: >-
        Um ou mais `payment-intent.id`s para os quais você deseja obter
        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: >-
        Retorne os resultados para este tipo de transação. Pode ser `INFLOW` ou
        `OUTFLOW`.
      schema:
        type: string
        enum:
          - INFLOW
          - OUTFLOW
        example: INFLOW
    description:
      name: description
      in: query
      description: Retornar resultados para itens com esta descrição.
      schema:
        type: string
        example: Training shoes
    customer_identifier:
      name: customer__identifier
      in: query
      description: O CPF do cliente para o qual você deseja obter resultados.
      schema:
        type: string
        minLength: 11
        maxLength: 14
        example: 23100299900
    status_enrollments:
      name: status
      in: query
      description: |-
        Retorne as inscrições com o status fornecido. Pode ser:
          - `PENDING`
          - `SUCCEEDED`
          - `CANCELED`
          - `FAILED`
      schema:
        type: string
        example: PENDING
    status__in_enrollments:
      name: status__in
      in: query
      description: |-
        Retornar inscrições com os seguintes status:
          - `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: O número total de resultados na sua conta Belvo.
          example: 130
        next:
          type: string
          nullable: true
          format: uri
          description: >-
            A URL para a próxima página de resultados. Cada página consiste em
            até 100 itens. Se não houver resultados suficientes para uma página
            adicional, o valor será `null`.


            Em nosso exemplo de documentação, usamos `{endpoint}` como um valor
            de espaço reservado. Em produção, esse valor será substituído pelo
            endpoint real que você está usando atualmente (por exemplo,
            `accounts` ou `owners`).
          example: >-
            https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous:
          type: string
          nullable: true
          format: uri
          description: >-
            A URL para a página anterior de resultados. Se não houver uma página
            anterior, o valor será `null`.
          example: null
    EnumInstitutionType:
      type: string
      enum:
        - bank
        - fiscal
        - employment
      description: |-
        O tipo de instituição. Retornamos um dos seguintes valores:

          - `bank`
          - `fiscal`
          - `employment`
    InstitutionsFormFieldValues:
      type: object
      properties:
        code:
          type: string
          description: O código do documento.
          example: '001'
        label:
          type: string
          description: |-
            O rótulo para o campo. Por exemplo:
            - Cédula de Ciudadanía
            - Cédula de Extranjería
            - Pasaporte
          example: Cédula de Ciudadanía
        validation:
          type: string
          description: O tipo de validação de entrada usado para o campo.
          example: ^.{1,}$
        validation_message:
          type: string
          description: >-
            A mensagem exibida quando uma entrada inválida é fornecida no campo
            do formulário.
          example: Invalid document number
        placeholder:
          type: string
          description: O texto do espaço reservado no campo do formulário.
          example: DEF4444908M22
    InstitutionsFormField:
      type: object
      properties:
        name:
          type: string
          description: O campo de nome de usuário, senha ou tipo de nome de usuário.
          example: username
        type:
          type: string
          description: O tipo de entrada para o campo do formulário. Por exemplo, string.
          example: text
        label:
          type: string
          description: |-
            O rótulo do campo do formulário. Por exemplo:
            - Número do cliente
            - Chave Bancanet
            - Documento
          example: Client number
        validation:
          type: string
          description: O tipo de validação de entrada usado para o campo.
          example: ^.{1,}$
        placeholder:
          type: string
          description: O texto do espaço reservado no campo do formulário.
          example: ABC333333A33
        validation_message:
          type: string
          description: >-
            A mensagem exibida quando uma entrada inválida é fornecida no campo
            do formulário.
          example: Invalid client number
        values:
          type: array
          description: >-
            Se o campo do formulário for para documentos, a instituição pode
            exigir informações adicionais sobre o tipo de documento.
          items:
            $ref: '#/components/schemas/InstitutionsFormFieldValues'
    InstitutionsFeature:
      type: object
      properties:
        name:
          type: string
          description: O nome do recurso.
          example: token_required
        description:
          type: string
          description: A descrição do recurso.
          example: The institution may require a token during link creation or login
    EnumInstitutionIntegrationType:
      type: string
      enum:
        - credentials
        - openfinance
      description: >-
        O tipo de tecnologia usada para acessar a instituição. Retornamos um dos
        seguintes valores:


        - `credentials`: Usa a tecnologia de scraping da Belvo, combinada com
        credenciais do usuário, para realizar solicitações.

        - `openfinance`: Usa a API de open finance do banco para realizar
        solicitações.
      example: credentials
    EnumInstitutionStatus:
      type: string
      enum:
        - healthy
        - down
      description: >-
        Indica se a integração da Belvo com a instituição está atualmente ativa
        (`healthy`) ou em manutenção (`down`).
      example: healthy
    InstitutionPublicApi:
      type: object
      title: Objeto Institution
      description: Objeto detalhando a instituição de agregação.
      x-tags:
        - Institutions
      properties:
        id:
          type: integer
          format: int32
          description: O ID da instituição conforme designado pela Belvo.
          example: 1003
        name:
          type: string
          example: erebor_mx_retail
          description: O nome da instituição, conforme designado pela Belvo.
        type:
          $ref: '#/components/schemas/EnumInstitutionType'
        website:
          type: string
          nullable: true
          example: https://www.erebor.com/
          description: A URL do site da instituição.
        display_name:
          type: string
          example: Erebor Mexico
          description: O nome da instituição voltado para o cliente.
        country_codes:
          type: array
          description: |-
            Os códigos de país onde a instituição está disponível, por exemplo:
            - 🇧🇷 BR (Brasil)
            - 🇨🇴 CO (Colômbia)
            - 🇲🇽 MX (México)
          items:
            type: string
            example: MX
        primary_color:
          type: string
          example: '#056dae'
          description: A cor primária no site da instituição.
        logo:
          type: string
          nullable: true
          example: https://belvo-api-media.s3.amazonaws.com/logos/erebor_logo.png
          description: A URL do logotipo da instituição.
        icon_logo:
          type: string
          nullable: true
          example: https://statics.belvo.io/widget/images/institutions/erebor.svg
          description: A URL do logotipo do ícone da instituição.
        text_logo:
          type: string
          nullable: true
          example: https://statics.belvo.io/widget/images/institutions/erebor.svg
          description: A URL do logotipo de texto da instituição.
        form_fields:
          type: array
          items:
            $ref: '#/components/schemas/InstitutionsFormField'
        features:
          type: array
          description: >-
            Os recursos que a instituição suporta. Se a instituição não tiver
            recursos especiais, a Belvo retorna um array vazio.


            Aqui está uma lista dos recursos disponíveis:

            - `token_required` indica que a instituição pode exigir um token
            durante a criação do link ou ao fazer qualquer outra solicitação.
          items:
            $ref: '#/components/schemas/InstitutionsFeature'
        resources:
          type: array
          description: >-
            Uma lista de recursos do Belvo que você pode usar com a instituição.
            Esta lista inclui um ou mais dos seguintes 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: Um recurso Belvo que a instituição suporta.
            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: >-
        Um ID único de 32 caracteres da solicitação (correspondente a um padrão
        regex de: `[a-f0-9]{32}`). Forneça este ID ao entrar em contato com a
        equipe de suporte da Belvo para acelerar as investigações.
      example: 9e7b283c6efa449c9c028a16b5c249fb
    UnauthorizedError:
      type: object
      title: Erro Não Autorizado
      description: >-
        Esse erro ocorre quando você tenta fazer uma chamada de API usando
        credenciais incorretas da API Belvo (ou sua chave secreta ou senha
        secreta, ou ambos, estão incorretos).
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`authentication_failed`) que permite
            classificar e lidar com o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#401-authentication_failed"
            target="_blank">erros 401 authentication_failed</a>.
          example: authentication_failed
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `authentication_failed`, a descrição é:

              - `Invalid Secret Keys`.
          example: Invalid Secret Keys
        request_id:
          $ref: '#/components/schemas/request_id'
    401_consent_without_accounts_error:
      type: object
      title: Consentimento Sem Contas
      description: >-
        Esse erro ocorre quando o seu usuário removeu contas associadas ao
        consentimento que ele forneceu. Por exemplo, quando o usuário gerou o
        consentimento pela primeira vez, ele tinha uma conta corrente e uma
        conta de empréstimo na instituição, mas desde então fechou essas contas.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`consent_without_accounts`) que permite
            classificar e lidar com o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#401-consent_without_accounts"
            target="_blank">erros 401 consent_without_accounts</a>.
          example: consent_without_accounts
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `invalid` relacionados a `fetch_resources`, a descrição
            é:


            - `A instituição suporta apenas os seguintes recursos: (lista de
            recursos suportados separada por vírgulas)`.
          example: >-
            The institution only supports the following resources:
            EMPLOYMENT_RECORDS, OWNERS
        request_id:
          $ref: '#/components/schemas/request_id'
    AccessToResourceDenied:
      type: object
      title: Acesso à API Belvo negado
      description: >-
        Esse erro ocorre quando você tenta acessar o recurso da Belvo sem as
        permissões corretas.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`access_to_resource_denied`) que permite
            classificar e tratar o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <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: |-
            Uma breve descrição do erro.

            Para erros `access_to_resource_denied`, a descrição é:

              - `You don't have access to this resource.`.
          example: You don't have access to this resource.
        request_id:
          $ref: '#/components/schemas/request_id'
    404NotFoundError:
      type: object
      title: Não encontrado
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`not_found`) que permite classificar e
            lidar com o erro programaticamente.
          example: not_found
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `not_found`, a descrição é:

              - `Not found`
          example: Not found
        request_id:
          $ref: '#/components/schemas/request_id'
    RequestTimeoutError:
      type: object
      title: Tempo de Solicitação Esgotado
      description: >-
        A Belvo tem um limite em relação ao tempo necessário para fazer login,
        recuperar dados da conta e fazer logout. Um timeout ocorre quando há uma
        quantidade muito grande de dados e não foi possível obter tudo dentro do
        tempo alocado.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`request_timeout`) que permite classificar
            e lidar com o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#408-request_timeout"
            target="_blank">erros 408 request_timeout</a>.
          example: request_timeout
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros de `request_timeout`, a descrição é:

              - `The request timed out, you can retry asking for less data by changing your query parameters`.
          example: >-
            The request timed out, you can retry asking for less data by
            changing your query parameters
        request_id:
          $ref: '#/components/schemas/request_id'
    UnexpectedError:
      type: object
      title: Erro Inesperado
      description: >-
        Esse erro ocorre quando nós (Belvo) encontramos um erro interno do
        sistema (desculpe por isso) ou devido a uma resposta não suportada da
        instituição.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`unexpected_error`) que permite classificar
            e tratar o erro de forma programática.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#500-unexpected_error"
            target="_blank">erros 500 unexpected_error</a>.
          example: unexpected_error
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `unexpected_error`, a descrição é:

              - `Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição`.
          example: >-
            Belvo is unable to process the request due to an internal system
            issue or to an unsupported response from an institution
        request_id:
          $ref: '#/components/schemas/request_id'
    id:
      type: string
      format: uuid
      description: Identificador único da Belvo para o item atual.
      example: 0d3ffb69-f83b-456e-ad8e-208d0998d71d
    EnumLinkAccessModeResponse:
      type: string
      nullable: true
      enum:
        - single
        - recurrent
        - null
      description: >-
        O tipo de link. Para mais informações, consulte nosso artigo de <a
        href="https://developers.belvo.com/docs/links-and-institutions#links"
        target="_blank">Links</a>. Retornamos um dos seguintes valores enum: -
        `single` - `recurrent` - `null`
      example: recurrent
    last_accessed_at:
      type: string
      nullable: true
      format: date-time
      description: >-
        O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à
        instituição para o link fornecido.
      example: '2021-03-09T10:28:40.000Z'
    created_at:
      type: string
      format: date-time
      description: >-
        O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado
        no banco de dados da Belvo.
      example: '2022-02-09T08:45:50.406032Z'
    external_id:
      type: string
      minLength: 3
      maxLength: 256
      description: >-
        Um identificador adicional para o link, fornecido por você, para
        armazenar no banco de dados da Belvo. **Não pode** incluir nenhuma
        Informação Pessoal Identificável (PII). **Deve** ter pelo menos três
        caracteres.


        Se identificarmos que o identificador contém PII, forçaremos um valor
        `null`. Para mais informações, consulte nosso <a
        href="https://developers.belvo.com/docs/link-creation-best-practices#adding-your-own-identifier"
        target="_blank">artigo sobre criação de links</a>.
      example: 56ab5706-6e00-48a4-91c9-ca55968678d9
    EnumLinkStatus:
      type: string
      enum:
        - valid
        - invalid
        - unconfirmed
        - token_required
      description: >-
        O status atual do link. Para mais informações, consulte nosso artigo
        sobre <a
        href="https://developers.belvo.com/docs/links-and-institutions#links"
        target="_blank">Link</a> no devportal.  

        Retornamos um dos seguintes valores:  
          - `valid`  
          - `invalid`  
          - `unconfirmed`  
          - `token_required`
      example: valid
    created_by:
      type: string
      format: uuid
      description: O ID único para o usuário que criou este item.
      example: bcef7f35-67f2-4b19-b009-cb38795faf09
    EnumLinkRefreshRate:
      type: string
      nullable: true
      default: 7d
      enum:
        - 6h
        - 12h
        - 24h
        - 7d
        - 30d
        - null
      description: >-
        A taxa de atualização para o link recorrente. Para mais informações,
        consulte nossa <a
        href="https://developers.belvo.com/docs/links-and-institutions#recurrent-links"
        target="_blank">documentação de links recorrentes</a> em nosso
        DevPortal.

        Retornamos um dos seguintes valores de enum:
          - `6h`
          - `12h`
          - `24h`
          - `7d` (padrão)
          - `30d` (uma vez por mês)
          - `null` (para links únicos)
      example: 7d
    credentials_storage:
      type: string
      pattern: ^(store|nostore|\d{1,3}d)$
      description: >-
        Indica se as credenciais devem ou não ser armazenadas (e a duração para
        a qual as credenciais serão armazenadas).


        - Para links recorrentes, isso é definido como `store` por padrão (e não
        pode ser alterado).

        - Para links únicos, isso é definido como `365d` por padrão.


        Pode ser:
          - `store` para armazenar credenciais (até que o link seja excluído)
          - `nostore` para não armazenar credenciais
          - Qualquer valor entre `1d` e `365d` para indicar o número de dias que você deseja que as credenciais sejam armazenadas.

        Para mais informações, confira a seção <a
        href="https://developers.belvo.com/docs/data-retention-controls#credentials_storage"
        target="_blank">credentials_storage</a> do nosso artigo sobre controles
        de retenção de dados.
      example: 27d
    stale_in:
      type: string
      pattern: ^\d{1,3}d$
      description: >-
        Indica por quanto tempo qualquer dado derivado do usuário deve ser
        armazenado no banco de dados da Belvo para o link (tanto único quanto
        recorrente). Por exemplo, se você enviar `90d`, a Belvo removerá
        qualquer dado relacionado ao usuário de seu banco de dados após 90 dias.
        Para mais informações, confira a seção <a
        href="https://developers.belvo.com/docs/data-retention-controls#stale_in"
        target="_blank">stale_in</a> do nosso artigo sobre controles de retenção
        de dados.


        > 📘 Informação

        >

        > A Belvo removerá dados apenas para links que não foram atualizados no
        período que você fornecer em `stale_in`. A Belvo removerá dados apenas
        para links que não foram atualizados no período que você fornecer em
        `stale_in`.


        Por padrão, a Belvo armazena dados do usuário por 365 dias, a menos que
        o link seja deletado.
      example: 42d
    Link:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        institution:
          type: string
          description: Nome da instituição segundo a 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: >-
            > 📘 Info

            >

            > Aplicável apenas para links criados **após 08-02-2022**.


            Uma string única de 44 caracteres que pode ser usada para
            identificar um usuário em uma determinada instituição.


            📚 Confira nosso artigo no <a
            href="https://developers.belvo.com/docs/link-creation-best-practices#avoiding-duplicated-links"
            target="_blank">DevPortal sobre como evitar links duplicados</a>
            para mais informações e dicas sobre como usá-la.
          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: >-
            Um array de recursos para o qual você receberá uma atualização
            histórica.
          items:
            type: string
            description: Um recurso Belvo que a instituição suporta.
            example: ACCOUNTS
          example:
            - ACCOUNTS
            - TRANSACTIONS
        stale_in:
          $ref: '#/components/schemas/stale_in'
    EnumLinkAccessModeRequest:
      type: string
      enum:
        - single
        - recurrent
      description: >-
        O tipo de link a ser criado.


        - Use `single` para fazer requisições POST ad hoc únicas para contas,
        proprietários e transações.

        - Use `recurrent` para que o Belvo acesse informações de forma
        recorrente, garantindo que você sempre tenha dados atualizados de
        contas, proprietários, saldos e transações.


        Para mais informações, consulte nosso artigo de <a
        href="https://developers.belvo.com/docs/links-and-institutions#links"
        target="_blank">Links</a>.
      default: recurrent
    LinksRequestEmploymentBrazil:
      type: object
      title: Links de Emprego (Brasil)
      description: >-
        O corpo da solicitação para criar um link para instituições de emprego
        no Brasil.
      required:
        - institution
        - username
        - password
      properties:
        institution:
          type: string
          pattern: '[a-z]+_[a-z]{2}_[a-z]+'
          description: >-
            O nome Belvo para a instituição. Para instituições de emprego no
            Brasil, você pode selecionar as seguintes instituições:


            - `inss_br_employment`
          example: inss_br_employment
        username:
          type: string
          pattern: ^^(\d{11}$)|(\d{3}\.){2}\d{3}(-\d{2})$
          description: >-
            O CPF (ID) do usuário usado para fazer login na instituição. Você
            pode fornecê-lo com 11 caracteres ou no formato `XXX.XXX.XXX-XX`.
          example: 231.002.999-00
        password:
          type: string
          format: password
          pattern: ^.{8,70}$
          description: A senha do usuário usada para fazer login na instituição.
          example: 1234B789C234AGH
        external_id:
          $ref: '#/components/schemas/external_id'
        access_mode:
          $ref: '#/components/schemas/EnumLinkAccessModeRequest'
        fetch_resources:
          type: array
          description: >-
            Uma matriz de recursos para os quais você gostaria de receber uma
            atualização histórica.


            Para instituições de emprego, você pode selecionar os seguintes
            recursos:
              - `OWNERS`
              - `EMPLOYMENTS`
          items:
            type: string
            description: Um recurso Belvo que a instituição suporta.
            example: EMPLOYMENTS
          example:
            - OWNERS
            - EMPLOYMENTS
        credentials_storage:
          $ref: '#/components/schemas/credentials_storage'
        stale_in:
          $ref: '#/components/schemas/stale_in'
    LinksRequestEmploymentMexico:
      type: object
      title: Links de Emprego (México)
      description: >-
        O corpo da solicitação para criar um link para instituições de emprego
        no México.
      required:
        - institution
        - username
      properties:
        institution:
          type: string
          pattern: '[a-z]+_[a-z]{2}_[a-z]+'
          description: >-
            O nome Belvo para a instituição. Para instituições de emprego no
            México, você pode selecionar as seguintes instituições:


            - `imss_mx_employment`

            - `issste_mx_employment`

            - `planet_mx_employment` (instituição Sandbox)
          example: imss_mx_employment
        username:
          type: string
          pattern: ^([A-Z]{4})([0-9]{6})([A-Z]{6})([A-Z0-9]{2})$
          description: A CURP (ID) do usuário usada para fazer login na instituição.
          example: BLPM951331IONVGR54
        username2:
          type: string
          description: >-
            O endereço de e-mail do usuário usado para fazer login na
            instituição. Nota necessária 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: >-
            Uma matriz de recursos para os quais você gostaria de receber uma
            atualização histórica.


            Para instituições de emprego, você pode selecionar os seguintes
            recursos:
              - `EMPLOYMENT_RECORDS`
              - `EMPLOYMENT_METRICS` (apenas para o IMSS do México)
          items:
            type: string
            description: Um recurso Belvo que a instituição suporta.
            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: Fiscal Links (México)
      description: >-
        O corpo da solicitação para criar um link para instituições fiscais no
        México.
      required:
        - institution
        - username
        - password
      properties:
        institution:
          type: string
          pattern: '[a-z]+_[a-z]{2}_[a-z]+'
          description: >-
            O nome Belvo para a instituição. Para instituições fiscais no
            México, você pode selecionar as seguintes instituições:


            - `sat_mx_fiscal`

            - `tatooine_mx_fiscal` (Instituição Sandbox)
          example: sat_mx_fiscal
        username:
          type: string
          pattern: ^.{12,13}$
          description: O RFC (ID fiscal) do usuário usado para fazer login na instituição.
          example: 123456789101
        password:
          type: string
          format: password
          pattern: ^[a-zA-Z0-9]{8}
          description: A senha do usuário usada para fazer login na instituição.
          example: passw0rd
        external_id:
          $ref: '#/components/schemas/external_id'
        access_mode:
          $ref: '#/components/schemas/EnumLinkAccessModeRequest'
        fetch_resources:
          type: array
          description: >-
            Uma matriz de recursos para os quais você gostaria de receber uma
            atualização histórica.


            Para instituições fiscais, você pode selecionar os seguintes
            recursos:
              - `FINANCIAL_STATEMENTS`
              - `INVOICES`
              - `TAX_COMPLIANCE_STATUS`
              - `TAX_RETENTIONS`
              - `TAX_RETURNS`
              - `TAX_STATUS`
          items:
            type: string
            description: Um recurso Belvo que a instituição suporta.
            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: Sessões Demais
      description: |-
        Este erro ocorre quando:

          - um usuário está tentando fazer login na sua instituição via Belvo enquanto já está logado na sua instituição em um navegador web ou aplicativo móvel.
          - você faz uma solicitação de informações enquanto o Belvo está extraindo dados da instituição para esse usuário.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`too_many_sessions`) que permite
            classificar e lidar com o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-too_many_sessions"
            target="_blank">erros 400 too_many_sessions</a>.
          example: too_many_sessions
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `too_many_sessions`, a descrição é:


            - `Impossível fazer login, uma sessão já está aberta com a
            instituição para estas credenciais`.
          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: Erro de Login
      description: |-
        Esse erro pode ocorrer quando:

          - as credenciais fornecidas pelo seu usuário estão incorretas ou ausentes.
          - o token MFA fornecido pelo seu usuário não é suportado pelo Belvo.
          - há um problema com a instituição que impede os logins.
          - a conta do usuário está bloqueada ou o usuário não tem permissão para acessar seu internet banking.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`login_error`) que permite classificar e
            lidar com o erro de forma programática.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-login_error"
            target="_blank">erros 400 login_error</a>.
          example: login_error
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `login_error`, a descrição pode ser uma das seguintes:


            - `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: Sessão Expirada
      description: >-
        Esse erro ocorre quando você tenta retomar uma sessão de solicitação que
        já expirou. Isso geralmente acontece porque o usuário demorou muito para
        fornecer seu token de autenticação.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`session_expired`) que permite classificar
            e tratar o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-session_expired"
            target="_blank">erros 400 session_expired</a>.
          example: session_expired
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `session_expired`, a descrição é:


            - `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: Erro de Validação
      description: >-
        Esse erro ocorre quando é feita uma solicitação que não inclui todos os
        campos obrigatórios ou inclui dados inválidos.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`null`, `does_not_exist`, `required`) que
            permite classificar e lidar com o erro de forma programática.


            ℹ️ Confira nosso DevPortal para mais informações sobre como lidar
            com:
              - <a href="https://developers.belvo.com/docs/belvo-api-errors#400-blank" target="_blank">erros 400 blank</a>
              - <a href="https://developers.belvo.com/docs/belvo-api-errors#400-null" target="_blank">erros 400 null</a>
              - <a href="https://developers.belvo.com/docs/belvo-api-errors#400-does_not_exist" target="_blank">erros 400 does_not_exist</a>
              - <a href="https://developers.belvo.com/docs/belvo-api-errors#400-required" target="_blank">erros 400 required</a>
          example: required
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros de validação, a descrição pode ser (entre outras):

            - `Este campo é obrigatório.`
            - `Objeto com name=narnia não existe.`
            - `Este campo não pode ser nulo.`
            - `Este campo não pode estar em branco.`
          example: This field is required.
        request_id:
          $ref: '#/components/schemas/request_id'
        field:
          type: string
          nullable: true
          description: Nome do campo onde o erro foi encontrado.
          example: link
    InstitutionDownError:
      type: object
      title: Instituição Fora do Ar
      description: >-
        Esse erro ocorre quando o site da instituição que você está tentando
        acessar está fora do ar devido a manutenção ou outros problemas, o que
        significa que o Belvo não consegue criar novos links ou recuperar novos
        dados.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`institution_down`) que permite classificar
            e lidar com o erro de forma programática.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-institution_down"
            target="_blank">erros 400 institution_down</a>.
          example: institution_down
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `institution_down`, a descrição é:

            - `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: Instituição Indisponível
      description: >-
        Esse erro ocorre quando o site da instituição que você está tentando
        acessar está fora do ar devido a manutenção ou outros problemas, o que
        significa que o Belvo não consegue criar novos links ou recuperar novos
        dados.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`institution_unavailable`) que permite
            classificar e lidar com o erro de forma programática.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-institution_unavailable"
            target="_blank">erros 400 institution_unavailable</a>.
          example: institution_unavailable
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `institution_unavailable`, a descrição é:

              - `The financial institution is unavailable`.
          example: The financial institution is unavailable
        request_id:
          $ref: '#/components/schemas/request_id'
    InstitutionInactiveError:
      type: object
      title: Instituição Inativa
      description: >-
        Esse erro ocorre quando nós (Belvo) desativamos a instituição em nossa
        API.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`institution_inactive`) que permite
            classificar e lidar com o erro de forma programática.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-institution_inactive"
            target="_blank">erros 400 institution_inactive</a>.
          example: institution_inactive
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `institution_inactive`, a descrição é:

            - `The institution has been temporarily deactivated`.
          example: The institution has been temporarily deactivated
        request_id:
          $ref: '#/components/schemas/request_id'
    InvalidLinkError:
      type: object
      title: Link inválido
      description: >-
        Esse erro ocorre quando você tenta acessar uma conta, mas as credenciais
        do usuário não são mais válidas, resultando em um erro da instituição.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`invalid_link`) que permite classificar e
            lidar com o erro de forma programática.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid_link"
            target="_blank">erros 400 invalid_link</a>.
          example: invalid_link
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `invalid_link`, a descrição é:


            - `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: Armazenamento de Credenciais Inválidas
      description: >-
        Esse erro ocorre quando você tentou criar um link **recorrente** onde
        definiu `credentials_storage` como `nostore` ou para um intervalo de
        datas entre `1d` e `365d`.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`invalid_credentials_storage`) que permite
            classificar e lidar com o erro de forma programática.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid_credentials_storage"
            target="_blank">erros 400 invalid_credentials_storage</a>.
          example: login_error
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `invalid_credentials_storage`, a descrição pode ser uma
            das seguintes:

              - `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 Busca Inválidos
      description: >-
        Esse erro ocorre quando você tentou criar um link onde definiu
        `credentials_storage` como `nostore` e não enviou nenhum recurso em
        `fetch_resources`. Para links onde não armazenamos credenciais, você
        deve enviar um array de recursos em `fetch_resources`.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`invalid_fetch_resources`) que permite
            classificar e lidar com o erro de forma programática.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid_fetch_resources"
            target="_blank">erros 400 invalid_fetch_resources</a>.
          example: invalid_fetch_resources
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `invalid_fetch_resources`, a descrição pode ser uma das
            seguintes:

              - `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 Inválidos
      description: >-
        Esse erro ocorre quando você tentou criar um link onde adicionou
        recursos em `fetch_resources` que não são suportados pela instituição.
      properties:
        field:
          type: string
          description: >-
            O parâmetro de solicitação que está causando o erro. Para recursos
            inválidos, isso será definido como `resources`.
          example: resources
        code:
          type: string
          description: >-
            Um código de erro único (`invalid`) que permite classificar e lidar
            com o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid"
            target="_blank">erros 400 invalid_period</a>.
          example: invalid
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `invalid` relacionados a `fetch_resources`, a descrição
            é:


            - `A instituição suporta apenas os seguintes recursos: (lista de
            recursos suportados separada por vírgulas)`.
          example: >-
            The institution only supports the following resources:
            EMPLOYMENT_RECORDS, OWNERS
        request_id:
          $ref: '#/components/schemas/request_id'
    UnconfirmedLinkError:
      type: object
      title: Link não confirmado
      description: >-
        Esse erro ocorre quando você tenta acessar um link que foi pausado
        anteriormente (e, como tal, não está ativo agora).


        O status de um Link é definido como `unconfirmed_link` quando o seu
        usuário não concluiu com sucesso o processo de criação do Link (por
        exemplo, ele pode não ter fornecido um token MFA válido).
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`unconfirmed_link`) que permite classificar
            e lidar com o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-unconfirmed_link"
            target="_blank">erros 400 unconfirmed_link</a>.
          example: unconfirmed_link
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `unconfirmed_link`, a descrição é:

            - `A criação do link ainda não foi concluída`.
          example: The link creation has not been completed yet
        request_id:
          $ref: '#/components/schemas/request_id'
    UnsupportedOperationError:
      type: object
      title: Operação Não Suportada
      description: >-
        Esse erro ocorre quando você tenta acessar alguma operação de dados que
        a Belvo não suporta para uma instituição. Por exemplo, tentar acessar o
        recurso Balances para instituições fiscais.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`unsupported_operation`) que permite
            classificar e lidar com o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-unsupported_operation"
            target="_blank">erros 400 unsupported_operation</a>.
          example: unsupported_operation
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `unsupported_operation`, a descrição é:

              - `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: >-
            Um ID único de 32 caracteres da solicitação (correspondente a um
            padrão regex de: `[a-f0-9]{32}`). Forneça este ID ao entrar em
            contato com a equipe de suporte da Belvo para acelerar as
            investigações.
          example: 9e7b283c6efa449c9c028a16b5c249fb
    InvalidPeriodError:
      type: object
      title: Período Inválido
      description: >-
        Esse erro ocorre quando você solicita receitas para um link dentro de um
        intervalo de datas, no entanto, o período entre `date_from` e `date_to`
        é inferior a 90 dias.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`invalid_period`) que permite classificar e
            tratar o erro programaticamente.


            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#400-invalid_period"
            target="_blank">erros 400 invalid_period</a>.
          example: invalid_period
        message:
          type: string
          description: >-
            Uma breve descrição do erro.


            Para erros `invalid_period`, a descrição é:


            - `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: Token MFA Necessário
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`token_required`) que permite classificar e
            lidar com o erro programaticamente.

            ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar
            com <a
            href="https://developers.belvo.com/docs/belvo-api-errors#428-token_required"
            target="_blank">erros 428 token_required</a>.
          example: token_required
        message:
          type: string
          description: >-
            Uma breve descrição do erro. Para erros `token_required`, a
            descrição é:


            - `A instituição requer um token MFA para fazer 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: >-
            Um ID único de 32 caracteres da sessão de login (correspondente a um
            padrão regex de: `[a-f0-9]{32}`).
          example: 2675b703b9d4451f8d4861a3eee54449
        expiry:
          type: integer
          format: int32
          description: Tempo de duração da sessão em segundos.
          example: 9600
        link:
          type: string
          format: uuid
          description: >-
            Identificador único criado pela Belvo, usado para referenciar o Link
            atual.
          example: 30cb4806-6e00-48a4-91c9-ca55968576c8
        token_generation_data:
          type: object
          description: Detalhes sobre como gerar o token.
          properties:
            instructions:
              type: string
              description: Instruções para geração de token.
              example: Use this code to generate the token
            type:
              type: string
              description: Tipo de dados para gerar o token (QR code, desafio numérico).
              example: numeric
            value:
              type: string
              description: Valor a ser usado para gerar o token.
              example: '12345'
            expects_user_input:
              type: boolean
              description: >-
                Indica se o usuário precisa fornecer entrada para concluir a
                autenticação. Quando definido como `false`, seu usuário pode
                precisar:

                - confirmar o login em outro dispositivo

                - escanear um código QR

                Você ainda precisará fazer uma chamada PATCH para concluir a
                solicitação.
              example: true
              default: true
    token:
      type: string
      description: >-
        O token MFA gerado pela instituição, que é necessário para continuar uma
        sessão.
      example: 1234ab
    save_data:
      type: boolean
      default: true
      description: >-
        Indica se os dados devem ou não ser persistidos no Belvo. Por padrão,
        isso é definido como `true` e retornamos uma resposta 201 Created.


        Quando definido como `false`, os dados não serão persistidos e
        retornamos uma resposta 200 OK.
      example: true
    PatchBody:
      type: object
      description: Um objeto JSON contendo um UUID de sessão e um token MFA
      required:
        - session
        - link
      properties:
        session:
          type: string
          pattern: '[a-f0-9]{32}'
          description: >-
            A sessão que você deseja retomar. Você precisa usar o valor
            `session` que é fornecido na resposta 428 Token Required que você
            recebe após fazer sua solicitação POST.
          example: 6e7b283c6efa449c9c028a16b5c249fa
        token:
          $ref: '#/components/schemas/token'
        link:
          type: string
          format: uuid
          description: >-
            O `link.id` que você deseja retomar. Deve ser o mesmo `link.id` que
            você recebe na resposta 428 Token Required que contém o ID da
            `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: A senha do usuário final usada para fazer login na instituição.
          example: password
        password2:
          type: string
          description: >-
            A segunda senha do usuário final usada para fazer login na
            instituição.


            > 📘 Informação

            >

            > Isso é necessário apenas para algumas instituições. Para saber
            quais instituições exigem uma segunda senha, consulte nossa
            solicitação de Lista de instituições e verifique o array
            `form_fields` na resposta.
          example: pin
        token:
          $ref: '#/components/schemas/token'
    ChangeAccessMode:
      type: object
      description: >-
        Corpo da solicitação para alterar o modo de acesso, stale_in ou
        fetch_resources de um link.
      properties:
        access_mode:
          $ref: '#/components/schemas/EnumLinkAccessModeRequest'
        stale_in:
          $ref: '#/components/schemas/stale_in'
        fetch_resources:
          type: array
          description: >-
            Uma matriz de recursos para os quais você gostaria de receber uma
            atualização histórica.


            Para instituições bancárias, você pode selecionar os seguintes
            recursos:
              - `ACCOUNTS`
              - `OWNERS`
              - `TRANSACTIONS`
              - `BILLS`
              - `INVESTMENTS`
              - `INVESTMENT_TRANSACTIONS`
              - `INCOMES`
              - `RECURRING_EXPENSES`
              - `RISK_INSIGHTS`

            Para instituições fiscais, você pode selecionar os seguintes
            recursos:
              - `FINANCIAL_STATEMENTS`
              - `INVOICES`
              - `TAX_COMPLIANCE_STATUS`
              - `TAX_RETENTIONS`
              - `TAX_RETURNS`
              - `TAX_STATUS`

            Para instituições de emprego, você pode selecionar os seguintes
            recursos:
              - `EMPLOYMENT_RECORDS` (Apenas para IMSS e ISSTE do México)
              - `EMPLOYMENT_METRICS` (Apenas para IMSS do México)
              - `EMPLOYMENTS` (Apenas para INSS do Brasil)
          items:
            type: string
            description: Um recurso Belvo que a instituição suporta.
            example: ACCOUNTS
          example:
            - ACCOUNTS
            - TRANSACTIONS
    EnumConsentStatus:
      type: string
      nullable: true
      enum:
        - AUTHORISED
        - AWAITING_AUTHORISATION_CONFIRMATION
        - AWAITING_AUTHORISATION
        - REJECTED
        - EXPIRED
        - null
      description: |-
        O status do consentimento na rede de open finance. Pode ser:

          - `AUTHORISED`: O consentimento ainda é válido para uso até a data de `expired_at`.
          - `AWAITING_AUTHORISATION_CONFIRMATION`: O usuário deve confirmar dentro da sua instituição.
          - `AWAITING_AUTHORISATION`: O usuário foi redirecionado para sua instituição para conceder consentimento.
          - `REJECTED`: O usuário não concedeu consentimento dentro da sua instituição.
          - `EXPIRED`: O consentimento expirou na data de `expired_at`.
          - `null`
      example: AUTHORISED
    Consents:
      type: object
      description: O esquema de consentimentos OFDA
      title: Objeto de Consentimentos (Brasil)
      x-tags:
        - Consents
      properties:
        id:
          $ref: '#/components/schemas/id'
        display_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            O nome completo do indivíduo que iniciou o consentimento, conforme
            fornecido pela instituição.
          example: Jack Oswald White
        document_number:
          type: string
          description: O número do documento (CPF) do indivíduo.
          example: '76109277673'
        belvo_institution_name:
          type: string
          description: >-
            Nome da instituição de open finance da Belvo à qual o consentimento
            está relacionado.
          example: ofmockbank_br_retail
        expired_at:
          type: string
          format: date-time
          description: >-
            O timestamp ISO-8601 quando o consentimento irá expirar. No caso de
            `undefined_consent_expiration` ser `true`, este campo será `null`.
          example: '2021-02-27T13:01:41.941Z'
        undefined_consent_expiration:
          type: boolean
          description: >-
            Indique se o consentimento é por um período indefinido, ou seja, se
            não há expiração para o consentimento.
          example: false
        created_at:
          $ref: '#/components/schemas/created_at'
        status:
          $ref: '#/components/schemas/EnumConsentStatus'
        permissions:
          type: object
          description: Detalhes sobre as permissões associadas ao consentimento.
          properties:
            ACCOUNTS:
              type: array
              description: >-
                Uma lista de permissões de open banking relacionadas ao acesso a
                informações de conta.
              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: >-
                Uma lista de permissões de open banking relacionadas ao acesso a
                informações de cartão 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: >-
                Uma lista de permissões de open banking relacionadas ao acesso a
                informações de produtos 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: >-
                Uma lista de permissões de open banking relacionadas ao acesso a
                informações pessoais.
              items:
                type: string
                example: CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ
              example:
                - CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ
                - CUSTOMERS_PERSONAL_ADITTIONALINFO_READ
            RESOURCES:
              type: array
              description: >-
                Uma lista de permissões funcionais necessárias para interagir
                com as permissões.
              items:
                type: string
                example: RESOURCES_READ
              example:
                - RESOURCES_READ
    WidgetTokenRequestOFDA:
      type: object
      title: Token de Acesso OFDA Brazil
      required:
        - id
        - password
        - scopes
        - stale_in
        - fetch_resources
        - widget
      properties:
        id:
          type: string
          description: Seu Belvo secretId.
        password:
          type: string
          description: Sua Belvo secretPassword.
        scopes:
          type: string
          description: >-
            O parâmetro scopes contém uma lista de permissões que permitem criar
            um link para o usuário. Este é um parâmetro obrigatório e deve ser
            enviado exatamente como mostrado.
          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: >-
            Uma matriz de recursos para os quais você gostaria de receber uma
            atualização histórica.


            Para instituições bancárias, você pode selecionar os seguintes
            recursos:
              - `ACCOUNTS`
              - `OWNERS`
              - `TRANSACTIONS`
              - `BILLS` (apenas para instituições OFDA do Brasil)
              - `INCOMES`
              - `RECURRING_EXPENSES`
              - `RISK_INSIGHTS`
          items:
            type: string
            enum:
              - ACCOUNTS
              - TRANSACTIONS
              - OWNERS
              - BILLS
          example:
            - ACCOUNTS
            - TRANSACTIONS
            - OWNERS
            - BILLS
        widget:
          type: object
          description: >-
            O objeto `widget` contém informações adicionais sobre como
            configurar o widget, incluindo personalização de marca, seus termos
            e condições, URLs de callback e informações sobre o usuário para o
            qual você deseja extrair dados.
          required:
            - purpose
            - openfinance_feature
            - callback_urls
            - branding
            - consent
          properties:
            purpose:
              type: string
              description: >-
                No parâmetro `purpose`, você pode personalizar a mensagem que é
                exibida ao seu usuário sobre para qual caso de uso você está
                solicitando os dados dele. Para mais informações, confira a
                seção <a
                href="https://developers.belvo.com/docs/hosted-widget-ofda#purpose"
                target="_blank">purpose</a> no nosso guia do 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: >-
                O parâmetro `openfinance_feature` indica que o usuário final
                passará pelo fluxo OFDA. Ele deve ser configurado como
                `consent_link_creation`.
              example: consent_link_creation
            callback_urls:
              type: object
              description: >-
                No objeto `callback_urls`, você **deve** adicionar links para
                onde seu usuário deve ser redirecionado nos seguintes casos:


                - success (seu usuário conectou suas contas com sucesso)

                - exit (seu usuário saiu do widget antes de completar o
                processo)

                - event (ocorreu um erro durante o processo de conexão)


                Para mais informações, confira a seção <a
                href="https://developers.belvo.com/docs/hosted-widget-ofda#callback_urls"
                target="_blank">callback_urls</a> no nosso guia do Hosted Widget
                (OFDA).


                > 📘 Eventos de Callback

                >

                > A Belvo também enviará informações adicionais sobre o evento,
                dependendo do evento. Para mais informações, certifique-se de
                conferir a seção <a
                href="https://developers.belvo.com/docs/hosted-widget-ofda#3-handling-callback-events"
                target="_blank">Handling callback events</a> do guia do Hosted
                Widget (OFDA).
              required:
                - success
                - exit
                - event
              properties:
                success:
                  type: string
                  description: >-
                    A URL para a qual o usuário é redirecionado quando conecta
                    sua conta com sucesso.
                  example: your_deeplink_here://success
                exit:
                  type: string
                  description: >-
                    A URL para a qual o usuário é redirecionado quando sai do
                    processo antes de conectar sua conta.
                  example: your_deeplink_here://exit
                event:
                  type: string
                  description: >-
                    A URL para a qual o usuário é redirecionado quando encontra
                    um erro ao conectar sua conta.
                  example: your_deeplink_here://error
            branding:
              type: object
              description: >-
                No objeto `branding`, você **deve** adicionar seu:

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


                Você também pode, opcionalmente, adicionar uma cor de fundo
                personalizada para quando o widget abrir, assim como desativar a
                mensagem da Belvo sobre quantas contas foram conectadas.


                Para mais informações sobre as opções de personalização e
                branding do widget, confira nosso <a
                href="https://developers.belvo.com/docs/branding-and-customization-ofda"
                target="_blank">guia dedicado</a>.
              required:
                - company_icon
                - company_logo
                - company_name
                - company_terms_url
              properties:
                company_icon:
                  type: string
                  format: uri
                  description: >-
                    Você pode adicionar o ícone da sua empresa ao widget para
                    alinhá-lo melhor com sua marca. Para mais informações,
                    consulte a seção <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-company-icon"
                    target="_blank">company_icon</a> do nosso guia de Branding e
                    personalização (OFDA).
                  example: https://mysite.com/icon.svg
                company_logo:
                  type: string
                  format: uri
                  description: >-
                    Você pode adicionar o logotipo da sua empresa ao widget para
                    alinhá-lo melhor com sua marca. Para mais informações,
                    consulte a seção <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-company-logo"
                    target="_blank">company_icon</a> do nosso guia de Branding e
                    personalização (OFDA).
                  example: https://mysite.com/logo.svg
                company_name:
                  type: string
                  description: >-
                    Você pode adicionar o nome da sua empresa para ser exibido
                    quando o widget for iniciado pela primeira vez. Por padrão,
                    será exibido apenas "Link your account". Quando você
                    adiciona o nome da sua empresa, a mensagem seguirá o formato
                    "[company_name] uses Belvo to connect your account". Para
                    mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-your-company-name"
                    target="_blank">company_name</a> do nosso guia de Branding e
                    personalização (OFDA).
                  example: ACME
                company_terms_url:
                  type: string
                  format: uri
                  description: >-
                    Você pode adicionar um link para sua política de privacidade
                    (ou termos e condições) na tela inicial do widget que,
                    quando clicado, redirecionará seus usuários para a página da
                    web vinculada. Isso ajuda seus usuários a entenderem melhor
                    qual é o seu caso de uso em relação aos dados que você está
                    solicitando. Para mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-link-to-your-privacy-policy"
                    target="_blank">company_terms_url</a> do nosso guia de
                    Branding e personalização (OFDA).
                  example: https://belvo.com/terms-service/
                overlay_background_color:
                  type: string
                  description: >-
                    Você pode adicionar uma cor de sobreposição personalizada
                    para quando o widget carregar em seu aplicativo desktop.
                    Para mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-a-custom-overlay-color"
                    target="_blank">overlay_background_color</a> do nosso guia
                    de Branding e personalização (OFDA).
                  example: '#F0F2F4'
                social_proof:
                  type: boolean
                  description: >-
                    Você pode optar por ocultar a mensagem "Mais de 5 milhões de
                    usuários já conectaram com segurança suas contas." que
                    aparece quando seu usuário seleciona sua instituição no
                    widget. Para mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/branding-and-customization-ofda#hide-messaging-in-the-institution-select-screen"
                    target="_blank">social_proof</a> do nosso guia de Branding e
                    personalização (OFDA).
                  example: true
            theme:
              type: array
              description: >-
                Você pode adicionar opcionalmente as cores da sua marca ao
                widget usando o parâmetro `theme`.


                Para mais informações sobre onde essas cores aparecerão no
                widget, consulte a seção dedicada <a
                href="https://developers.belvo.com/docs/branding-and-customization-ofda#add-custom-colors-to-the-widget"
                target="_blank">Adicionar cores personalizadas ao widget</a> do
                nosso guia de Branding.
              items:
                type: object
                required:
                  - css_key
                  - value
                properties:
                  css_key:
                    type: string
                    description: |-
                      Nome da variável CSS. Valores possíveis incluem:
                      - `--color-primary-base`
                      - `--nav-bar-title-color`
                      - `--nav-bar-icon-color`
                    example: '--color-primary-base'
                  value:
                    type: string
                    description: O código HEX para o `css_key`.
                    example: '#907AD6'
            consent:
              type: object
              description: >-
                O objeto `consent` é exclusivo do widget OFDA e deve ser
                enviado.
              required:
                - terms_and_conditions_url
                - permissions
                - identification_info
              properties:
                terms_and_conditions_url:
                  type: string
                  format: uri
                  description: >-
                    No parâmetro `terms_and_conditions_url`, você **deve**
                    fornecer um link para os termos e condições da sua empresa.
                  example: https://www.your_terms_and_conditions.com
                permissions:
                  type: array
                  minItems: 4
                  maxItems: 4
                  uniqueItems: true
                  description: >-
                    O parâmetro `permissions` contém os recursos que você deseja
                    extrair da Rede de Open Finance do Brasil para o usuário.
                    Este valor **deve** ser definido como `["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: >-
                    No array `identification_info`, você precisa fornecer as
                    informações de identificação do usuário para o qual deseja
                    recuperar informações. As informações fornecidas aqui devem
                    corresponder às informações que a instituição regulada
                    possui para o usuário (por exemplo, para empresas, o CPF e o
                    nome devem ser de um usuário com acesso à conta
                    empresarial).


                    - Para indivíduos, você só precisa fornecer o CPF e o nome.

                    - Para empresas, é necessário fornecer tanto o CPF quanto o
                    CNPJ.


                    Para mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/hosted-widget-ofda#identification_info"
                    target="_blank">identification_info</a> do nosso guia Hosted
                    Widget (OFDA).
                  items:
                    type: object
                    required:
                      - type
                      - number
                      - name
                    properties:
                      type:
                        type: string
                        description: O tipo de identificador. Pode ser `CPF` ou `CNPJ`.
                        example: CPF
                      number:
                        type: string
                        description: >-
                          O número de CPF ou CNPJ do indivíduo ou empresa
                          associado à identificação.
                        example: 76109277673
                      name:
                        type: string
                        description: >-
                          Nome do indivíduo ou empresa associado à
                          identificação.
                        example: Ralph Bragg
    WidgetTokenRequestBankingAggregation:
      type: object
      title: Token de Acesso de Agregação (Emprego e Fiscal)
      required:
        - id
        - password
        - scopes
        - stale_in
        - fetch_resources
        - widget
      properties:
        id:
          type: string
          description: Seu Belvo secretId.
        password:
          type: string
          description: Sua Belvo secretPassword.
        scopes:
          type: string
          description: >-
            O parâmetro scopes contém uma lista de permissões que permitem criar
            um link para o usuário. Este é um parâmetro obrigatório e deve ser
            enviado exatamente como mostrado.
          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: >-
            Uma matriz de recursos para os quais você gostaria de receber uma
            atualização histórica.


            Para instituições bancárias, você pode selecionar os seguintes
            recursos:
              - `ACCOUNTS`
              - `BALANCES`
              - `BILLS`
              - `OWNERS`
              - `INVESTMENTS`
              - `INVESTMENT_TRANSACTIONS`
              - `TRANSACTIONS`
              - `INCOMES`
              - `RECURRING_EXPENSES`
              - `RISK_INSIGHTS`

            Para instituições fiscais, você pode selecionar os seguintes
            recursos:
              - `FINANCIAL_STATEMENTS`
              - `INVOICES`
              - `TAX_COMPLIANCE_STATUS`
              - `TAX_RETENTIONS`
              - `TAX_RETURNS`
              - `TAX_STATUS`

            Para instituições de emprego, você pode selecionar os seguintes
            recursos:
              - `OWNERS`
              - `EMPLOYMENT_RECORDS` (Somente para o IMSS do México)
              - `EMPLOYMENT_METRICS` (Somente para o IMSS do México)
              - `EMPLOYMENTS` (Somente para o INSS do Brasil)
          items:
            type: string
            enum:
              - ACCOUNTS
              - TRANSACTIONS
              - OWNERS
              - BILLS
          example:
            - ACCOUNTS
            - TRANSACTIONS
            - OWNERS
            - BILLS
        widget:
          type: object
          description: >-
            O objeto `widget` contém informações adicionais sobre como
            configurar o widget, incluindo personalização de marca, seus termos
            e condições, URLs de callback e informações sobre o usuário para o
            qual você deseja extrair dados.
          required:
            - branding
            - consent
          properties:
            callback_urls:
              type: object
              description: >-
                > 📘 Apenas necessário para o Widget Hospedado.


                No objeto `callback_urls`, você **deve** adicionar links para
                onde seu usuário deve ser redirecionado nos seguintes casos:


                - success (seu usuário conectou suas contas com sucesso)

                - exit (seu usuário saiu do widget antes de completar o
                processo)

                - event (ocorreu um erro durante o processo de conexão)


                Para mais informações, confira a seção <a
                href="https://developers.belvo.com/docs/widget-for-webviews#3-handling-callback-events"
                target="_blank">callback_urls</a> no nosso guia do Widget
                Hospedado (Multi-Region).


                > 📘 Eventos de Callback

                >

                > A Belvo também enviará informações adicionais sobre o evento,
                dependendo do evento. Para mais informações, certifique-se de
                conferir a seção <a
                href="https://developers.belvo.com/docs/widget-for-webviews#3-handling-callback-events"
                target="_blank">Handling callback events</a> do guia do Widget
                Hospedado (Multi-Region).
              required:
                - success
                - exit
                - event
              properties:
                success:
                  type: string
                  description: >-
                    A URL para a qual o usuário é redirecionado quando conecta
                    sua conta com sucesso.
                  example: your_deeplink_here://success
                exit:
                  type: string
                  description: >-
                    A URL para a qual o usuário é redirecionado quando sai do
                    processo antes de conectar sua conta.
                  example: your_deeplink_here://exit
                event:
                  type: string
                  description: >-
                    A URL para a qual o usuário é redirecionado quando encontra
                    um erro ao conectar sua conta.
                  example: your_deeplink_here://error
            branding:
              type: object
              description: >-
                No objeto `branding`, você **deve** adicionar seu:

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


                Você também pode, opcionalmente, adicionar uma cor de fundo
                personalizada para quando o widget abrir, assim como desativar a
                mensagem da Belvo sobre quantas contas foram conectadas.


                Para mais informações sobre as opções de personalização e
                branding do widget, confira nosso <a
                href="https://developers.belvo.com/docs/widget-branding-and-customization"
                target="_blank">guia dedicado</a>.
              required:
                - company_icon
                - company_logo
                - company_name
                - company_terms_url
              properties:
                company_icon:
                  type: string
                  format: uri
                  description: >-
                    Você pode adicionar o ícone da sua empresa ao widget para
                    que ele fique mais alinhado com sua marca. Para mais
                    informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-company-icon"
                    target="_blank">company_icon</a> do nosso guia de Branding e
                    personalização (Multi-Region).
                  example: https://mysite.com/icon.svg
                company_logo:
                  type: string
                  format: uri
                  description: >-
                    Você pode adicionar o logotipo da sua empresa ao widget para
                    que ele fique mais alinhado com sua marca. Para mais
                    informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-company-logo"
                    target="_blank">company_icon</a> do nosso guia de Branding e
                    personalização (Multi-Region).
                  example: https://mysite.com/logo.svg
                company_name:
                  type: string
                  description: >-
                    Você pode adicionar o nome da sua empresa para ser exibido
                    quando o widget for iniciado pela primeira vez. Por padrão,
                    ele exibirá apenas "Link your account". Quando você adiciona
                    o nome da sua empresa, a mensagem seguirá o formato
                    "[company_name] uses Belvo to connect your account". Para
                    mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-your-company-name"
                    target="_blank">company_name</a> do nosso guia de Branding e
                    personalização (Multi-Region).
                  example: ACME
                company_terms_url:
                  type: string
                  format: uri
                  description: >-
                    Você pode adicionar um link para sua política de privacidade
                    (ou termos e condições) na tela inicial do widget que,
                    quando clicado, redirecionará seus usuários para a página da
                    web vinculada. Isso ajuda seus usuários a entenderem melhor
                    qual é o seu caso de uso em relação aos dados que você está
                    solicitando. Para mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-link-to-your-privacy-policy"
                    target="_blank">company_terms_url</a> do nosso guia de
                    Branding e personalização (Multi-Region).
                  example: https://belvo.com/terms-service/
                overlay_background_color:
                  type: string
                  description: >-
                    Você pode adicionar uma cor de sobreposição personalizada
                    para quando o widget carregar em seu aplicativo desktop.
                    Para mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#add-a-custom-overlay-color"
                    target="_blank">overlay_background_color</a> do nosso guia
                    de Branding e personalização (Multi-Region).
                  example: '#F0F2F4'
                social_proof:
                  type: boolean
                  description: >-
                    Você pode optar por ocultar a mensagem "Mais de 5 milhões de
                    usuários já conectaram com segurança suas contas." que
                    aparece quando seu usuário seleciona sua instituição no
                    widget. Para mais informações, consulte a seção <a
                    href="https://developers.belvo.com/docs/widget-branding-and-customization#hide-messaging-in-the-account-connect-screen"
                    target="_blank">social_proof</a> do nosso guia de Branding e
                    personalização (Multi-Region).
                  example: true
            theme:
              type: array
              description: >-
                Você pode, opcionalmente, adicionar as cores da sua marca ao
                widget usando o parâmetro `theme`.


                Para mais informações sobre onde essas cores aparecerão no
                widget, consulte a seção dedicada <a
                href="https://developers.belvo.com/docs/widget-branding-and-customization#add-custom-colors-to-the-widget"
                target="_blank">Adicionar cores personalizadas ao widget</a> do
                nosso guia de Branding.
              items:
                type: object
                required:
                  - css_key
                  - value
                properties:
                  css_key:
                    type: string
                    description: |-
                      Nome da variável CSS. Valores possíveis incluem:
                      - `--color-primary-base`
                      - `--nav-bar-title-color`
                      - `--nav-bar-icon-color`
                    example: '--color-primary-base'
                  value:
                    type: string
                    description: O código HEX para o `css_key`.
                    example: '#907AD6'
    WidgetToken:
      type: object
      properties:
        access:
          type: string
          description: O token de acesso a ser usado para autenticar o widget.
          example: >-
            eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI3MzYwMTk1LCJpYXQiOjE3MjczNTg5OTUsImp0aSI6ImRhN2Q3OTM1ZDZlZTQ0MTBhYTMwYTc3NWQ1OWMxZWIzIiwidXNlcl9pZCI6IjZlOWJlODg0LTQ3ODEtNDE0My1iNjczLWFjYTAyNDc1ZWU4YyIsIm9yZ2FuaXphdGlvbl9uYW1lIjoiRG9taW5payBDaG9sZXdza2kncyB0ZWFtIiwib3JnYW5pemF0aW9uX2lkIjoiNmU5YmU4ODQtNDc4MS00MTQzLWI2NzMtYWNhMDI0NzVlZThjIiwic2NvcGVzIjpbInJlYWRfaW5zdGl0dXRpb25zIiwid3JpdGVfbGlua3MiXSwiZW52aXJvbm1lbnQiOiJzYW5kYm94IiwiYXBpX3VybCI6InNhbmRib3guYmVsdm8uY29tIiwiY3JlZGVudGlhbHNfc3RvcmFnZSI6IjMwZCIsInN0YWxlX2luIjoiMzY1ZCIsImZldGNoX3Jlc291cmNlcyI6WyJPV05FUlMiLCJFTVBMT1lNRU5UUyJdLCJpc3MiOiJzYW5kYm94LmJlbHZvLmNvbSJ9.DaQ8xVTEjA4BD-0SbBCQDylO3NrjhsHiWXTaoPdKWRucS2E0jxNUHC5lwrejrz73-GytgcXTeiI1fhZBYW719A
        refresh:
          type: string
          description: O token de atualização a ser usado para autenticar o widget.
          example: >-
            eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MjM0OTQzODk5NSwiaWF0IjoxNzI3MzU4OTk1LCJqdGkiOiI2YmUyMGFmNTcxZDU0NjQzYjA0Y2U3YTVhNjI5ZDRiMSIsInVzZXJfaWQiOiI2ZTliZTg4NC00NzgxLTQxNDMtYjY3My1hY2EwMjQ3NWVlOGMiLCJvcmdhbml6YXRpb25fbmFtZSI6IkRvbWluaWsgQ2hvbGV3c2tpJ3MgdGVhbSIsIm9yZ2FuaXphdGlvbl9pZCI6IjZlOWJlODg0LTQ3ODEtNDE0My1iNjczLWFjYTAyNDc1ZWU4YyIsInNjb3BlcyI6WyJyZWFkX2luc3RpdHV0aW9ucyIsIndyaXRlX2xpbmtzIl0sImVudmlyb25tZW50Ijoic2FuZGJveCIsImFwaV91cmwiOiJzYW5kYm94LmJlbHZvLmNvbSIsImNyZWRlbnRpYWxzX3N0b3JhZ2UiOiIzMGQiLCJzdGFsZV9pbiI6IjM2NWQiLCJmZXRjaF9yZXNvdXJjZXMiOlsiT1dORVJTIiwiRU1QTE9ZTUVOVFMiXSwiaXNzIjoic2FuZGJveC5iZWx2by5jb20ifQ.T-tnX2BwAjQI0MaYCO686bZD6H7EMIgi_CbOWtHDexGIiTKLer0d7RJGisXJqM6oA_L4y_A_774LEj8NNb7YXQ
    link:
      type: string
      nullable: true
      format: uuid
      description: O `link.id` ao qual os dados pertencem.
      example: 30cb4806-6e00-48a4-91c9-ca55968576c8
    InstitutionAccount:
      type: object
      description: Detalhes sobre a instituição.
      properties:
        name:
          type: string
          example: erebor_mx_retail
          description: O nome da instituição, conforme designado pela Belvo.
        type:
          $ref: '#/components/schemas/EnumInstitutionType'
    collected_at:
      type: string
      format: date-time
      description: O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
      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: |-
        O tipo de conta.  
        Retornamos um dos seguintes valores do 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: >-
            O limite de cheque especial acordado entre o titular da conta e a
            instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `overdraft` estiver disponível.
          example: 5000.5
        used:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor do cheque especial utilizado.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `overdraft` estiver disponível.
          example: 1000.5
        unarranged:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O cheque especial utilizado que não foi acordado entre o titular da
            conta e a instituição.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `overdraft` estiver disponível.
          example: 300.1
    AccountBalanceOpenFinanceBrazil:
      type: object
      required:
        - current
      description: Detalhes sobre os saldos atual e disponível para a conta.
      properties:
        current:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O saldo atual é calculado de maneira diferente de acordo com o tipo
            de conta.


            - **💰 Contas correntes e poupança**:


            O saldo da conta do usuário no timestamp `collected_at`.


            - **💳 Cartões de crédito**:


            O valor que o usuário gastou no período de faturamento atual do
            cartão (consulte `credit_data.cutting_date` para informações sobre
            quando o período de faturamento atual termina).


            - **🏡 Contas de empréstimo**:


            O valor restante a pagar no empréstimo do usuário.
          example: 5874.13
        available:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O saldo que o titular da conta pode usar.


            - **💰 Contas correntes e poupança**:


            O saldo disponível pode ser diferente do saldo `current` devido a
            transações pendentes.


            - **💳 Cartões de crédito**:


            O valor de crédito que o usuário ainda tem disponível para o período
            atual. O valor é calculado como `credit_data.credit_limit` menos
            `balance.current`.


            - **🏡 Contas de empréstimo**:


            O valor presente necessário para quitar o empréstimo, conforme
            fornecido pela instituição.


            **Nota:** Se a instituição não fornecer esse valor, retornamos
            `null`.
          example: 5621.12
        blocked:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor que está atualmente bloqueado devido a transações pendentes.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `balances` estiver disponível.
          example: 60.32
        automatically_invested:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor que é automaticamente investido (conforme acordado com a
            instituição).


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `balances` estiver disponível.
          example: 131.5
    EnumCreditCardLimitType:
      type: string
      enum:
        - TOTAL_LIMIT
        - MODAL_LIMIT
      description: |-
        O tipo de limite. Retornamos um dos seguintes valores:

          - `TOTAL_LIMIT`
          - `MODAL_LIMIT`

          > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil.
      example: TOTAL_LIMIT
    AccountCreditDataLimitsOpenFinanceBrazil:
      type: object
      description: >-
        Informações detalhadas sobre os limites de crédito para os cartões de
        crédito.


        > **Non-nullable:** Um valor deve ser retornado pela rede de open
        finance do Brasil.
      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: >-
            O número do cartão de crédito.


            **Nota:** Frequentemente, são apenas os últimos quatro dígitos do
            cartão de crédito.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '4453'
        credit_limit:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O limite do cartão de crédito.
          example: 1000.04
        used_amount:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: A quantidade utilizada.
          example: 400.04
        available_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor ainda disponível.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: 600
        is_limit_flexible:
          type: boolean
          description: >-
            Boolean para indicar se o `credit_limit` é flexível.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: false
        type:
          $ref: '#/components/schemas/EnumCreditCardLimitType'
        consolidation_type:
          type: string
          description: >-
            Indica se o limite de crédito é consolidado ou individual.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: INDIVIDUAL
        line_name:
          type: string
          nullable: true
          description: O nome da linha de limite de crédito.
          example: CREDITO_A_VISTA
        line_name_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: '[\w\W\s]*'
          description: Informações adicionais sobre o nome da linha.
          example: Informações adicionais e complementares
    EnumAccountCreditCardNetwork:
      type: string
      enum:
        - VISA
        - MASTERCARD
        - AMERICAN_EXPRESS
        - DINERS_CLUB
        - HIPERCARD
        - BANDEIRA_PROPRIA
        - CHEQUE_ELETRONICO
        - ELO
        - OTHER
      description: >-
        A rede de crédito à qual o cartão está associado. Retornamos um dos
        seguintes valores:

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

          > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil.
      example: MASTERCARD
    AccountCreditDataCardsOpenFinanceBrazil:
      type: object
      required:
        - is_multiple
        - identification_number
      description: Detalhes sobre todos os cartões associados à conta.
      properties:
        is_multiple:
          type: boolean
          description: >-
            Boolean para indicar se esta conta possui múltiplos cartões de
            crédito.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: false
        identification_number:
          type: string
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: >-
            O número do cartão de crédito.


            **Nota:** Frequentemente, são apenas os últimos quatro dígitos do
            cartão de crédito.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '4453'
    AccountCreditDataOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - collected_at
        - credit_limit
      description: Detalhes sobre os cartões de crédito associados a esta conta.
      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: >-
            O limite de crédito superior do cartão.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: A data de vencimento da fatura do cartão 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: >-
            O valor mínimo que o proprietário da conta precisa pagar no período
            de crédito atual.
          example: 2400.3
        network:
          $ref: '#/components/schemas/EnumAccountCreditCardNetwork'
        network_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: '[\w\W\s]*'
          description: Informações adicionais sobre a rede de cartão de crédito.
          example: It's an orange card.
        cards:
          type: array
          minItems: 1
          description: Detalhes sobre os cartões associados à conta.
          items:
            $ref: '#/components/schemas/AccountCreditDataCardsOpenFinanceBrazil'
        next_payment_date:
          type: string
          nullable: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        no_interest_payment:
          type: number
          nullable: true
          format: float
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        interest_rate:
          type: number
          nullable: true
          format: float
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        monthly_payment:
          type: number
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        last_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
    EnumAccountLoanDataInterestRateType:
      type: string
      enum:
        - MONTHLY
        - YEARLY
      description: >-
        O período em que o juro é aplicado ao empréstimo.


        > **Não anulável:** Um valor deve ser retornado pela rede de open
        finance do Brasil.
      example: MONTHLY
    EnumAccountLoanDataInterestRateDataTaxType:
      type: string
      enum:
        - NOMINAL
        - EFFECTIVE
      description: >-
        O tipo de imposto sobre a taxa de juros. Retornamos um dos seguintes
        valores:

          - `NOMINAL`
          - `EFFECTIVE`
          
          > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil.
      example: NOMINAL
    EnumAccountLoanDataInterestRateDataRateType:
      type: string
      enum:
        - SIMPLE
        - COMPOUND
      description: |-
        O tipo de taxa de juros. Retornamos um dos seguintes valores:

          - `SIMPLE`
          - `COMPOUND`

          > **Non-nullable:** Um valor deve ser retornado pela rede de open finance do Brasil.
      example: SIMPLE
    EnumAccountLoanDataInterestRateDataReferenceIndexType:
      type: string
      enum:
        - WITHOUT_INDEX_TYPE
        - PRE_FIXED
        - POST_FIXED
        - FLOATING
        - INDEXED_PRICE
        - RURAL_CREDIT
        - OTHER_INDEX
      description: |-
        A taxa de índice de referência. Retornamos um dos seguintes valores:

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

          > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil.
      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: Informações detalhadas sobre a taxa de juros.
      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: >-
            O cálculo base para a taxa de juros.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: 30/360
        reference_index_type:
          $ref: >-
            #/components/schemas/EnumAccountLoanDataInterestRateDataReferenceIndexType
        reference_index_subtype:
          type: string
          nullable: true
          description: O subtipo da taxa de índice de referência.
          example: TR_TBF
        reference_index_info:
          type: string
          nullable: true
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: Informações adicionais sobre a taxa de índice de referência.
          example: Additional information
        pre_fixed_rate:
          type: number
          format: float
          pattern: ^[01]\.\d{6}$
          description: >-
            A taxa de juros com percentual prefixado.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: 0.062
        post_fixed_rate:
          type: number
          format: float
          pattern: ^[01]\.\d{6}$
          description: >-
            A taxa de juros com percentual pós-fixado.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: 0.062
        additional_info:
          type: string
          nullable: true
          maxLength: 1200
          pattern: '[\w\W\s]*'
          description: Informações adicionais sobre a taxa de juros.
          example: Additional information
    AccountLoanDataInterestRateOpenFinanceBrazil:
      type: object
      required:
        - name
        - type
        - value
        - interest_rate_data
      description: >-
        Detalhamento dos juros aplicados ao empréstimo. Com o OF Brasil,
        recomendamos fortemente o uso do objeto `interest_rate_data` para obter
        informações detalhadas.


        > **Non-nullable:** Um valor deve ser retornado pela rede de open
        finance do Brasil.
      properties:
        name:
          type: string
          nullable: true
          description: >-
            O nome do tipo de taxa de juros aplicada ao empréstimo.


            **Nota:** Para OFDA Brasil, recomendamos que você use o parâmetro
            `interest_date_data.tax_type`.
          example: NOMINAL
        type:
          $ref: '#/components/schemas/EnumAccountLoanDataInterestRateType'
        value:
          type: number
          nullable: true
          format: float
          description: >-
            A taxa de juros (em porcentagem ou valor monetário).


            **Nota:** Para OFDA Brasil, recomendamos que você use os parâmetros
            `interest_date_data.pre_fixed_rate` e
            `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 não se aplica ao OF Brasil e retornará null.'
      example: null
    EnumAccountLoanDataFeeChargeType:
      type: string
      enum:
        - SINGLE
        - PER_INSTALLMENT
      description: |-
        Indica o tipo de cobrança. Retornamos um dos seguintes valores:

          - `SINGLE`
          - `PER_INSTALLMENT`

           > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil se o campo `fees` estiver disponível.
      example: SINGLE
    EnumAccountLoanDataFeeCharge:
      type: string
      enum:
        - MINIMUM
        - MAXIMUM
        - FIXED
        - PERCENTAGE
      description: >-
        Método de cobrança, conforme acordado com a instituição. Retornamos um
        dos seguintes valores:

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

           > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil se o campo `fees` estiver disponível.
      example: FIXED
    AccountLoanDataFeesOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - type
        - value
        - name
        - code
        - fee_charge_type
        - fee_charge
        - rate
      description: Detalhamento das taxas aplicadas ao empréstimo.
      properties:
        type:
          $ref: '#/components/schemas/EnumAccountLoanDataFeeType'
        value:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor total da taxa. Mesma moeda do empréstimo.
          example: 5.6
        name:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: |-
            O nome da taxa.

             > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil se o campo `fees` estiver disponível.
          example: Renovação de cadastro
        code:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: |-
            O código de tarifa.

             > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil se o campo `fees` estiver disponível.
          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: >-
            A taxa percentual da tarifa. Necessária quando `fee_charge` está
            definido como `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: |-
        O tipo de cobrança contratada. Retornamos um dos seguintes valores:

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

          > **Não anulável:** Um valor deve ser retornado pela rede de open finance do Brasil se o campo `contracted_charges` estiver disponível.
      example: LATE_PAYMENT_INTEREST_FEE
    AccountLoanDataContractedChargesOpenFinanceBrazil:
      type: object
      nullable: true
      description: Detalhes sobre quaisquer encargos contratados.
      properties:
        type:
          $ref: '#/components/schemas/EnumAccountLoanDataContractedChargeType'
        info:
          type: string
          nullable: true
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: Informações adicionais sobre a cobrança contratada.
          example: Late fee
        rate:
          type: number
          nullable: true
          format: float
          pattern: ^[01]\.\d{6}$
          description: >-
            A taxa percentual da cobrança, calculada com base no valor do
            empréstimo.
          example: 0.062
    AccountLoanDataCollateralsOpenFinanceBrazil:
      type: object
      nullable: true
      description: >-
        Detalhes sobre quaisquer garantias de empréstimo que o indivíduo ou
        empresa forneceu.
      required:
        - type
        - subtype
        - currency
        - amount
      properties:
        type:
          type: string
          description: >-
            O tipo de garantia, conforme definido pela instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `collaterals` estiver disponível.
          example: OPERACOES_GARANTIDAS_PELO_GOVERNO
        subtype:
          type: string
          description: >-
            O subtipo da garantia, conforme definido pela instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `collaterals` estiver disponível.
          example: CCR_CONVENIO_CREDITOS_RECIPROCOS
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            O código de moeda de três letras (ISO-4217).


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `collaterals` estiver disponível.
          example: BRL
        amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor total da fatura.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `collaterals` estiver disponível.
          example: 45391.89
    AccountLoanDataBalloonPaymentsOpenFinanceBrazil:
      type: object
      nullable: true
      description: >-
        Informações detalhadas sobre quaisquer pagamentos de balloon para o
        empréstimo, se aplicável.
      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: >-
            A data em que o pagamento do balloon deve ser efetuado, no formato
            `YYYY-MM-DD`.
          example: '2021-09-06'
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: O código de moeda de três letras (ISO-4217).
          example: BRL
        amount:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor total do pagamento final.
          example: 45391.89
    EnumAccountsLoanDataContractInstallmentFrequency:
      type: string
      nullable: true
      enum:
        - DAY
        - WEEK
        - MONTH
        - YEAR
        - NO_DEADLINE_REMAINING
        - null
      description: >-
        A frequência dos pagamentos parcelados contratados, conforme definido
        quando o contrato foi assinado pela primeira vez. Retornamos um dos
        seguintes:

          - `DAY`
          - `WEEK`
          - `MONTH`
          - `YEAR`
          - `NO_DEADLINE_REMAINING`
          - `null`
      example: MONTH
    EnumAccountLoanDataInstallmentFrequency:
      type: string
      enum:
        - IRREGULAR
        - WEEKLY
        - FORTNIGHTLY
        - MONTHLY
        - BIMONTHLY
        - QUARTERLY
        - BIANNUALLY
        - ANNUALLY
        - OTHER
      description: >-
        A frequência com que as parcelas são pagas. Retornamos um dos seguintes
        valores:

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

          > **Non-nullable:** Um valor deve ser retornado pela rede de open finance do Brasil.
      example: MONTHLY
    EnumAccountLoanDataContractRemainingFrequency:
      type: string
      nullable: true
      enum:
        - DAY
        - WEEK
        - MONTH
        - YEAR
        - NO_DEADLINE_REMAINING
        - null
      description: >-
        A frequência dos pagamentos das parcelas restantes contratadas, conforme
        definido quando o contrato foi assinado pela primeira vez. Retornamos um
        dos seguintes 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: As opções de empréstimo associadas a esta conta.
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        loan_code:
          type: string
          minLength: 22
          maxLength: 67
          pattern: ^\d{22,67}$
          description: >-
            O número de contrato padronizado específico do país.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '92792126019929279212650822221989319252576'
        contract_amount:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor total inicial do empréstimo quando o contrato foi assinado,
            calculado pela instituição. Este valor inclui o principal + juros +
            impostos + taxas.
          example: 202000
        total_effective_cost:
          type: number
          nullable: true
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O custo efetivo total inicial do empréstimo.
          example: 209000
        loan_type:
          type: string
          description: >-
            O tipo do empréstimo, de acordo com a instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: HOME_EQUITY
        outstanding_balance:
          type: number
          nullable: true
          format: float
          minLength: 4
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor restante a pagar no total, incluindo juros.
          example: 182000
        interest_rates:
          type: array
          description: >-
            Detalhamento dos juros aplicados ao empréstimo. Com o OF Brasil,
            recomendamos fortemente o uso das informações em
            `interest_rate_data` para obter informações detalhadas.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            $ref: '#/components/schemas/AccountLoanDataInterestRateOpenFinanceBrazil'
        fees:
          type: array
          nullable: true
          description: Detalhamento das taxas aplicadas ao empréstimo.
          items:
            $ref: '#/components/schemas/AccountLoanDataFeesOpenFinanceBrazil'
        contracted_charges:
          type: array
          nullable: true
          description: >-
            Parece que você não forneceu nenhum texto para tradução. Por favor,
            envie o texto que deseja que eu traduza do inglês para o português
            (Brasil).
          items:
            $ref: >-
              #/components/schemas/AccountLoanDataContractedChargesOpenFinanceBrazil
        collaterals:
          type: array
          nullable: true
          description: >-
            Detalhes sobre quaisquer garantias de empréstimo que o indivíduo ou
            empresa forneceu.
          items:
            $ref: '#/components/schemas/AccountLoanDataCollateralsOpenFinanceBrazil'
        balloon_payments:
          type: array
          nullable: true
          description: >-
            Informações detalhadas sobre quaisquer pagamentos de balloon para o
            empréstimo, se aplicável.
          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: Informações adicionais sobre o `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: >-
            A data em que a primeira parcela do empréstimo deve ser paga, no
            formato `YYYY-MM-DD`.
          example: '2020-03-01'
        number_of_installments_total:
          type: integer
          nullable: true
          format: int32
          maximum: 999999999
          description: O número total de parcelas necessárias para quitar o empréstimo.
          example: 60
        number_of_installments_outstanding:
          type: integer
          nullable: true
          format: int32
          maximum: 999999999
          description: O número de parcelas restantes a pagar.
          example: 48
        number_of_installments_paid:
          type: integer
          nullable: true
          format: int32
          maximum: 999999999
          description: O número de parcelas já pagas.
          example: 32
        number_of_installments_past_due:
          type: integer
          nullable: true
          format: int32
          maximum: 999
          description: O número de parcelas que estão em atraso.
          example: 2
        disbursement_dates:
          type: array
          nullable: true
          minItems: 1
          description: Um array de datas em que o empréstimo foi desembolsado.
          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: >-
              A data em que o empréstimo foi desembolsado, no 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: A data em que o empréstimo foi liquidado, no 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: >-
            A data em que o contrato de empréstimo foi assinado, no formato
            `YYYY-MM-DD`.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do 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: >-
            A data em que se espera que o empréstimo seja concluído, no 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: O número total de parcelas restantes no empréstimo.
          example: 20
        amortization_schedule:
          type: string
          description: >-
            O cronograma de amortização do empréstimo.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: SEM_SISTEMA_AMORTIZACAO
        amortization_schedule_info:
          type: string
          nullable: true
          maxLength: 200
          pattern: '[\w\W\s]*'
          description: Informações adicionais sobre o `amortization_schedule`.
          example: No need for a schedule.
        consignee_id:
          type: string
          nullable: true
          maxLength: 14
          pattern: ^\d{14}$
          description: O ID do consignatário do empréstimo.
          example: '60500998000135'
        contract_number:
          type: string
          nullable: true
          minLength: 1
          maxLength: 100
          pattern: ^\d{1,100}$
          description: >-
            O número do contrato do empréstimo, conforme fornecido pela
            instituição.
          example: '1324926521496'
        monthly_payment:
          type: number
          nullable: true
          format: float
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        principal:
          type: number
          nullable: true
          format: float
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        payment_day:
          type: string
          nullable: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        outstanding_principal:
          type: number
          nullable: true
          format: float
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        credit_limit:
          type: number
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        last_period_balance:
          type: number
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        interest_rate:
          type: number
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        limit_day:
          type: string
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        cutting_day:
          type: string
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        cutting_date:
          type: string
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        last_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        no_interest_payment:
          type: number
          nullable: true
          deprecated: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
    AccountOpenFinanceBrazil:
      type: object
      nullable: true
      title: Objeto Account (OFDA Brasil)
      x-tags:
        - Accounts
      description: Detalhes sobre a conta.
      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 se esta conta é um `ASSET` ou um `LIABILITY`. Você pode
            considerar o saldo de um `ASSET` como positivo, enquanto o saldo de
            um `LIABILITY` como negativo.
          example: ASSET
        overdraft:
          $ref: '#/components/schemas/AccountOverdraftOpenFinanceBrazil'
        type:
          type: string
          description: >-
            O tipo de conta, conforme designado pela instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: STANDARD_NACIONAL
        subtype:
          type: string
          description: >-
            O subtipo de conta, conforme designado pela instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: FINANCIAMENTO_HABITACIONAL_SFH
        name:
          type: string
          nullable: true
          description: O nome da conta, conforme fornecido pela instituição.
          example: Cuenta Perfiles- M.N. - MXN-666
        number:
          type: string
          nullable: true
          description: O número da conta, conforme designado pela instituição.
          example: '4057068115181'
        agency:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: O código da agência onde o produto foi aberto.
          example: '6272'
        check_digit:
          type: string
          nullable: true
          maxLength: 2
          pattern: '[\w\W\s]*'
          description: O dígito verificador do número do produto, se aplicável.
          example: '7'
        balance:
          $ref: '#/components/schemas/AccountBalanceOpenFinanceBrazil'
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            O código de moeda de três letras (ISO-4217).


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `balances` estiver disponível.
          example: BRL
        public_identification_name:
          type: string
          nullable: true
          description: >-
            O nome público para o tipo de identificação. Para contas de poupança
            e corrente brasileiras 🇧🇷, este campo será `AGENCY/ACCOUNT`.
          example: AGENCY/ACCOUNT
        public_identification_value:
          type: string
          nullable: true
          description: >-
            O valor para o `public_identification_name`.


            Para contas de poupança e corrente 🇧🇷 OFDA brasileiras, este campo
            será o número da agência e da conta bancária, separados por uma
            barra. Por exemplo: `0444/45722-0`.


            Para contas de cartão de crédito 🇧🇷 OFDA brasileiras, retornaremos
            uma string de números de cartão de crédito concatenados associados à
            conta. Por exemplo: "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: >-
            A identificação interna da instituição para a conta.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `balances` estiver disponível.
          example: '92792126019929279212650822221989319252576'
        credit_data:
          $ref: '#/components/schemas/AccountCreditDataOpenFinanceBrazil'
        loan_data:
          $ref: '#/components/schemas/AccountLoanDataOpenFinanceBrazil'
        funds_data:
          type: string
          nullable: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
    link_request:
      type: string
      format: uuid
      description: O `link.id` para o qual você deseja recuperar informações.
      example: c81a1dea-6dd6-4999-8b9f-541ee8197058
    BalanceOFDA:
      type: object
      title: Objeto de Balanço (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: >-
            O identificador único criado pela Belvo usado para referenciar o
            saldo atual.
          example: 0b94bdf9-3719-43a9-81e7-be95d2318595
        link:
          type: string
          format: uuid
          description: O identificador único do link ao qual este saldo pertence.
          example: 0b94bdf9-3719-43a9-81e7-be95d2318595
        account_id:
          type: string
          format: uuid
          description: O `account.id` do Belvo ao qual este saldo pertence.
          example: c4bfecf9-4eb6-4920-9f9f-e1f1e60ef321
        account_internal_identification:
          type: string
          maxLength: 50
          description: A identificação interna da instituição para a conta.
          example: '92792126019929279212650822221989319252576'
        collected_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 quando o ponto de dados foi
            coletado.
          example: '2024-05-21T08:32:00Z'
        created_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 de quando o ponto de dados foi
            criado no banco de dados da Belvo.
          example: '2024-05-21T08:32:00Z'
        last_updated_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 de quando este saldo foi atualizado
            pela última vez pela instituição.


            > 🚧 Aviso

            >

            > O parâmetro `last_updated_at` depende de como a instituição
            processa (ou armazena) os dados. No caso de a instituição armazenar
            dados de forma síncrona (ou seja, assim que uma transação ocorre, o
            saldo é atualizado), então o `last_updated_at` refletirá o saldo em
            tempo quase real. No caso de a instituição armazenar dados de forma
            assíncrona (ou seja, ela recupera dados em lote e depois atualiza o
            saldo), as informações de saldo podem se referir a horas ou dias
            atrás. Além disso, no caso de a instituição não conseguir fornecer o
            horário específico (devido a um erro interno), a instituição pode
            fornecer um horário geral em que atualizou pela última vez as
            informações da conta e do saldo.
          example: '2021-05-21T08:30:00Z'
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: O código de moeda de três letras (ISO-4217).
          example: USD
        available:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          minimum: 0
          description: O saldo disponível da conta.
          example: 1000.02
        blocked:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          minimum: 0
          description: >-
            O valor que está atualmente bloqueado devido, por exemplo, a
            transações pendentes.
          example: 1000.02
        automatically_invested:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          minimum: 0
          description: >-
            O valor que é automaticamente investido (conforme acordado com a
            instituição).
          example: 1000.02
    account_id:
      type: string
      format: uuid
      description: O `account.id` do Belvo para o qual você deseja recuperar informações.
      example: e2cdb621-f44a-4558-89f6-8ab2a57add7a
    TransactionMerchantData:
      type: object
      nullable: true
      description: >-
        Dados adicionais sobre o comerciante envolvido na transação.

        Nós só retornamos informações do comerciante para novas transações
        feitas a partir de contas *corrente* ou *cartão de crédito*.

        > **Obter informações do comerciante**
         Recuperamos as informações do comerciante para uma transação como parte do nosso produto de <a href="https://developers.belvo.com/docs/banking#categorizing-transactions" target="_blank">Categorização de Transações</a>, transformando dados brutos em insights acionáveis. Para habilitar este produto, basta <a href="https://belvo.com/contact/?utm_source=documentation" target="_blank">entrar em contato</a> conosco, e nós cuidaremos disso imediatamente.
      properties:
        logo:
          type: string
          nullable: true
          description: A URL para o logotipo do comerciante.
          example: https://logo.clearbit.com/asesor-contable.es
        website:
          type: string
          nullable: true
          description: A URL para o site do comerciante.
          example: https://merchants-r-us.com
        merchant_name:
          type: string
          description: O nome do 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: >-
        O nome da categoria de transação.


        > **Obter categorização de transações**

        Com a <a
        href="https://developers.belvo.com/docs/banking#categorizing-transactions"
        target="_blank">categorização de transações</a>, limpamos e
        categorizamos transações para você, transformando dados brutos em
        insights acionáveis. Para habilitar esse recurso, basta <a
        href="https://belvo.com/contact/?utm_source=documentation"
        target="_blank">entrar em contato</a> conosco, e nós cuidaremos disso.


        Retornamos um dos seguintes 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 clientes que não utilizam nosso produto de Categorização de Transações, retornamos `null` em vez disso.
      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: >-
        A subcategoria da transação.


        > **Obter categorização de transações**  

        Para clientes que não utilizam nossa <a
        href="https://developers.belvo.com/docs/banking#categorizing-transactions"
        target="_blank">Categorização de Transações</a>, retornamos `null` em
        vez disso. Para habilitar este recurso, basta <a
        href="https://belvo.com/contact/?utm_source=documentation"
        target="_blank">entrar em contato</a> conosco, e nós cuidaremos disso.


        Retornamos um dos seguintes 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: >-
        A direção da transação:

        - `INFLOW` indica dinheiro entrando na conta.

        - `OUTFLOW` indica dinheiro saindo da conta.

        - `null` quando não há informações presentes sobre a direção da
        transação.
      example: INFLOW
    EnumTransactionStatus:
      type: string
      nullable: true
      enum:
        - PENDING
        - PROCESSED
        - UNCATEGORIZED
        - null
      description: |-
        O status da transação. Retornamos um dos seguintes valores:

          - `PROCESSED` (A transação foi processada pela instituição.)
          - `PENDING` (A instituição declara claramente que a transação ainda não foi processada.)
          - `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: >-
        A taxa que pode ser cobrada por uma transação com cartão. Retornamos um
        dos seguintes 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: >-
        Outros tipos de crédito que foram contratados no cartão. Retornamos um
        dos seguintes valores:

          - `REVOLVING_CREDIT`
          - `BILL_INSTALLMENT_PAYMENT`
          - `LOAN`
          - `OTHERS`
          - `null`
      example: BILL_INSTALLMENT_PAYMENT
    TransactionCreditCardBill:
      type: object
      nullable: true
      description: Informações sobre a fatura em que esta transação aparece.
      properties:
        id:
          type: string
          format: uuid
          description: >-
            O identificador único criado pela Belvo usado para referenciar a
            fatura atual do cartão de crédito.


            > **Nota**: Este campo é retornado apenas para faturas 'closed' (o
            que significa que o período de faturamento terminou e a fatura foi
            emitida). Se o período de faturamento ainda estiver em andamento,
            retornamos `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: >-
            O identificador interno da instituição para a fatura.


            > **Nota**: Este campo é retornado apenas para faturas 'closed' (o
            que significa que o período de faturamento foi encerrado e a fatura
            foi emitida). Se o período de faturamento ainda estiver em
            andamento, retornamos `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: >-
        Dados adicionais fornecidos pela instituição para transações com cartão
        de crédito.
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        bill_name:
          type: string
          nullable: true
          description: >-
            O título da fatura mensal do cartão de crédito à qual a transação
            pertence. O formato do valor retornado é específico da instituição,
            no entanto, alguns exemplos comuns são:


            - diciembre-2021

            - dec-2021

            - dec-21


            > **Nota**: Este campo é retornado apenas para faturas 'fechadas' (o
            que significa que o período de faturamento terminou e a fatura foi
            emitida). Se o período de faturamento ainda estiver em andamento,
            retornamos `null`.
          example: apr-2020
        bill_due_date:
          type: string
          nullable: true
          format: date
          description: >-
            A data em que a fatura deve ser paga, no formato `YYYY-MM-DD`.


            > **Nota**: Este campo é retornado apenas para faturas 'fechadas' (o
            que significa que o período de faturamento terminou e a fatura foi
            emitida). Se o período de faturamento ainda estiver em andamento,
            retornamos `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: >-
            O identificador interno da instituição para a fatura.


            > **Nota**: Este campo é retornado apenas para faturas 'closed' (o
            que significa que o período de faturamento foi encerrado e a fatura
            foi emitida). Se o período de faturamento ainda estiver em
            andamento, retornamos `null`.
          example: 927921260199292792126508222219893192525A6
        bill_status:
          type: string
          nullable: true
          description: >-
            **Nota:** Este campo não se aplica ao OFDA Brasil e retornará
            `null`.
          example: null
        previous_bill_total:
          type: string
          nullable: true
          description: >-
            **Nota:** Este campo não se aplica ao OFDA Brasil e retornará
            `null`.
          example: null
        bill_amount:
          type: number
          nullable: true
          format: float
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: >-
            O valor da fatura, a partir de `collected_at`. Para mais
            informações, veja `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: >-
            O número do cartão de crédito.


            **Nota:** Frequentemente, são apenas os últimos quatro dígitos do
            cartão de crédito.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: Informações adicionais sobre a taxa.
          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: Informações adicionais sobre o tipo de crédito.
          example: Some additional information.
        installment_identifier:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: >-
            Um identificador para a parcela, de acordo com a instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: PARCELA_896
        number_of_installments:
          type: integer
          nullable: true
          maximum: 999
          description: >-
            O número total de parcelas para a transação com cartão, se
            aplicável.
          example: 4
        credit_card_bill:
          $ref: '#/components/schemas/TransactionCreditCardBill'
    EnumTransactionCounterpartyType:
      type: string
      nullable: true
      enum:
        - INDIVIDUAL
        - COMPANY
        - null
      description: |-
        O tipo de contraparte da transação. Retornamos um dos seguintes valores:

          - `INDIVIDUAL`
          - `COMPANY`
          - `null`
      example: INDIVIDUAL
    TransactionCounterparty:
      type: object
      nullable: true
      required:
        - type
        - document_number
        - clearing_code
        - agency
        - check_digit
        - number
      description: Informações sobre a outra parte desta transação, se disponível.
      properties:
        type:
          $ref: '#/components/schemas/EnumTransactionCounterpartyType'
        document_number:
          type: string
          nullable: true
          maxLength: 11
          pattern: ^\d{11}$
          description: |-
            O número do documento do representante.

            **Nota**:

            Para o Brasil:
              - Quando o `type` é `INDIVIDUAL`, este é o número do CPF.
              - Quando o `type` é `COMPANY`, este é o número do CNPJ.
          example: '73677831148'
        clearing_code:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^\d{3}$
          description: O código de compensação bancária.
          example: '001'
        agency:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: O código da agência onde a conta foi aberta.
          example: '6272'
        check_digit:
          type: string
          nullable: true
          maxLength: 2
          pattern: '[\w\W\s]*'
          description: O dígito verificador do número da conta, se aplicável.
          example: '7'
        number:
          type: string
          nullable: true
          maxLength: 20
          pattern: ^\d{8,20}$
          description: O número da conta do produto.
          example: '24550245'
    TransactionLoanDataFees:
      type: object
      nullable: true
      required:
        - name
        - code
        - amount
      description: >-
        Detalhes sobre as taxas associadas a este pagamento. Aplicável apenas
        quando `is_detached` = `true`.
      properties:
        name:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: >-
            O nome da taxa.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil quando o campo `fees` estiver presente.
          example: Reavaliação periódica do bem
        code:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: >-
            O código da instituição para a taxa.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil quando o campo `fees` estiver presente.
          example: aval_bem
        amount:
          type: number
          nullable: true
          format: float
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: >-
            O valor da taxa.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil quando o campo `fees` estiver presente.
          example: 8903.77
    TransactionLoanDataCharges:
      type: object
      nullable: true
      required:
        - type
        - info
        - amount
      description: >-
        Detalhes relacionados às cobranças associadas a este pagamento.
        Aplicável somente quando `is_detached` = `true`.
      properties:
        type:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: >-
            O tipo de cobrança.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil quando o campo `charges` estiver presente.
          example: MULTA_ATRASO_PAGAMENTO
        info:
          type: string
          maxLength: 140
          pattern: ^[\w\W\s]{0,140}$
          description: Informações adicionais sobre o `type` de cobrança.
          example: Late payment charge.
        amount:
          type: number
          format: float
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: >-
            O valor da cobrança.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil quando o campo `charges` estiver presente.
          example: 8903.77
    TransactionLoanDataOpenFinanceBrazil:
      type: object
      nullable: true
      required:
        - is_detached
        - installment_it
        - fees
        - charges
      description: Informações sobre os dados transacionais de empréstimos, se aplicável.
      properties:
        is_detached:
          type: boolean
          description: >-
            Boolean para indicar se este pagamento de empréstimo fazia parte do
            cronograma de pagamento original.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: true
        installment_id:
          type: string
          nullable: true
          minLength: 1
          maxLength: 100
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{0,99}$
          description: O ID único da instituição para esta parcela de pagamento.
          example: WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH
        fees:
          type: array
          description: >-
            Detalhes sobre as taxas associadas a este pagamento. Aplicável
            apenas quando `is_detached` = `true`.
          items:
            $ref: '#/components/schemas/TransactionLoanDataFees'
        charges:
          type: array
          minItems: 0
          description: >-
            Detalhes relacionados às cobranças associadas a este pagamento.
            Aplicável somente quando `is_detached` = `true`.
          items:
            $ref: '#/components/schemas/TransactionLoanDataCharges'
    EnumTransactionPaymentType:
      type: string
      nullable: true
      enum:
        - FULL
        - INSTALLMENT
        - null
      description: |-
        O tipo de pagamento da transação. Retornamos um dos seguintes valores:

          - `FULL`
          - `INSTALLMENT`
          - `null`
      example: FULL
    TransactionOpenFinanceBrazil:
      type: object
      title: Objeto de Transação (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: >-
            A identificação interna da instituição para a transação.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: >-
            A data em que a transação ocorreu, no formato `YYYY-MM-DD`.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: >-
            O carimbo de data/hora ISO-8601 de quando a transação ocorreu (no
            fuso horário UTC).


            > **Nota:** Para transações que ocorreram antes de 31.01.2024, o
            carimbo de data/hora pode indicar apenas o dia (por exemplo,
            `2016-01-29T00:00:00.000Z`). No entanto, transações que ocorrerem
            após essa data devem incluir a data e a hora
            (`2024-02-20T12:29:03.374Z`).


            > **Instituições que não seguem este formato:**

            > Algumas instituições podem não fornecer a hora exata da transação.
            Nesse caso, o carimbo de data/hora será definido como
            `00:00:00.000Z`.

            > A Belvo identificou as seguintes instituições como não cumprindo a
            regulamentação e levantou a questão com os reguladores: Bradesco,
            Itau e Sicoob.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil para **transações de cartão de crédito e conta
            corrente**.
          example: '2024-02-20T12:29:03.374Z'
        accounting_date:
          type: string
          nullable: true
          description: >-
            A data em que a transação foi processada e contabilizada pela
            instituição, no formato `YYYY-MM-DD`.  

            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil para **transações de cartão de crédito**.
          example: '2019-10-23'
        inferred_accounting_date:
          type: string
          format: date
          description: >-
            No caso de a transação ocorrer em um fim de semana ou feriado, a
            Belvo inferirá a data em que a transação é contabilizada pela
            instituição. Normalmente, este é o próximo dia útil.
          example: '2019-10-23'
        amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor da transação.  

            ℹ️ O valor exibido é sempre positivo, pois indicamos a direção da
            transação no parâmetro `type`.  

            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: 2145.45
        local_currency_amount:
          type: number
          nullable: true
          format: float
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor da transação na moeda local.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil para **transações de cartão de crédito**.
          example: 7623.64
        balance:
          type: number
          nullable: true
          format: float
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará null.'
          example: null
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: O código de moeda de três letras (ISO-4217).
          example: BRL
        description:
          type: string
          nullable: true
          description: >-
            A descrição da transação fornecida pela instituição. Geralmente,
            este é o texto que o usuário final vê na plataforma online.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: SEVEN BUDDHAS RFC:XXXXXXXXXX
        observations:
          type: string
          nullable: true
          description: '**Nota:** Este campo não se aplica ao OF Brasil e retornará 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 não se aplica ao OF Brasil e retornará 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: >-
            O tipo de transação. Por exemplo, um pagamento PIX ou um depósito.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil para **transações de contas não relacionadas a
            empréstimos**.
          example: TRANSFERENCIA_MESMA_INSTITUICAO
        operation_type_additional_info:
          type: string
          nullable: true
          maxLength: 140
          pattern: ^\S[\s\S]*$
          description: Informações adicionais sobre o `operation_type`, se aplicável.
          example: Internal transfer.
        mcc:
          type: integer
          nullable: true
          format: int32
          pattern: ^[0-9]{4}$
          description: >-
            O código de categoria de comerciante (MCC) de quatro dígitos
            (conforme ISO-18245) para a transação. Este campo é aplicável apenas
            para transações com cartão de crédito.
          example: 5137
    date_from:
      type: string
      format: date
      pattern: ^\d{4}-\d{2}-\d{2}$
      minLength: 10
      maxLength: 10
      description: >-
        A data a partir da qual você deseja começar a obter dados, no formato
        `YYYY-MM-DD`.


        ⚠️ O valor de `date_from` não pode ser maior 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: >-
        A data em que você deseja parar de receber dados, no formato
        `YYYY-MM-DD`.


        ⚠️ O valor de `date_to` não pode ser maior que a data de hoje (ou seja,
        não são permitidas datas futuras).
      example: '2020-10-05'
    EnumBillFinanceChargeType:
      type: string
      nullable: true
      enum:
        - LATE_PAYMENT_INTEREST
        - LATE_FEE
        - ARREARS_INTEREST
        - IOF
        - NO_CHARGE
        - OTHER
        - null
      description: >-
        O tipo de encargo financeiro aplicado à fatura. Retornamos um dos
        seguintes 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: Informações adicionais sobre a cobrança financeira.
          example: Paid 15 days late, fee applied.
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: O código de moeda de três letras (ISO-4217).
          example: BRL
        amount:
          type: number
          nullable: true
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor do encargo financeiro.
          example: 91.89
    EnumBillPaymentType:
      type: string
      nullable: true
      enum:
        - INSTALLMENT
        - FULL
        - OTHER
        - null
      description: |-
        O tipo de pagamento. Retornamos um dos seguintes valores:

          - `INSTALLMENT`
          - `FULL`
          - `OTHER`
          - `null`
      example: INSTALLMENT
    EnumBillPaymentPaymentMode:
      type: string
      nullable: true
      enum:
        - DIRECT_DEBIT
        - BANK_SLIP
        - SALARY_DEDUCTION
        - PIX
        - null
      description: >-
        O método pelo qual o pagamento foi realizado. Retornamos um dos
        seguintes 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: A data em que o pagamento foi realizado, no 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: O código de moeda de três letras (ISO-4217).
          example: BRL
        amount:
          type: number
          nullable: true
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor do pagamento.
          example: 500.15
    Bill:
      type: object
      title: Objeto Bill (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: O identificador interno da instituição para a fatura.
          example: '92792126019929279212650822221989319252576'
        bill_name:
          type: string
          nullable: true
          description: >-
            O título da fatura mensal do cartão de crédito à qual a transação
            pertence. O formato do valor retornado é específico da instituição,
            no entanto, alguns exemplos comuns são:


            - diciembre-2021

            - dec-2021

            - dec-21


            > **Nota**: Este campo é retornado apenas para faturas 'fechadas' (o
            que significa que o período de faturamento terminou e a fatura foi
            emitida). Se o período de faturamento ainda estiver em andamento,
            retornamos `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: A data em que a fatura deve ser paga, no formato `YYYY-MM-DD`.
          example: '2021-09-06'
        currency:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: O código de moeda de três 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: O valor total da conta.
          example: 45391.89
        minimum_amount:
          type: number
          nullable: true
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor mínimo a pagar.
          example: 391.89
        is_installment:
          type: boolean
          nullable: true
          description: Boolean para indicar se esta fatura pode ser paga em parcelas.
          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: |-
        O estado civil do indivíduo. Retornamos um dos seguintes valores:

          - `SINGLE`
          - `MARRIED`
          - `WIDOWED`
          - `SEPARATED`
          - `DIVORCED`
          - `CIVIL_UNION`
          - `OTHER`
      example: SINGLE
    EnumOwnerGender:
      type: string
      nullable: true
      enum:
        - FEMALE
        - MALE
        - OTHER
      description: |-
        O gênero do indivíduo. Retornamos um dos seguintes valores:

          - `FEMALE`
          - `MALE`
          - `OTHER`
      example: FEMALE
    OwnerDocumentIdOpenFinanceBrazil:
      type: object
      required:
        - document_type
        - document_number
      description: >-
        Informações sobre o documento de identificação que o proprietário
        forneceu ao banco.


        > **Non-nullable:** Um valor deve ser retornado pela rede de open
        finance do Brasil.
      properties:
        document_type:
          type: string
          description: >-
            O tipo de documento que o proprietário forneceu à instituição para
            abrir a conta. Tipos comuns de documentos são:


            🇧🇷 Brasil

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

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


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: CPF
        document_number:
          type: string
          description: >-
            O número de identificação do documento.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: 235578435-S
    EnumOwnerIndividualDocumentIdType:
      type: string
      nullable: true
      enum:
        - DRIVERS_LICENSE
        - PASSPORT
        - ID_CARD
        - FISCAL_ID
        - FOREIGNER_REGISTRATION_CARD
        - OTHER
        - null
      description: >-
        O tipo de documento de identificação. Retornamos um dos seguintes
        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: >-
        Informações detalhadas sobre documentos adicionais fornecidos para
        comprovar a identidade do indivíduo.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerIndividualDocumentIdType'
        type_additional_info:
          type: string
          nullable: true
          maxLength: 70
          pattern: ^[\w\W\s]{0,70}$
          description: >-
            Informações adicionais sobre o tipo de documento.


            > Nota: Para documentos de ID Empresarial, este campo deve retornar
            um valor da rede de open finance do Brasil.
          example: Learner's licence
        number:
          type: string
          maxLength: 40
          pattern: ^[\w\W\s]{0,40}$
          description: >-
            O número do documento de identidade.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: DL-7896829-7
        check_digit:
          type: string
          maxLength: 2
          pattern: ^[\w\W\s]{0,2}$
          description: >-
            O dígito verificador do documento de identidade.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: >-
            A data em que o documento de identificação foi emitido, no 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: >-
            A data de expiração do documento de identidade, no formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        country_of_issuance:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[\w]{3}$
          description: >-
            O código de país de três letras que emitiu o documento (no formato
            ISO-3166 Alpha 3).


            Este campo deve ser retornado quando o `type` for `PASSPORT`.
          example: CAN
        additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: Informações adicionais sobre o documento de identificação.
          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: >-
        Informações detalhadas sobre documentos adicionais fornecidos para
        comprovar a identidade do indivíduo.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerIndividualDocumentIdType'
        number:
          type: string
          maxLength: 40
          pattern: ^[\w\W\s]{0,40}$
          description: >-
            O número do documento de identidade.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: >-
            A data em que o documento de identificação foi emitido, no 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: >-
            A data de expiração do documento de identidade, no formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        country_of_issuance:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^[\w]{3}$
          description: >-
            O código de país de três letras que emitiu o documento (no formato
            ISO-3166 Alpha 3).


            Este campo deve ser retornado quando o `type` for `PASSPORT`.
          example: CAN
        additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: Informações adicionais sobre o documento de identificação.
          example: The document has water damage
    OwnerNationalities:
      type: object
      required:
        - info
        - documents
      description: Informações detalhadas sobre as nacionalidades do indivíduo.
      properties:
        info:
          type: string
          nullable: true
          pattern: ^\S[\s\S]*$
          maxLength: 40
          description: A nacionalidade do indivíduo.
          example: CAN
        documents:
          type: array
          items:
            $ref: '#/components/schemas/OwnerIndividualNationalityDocumentId'
    OwnerEmails:
      type: object
      nullable: true
      required:
        - is_main
        - email
      description: Lista adicional de e-mails fornecida pelo proprietário.
      properties:
        is_main:
          type: boolean
          description: >-
            Boolean para indicar se este é o endereço de e-mail principal do
            usuário.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: true
        email:
          type: string
          maxLength: 320
          pattern: ^[\w\W\s]{0,320}$
          description: >-
            O endereço de e-mail do usuário.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: Informações detalhadas sobre os endereços do proprietário.
      properties:
        is_main:
          type: boolean
          description: >-
            Boolean para indicar se este é o endereço principal do usuário.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: true
        address:
          type: string
          maxLength: 150
          pattern: ^[\w\W\s]{0,150}$
          description: >-
            O endereço do usuário.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: Av Naburo Ykesaki, 1270
        additional_info:
          type: string
          nullable: true
          maxLength: 150
          pattern: ^[\w\W\s]{0,150}$
          description: Informações adicionais sobre o endereço do usuário.
          example: In between two palm trees
        district_name:
          type: string
          nullable: true
          maxLength: 50
          pattern: ^[\w\W\s]{0,50}$
          description: O distrito do endereço.
          example: CENTRO
        town:
          type: string
          maxLength: 50
          pattern: ^[\w\W\s]{0,50}$
          description: >-
            A cidade do usuário.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: Brasilia
        town_code:
          type: string
          nullable: true
          maxLength: 7
          pattern: \d{7}$
          description: |-
            O código de sete dígitos para a cidade, se aplicável.

            Para o Brasil, este é o código do município do IBGE.
          example: '3550308'
        state:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^[\w\W\s]{0,2}$
          description: O estado em que o endereço está localizado.
          example: SP
        postcode:
          type: string
          maxLength: 8
          pattern: ^\d{8}$
          description: >-
            O código postal do endereço.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '17500001'
        country_name:
          type: string
          maxLength: 80
          pattern: ^[\w\W\s]{0,80}$
          description: >-
            O nome do país.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: Brasil
        country_code:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^([A-Z]{3})$
          description: O código de país de três letras (conforme ISO-3166 Alpha 3).
          example: BRA
        latitude:
          type: string
          nullable: true
          maxLength: 13
          pattern: ^-?\d{1,2}\.\d{1,9}$
          description: A coordenada de latitude geográfica.
          example: '-23.5475000'
        longitude:
          type: string
          nullable: true
          maxLength: 13
          pattern: ^-?\d{1,3}\.\d{1,8}$
          description: A coordenada de longitude geográfica.
          example: '-46.6361100'
    EnumOwnerPhoneNumberType:
      type: string
      nullable: true
      enum:
        - LANDLINE
        - MOBILE
        - OTHER
        - null
      description: |-
        O tipo de número de telefone. Retornamos um dos seguintes 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: Informações detalhadas sobre os `phone_number`s dos proprietários.
      properties:
        is_main:
          type: boolean
          description: >-
            Boolean para indicar se este é o número de telefone principal do
            usuário.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: true
        type:
          $ref: '#/components/schemas/EnumOwnerPhoneNumberType'
        additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: Informações adicionais sobre o número de telefone.
          example: This is their work mobile number.
        number:
          type: string
          maxLength: 11
          pattern: ^([0-9]{8,11})$
          description: >-
            O número de telefone (não incluindo o código do país, área ou
            ramal).


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '29875132'
        country_code:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: 'O código de discagem do país. Por exemplo: `351` (sem `+`).'
          example: '351'
        area_code:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^\d{1,2}$
          description: O código de discagem da área.
          example: '21'
        extension:
          type: string
          nullable: true
          maxLength: 5
          pattern: ^\d{1,5}$
          description: O código da extensão.
          example: '932'
    EnumOwnerFiliationType:
      type: string
      nullable: true
      enum:
        - MOTHER
        - FATHER
        - null
      description: |-
        A relação familiar. Retornamos um dos seguintes valores:

          - `MOTHER`
          - `FATHER`
          - `null`
      example: MOTHER
    OwnerFiliations:
      type: object
      required:
        - type
        - civil_name
        - social_name
      description: Informações sobre quaisquer relações familiares do indivíduo.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerFiliationType'
        civil_name:
          type: string
          maxLength: 70
          pattern: ^[\w\W\s]{0,70}$
          description: >-
            O nome completo da pessoa.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: Bruce Wayne
        social_name:
          type: string
          nullable: true
          maxLength: 70
          pattern: ^[\w\W\s]{0,70}$
          description: O nome social da pessoa.
          example: The Dark Knight
    EnumOwnerIndividualFinancialProfileOccupationCode:
      type: string
      nullable: true
      enum:
        - BRAZIL_PUBLIC_OFFICE
        - BRAZIL_OCCUPATION_CODE
        - OTHER
        - null
      description: |-
        A área de emprego do indivíduo. Retornamos um dos seguintes 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 com que frequência o indivíduo recebe seu salário. Retornamos um
        dos seguintes valores:

          - `DAILY`
          - `WEEKLY`
          - `FORTNIGHTLY`
          - `MONTHLY`
          - `BIMONTHLY`
          - `QUARTERLY`
          - `BIANNUALLY`
          - `ANNUALLY`
          - `OTHERS`
      example: MONTHLY
    OwnerIndividualInformedIncome:
      type: object
      required:
        - frequency
        - amount
        - currency
        - date
      description: >-
        Informações sobre a renda declarada do indivíduo.


        > **Non-nullable:** Um valor deve ser retornado pela rede de open
        finance do Brasil.
      properties:
        frequency:
          $ref: '#/components/schemas/EnumOwnerInformedIncomeFrequency'
        amount:
          type: number
          format: float
          minLength: 1
          maxLength: 20
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            A renda declarada que o indivíduo recebe.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: 45391.89
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            O código de moeda de três letras (ISO-4217).


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: >-
            Data em que o indivíduo recebeu seu salário pela última vez.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '2020-03-19'
    OwnerIndividualPatrimony:
      type: object
      nullable: true
      required:
        - amount
        - currency
        - year
      description: Informações sobre os ativos relatados do indivíduo (se disponíveis).
      properties:
        amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            Os ativos relatados do indivíduo.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil quando o objeto `patrimony` estiver disponível.
          example: 45391.89
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            O código de moeda de três letras (ISO-4217).


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil quando o objeto `patrimony` estiver disponível.
          example: BRL
        year:
          type: integer
          format: int32
          maximum: 2090
          minimum: 1700
          description: >-
            O ano ao qual os ativos reportados se aplicam.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil quando o objeto `patrimony` estiver disponível.
          example: 2020
    OwnerIndividualFinancialProfile:
      type: object
      nullable: true
      required:
        - company_id
        - occupation_code
        - occupation_description
        - informed_income
        - patrimony
      description: Informações sobre o perfil financeiro do indivíduo.
      properties:
        company_id:
          type: string
          nullable: true
          maxLength: 14
          pattern: ^\d{14}$
          description: O identificador da empresa onde o indivíduo está empregado.
          example: '50685362000135'
        occuptation_code:
          $ref: >-
            #/components/schemas/EnumOwnerIndividualFinancialProfileOccupationCode
        occupation_description:
          type: string
          nullable: true
          maxLength: 100
          pattern: '[\w\W\s]*'
          description: Informações sobre a ocupação do indivíduo.
          example: '01'
        informed_income:
          $ref: '#/components/schemas/OwnerIndividualInformedIncome'
        patrimony:
          $ref: '#/components/schemas/OwnerIndividualPatrimony'
    EnumOwnerProcuratorType:
      type: string
      nullable: true
      enum:
        - LEGAL_REPRESENTATIVE
        - ATTORNEY
        - null
      description: >-
        O tipo de representante que pode acessar e fazer alterações na conta.
        Retornamos um dos seguintes valores:

          - `LEGAL_REPRESENTATIVE`
          - `ATTORNEY`
          - `null`
      example: LEGAL_REPRESENTATIVE
    OwnerProcurators:
      type: object
      nullable: true
      required:
        - type
        - civil_name
        - social_name
        - document_number
      description: >-
        Informações sobre quaisquer indivíduos ou empresas que possam agir em
        nome do proprietário.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerProcuratorType'
        civil_name:
          type: string
          maxLength: 70
          pattern: ^[\w\W]*$
          description: >-
            O nome completo dos representantes.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `procurators` estiver disponível.
          example: Alfred Thaddeus Pennyworth
        social_name:
          type: string
          nullable: true
          maxLength: 70
          pattern: ^[\w\W]*$
          description: O nome social da pessoa.
          example: Alfred Pennyworth
        document_number:
          type: string
          maxLength: 11
          pattern: ^\d{11}$
          description: >-
            O número do documento do representante.


            **Nota**: Para indivíduos, este é o número do CPF do Brasil. Para
            empresas, este é o número do CNPJ do Brasil.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `procurators` estiver disponível.
          example: '73677831148'
    EnumOwnerIndividualProductType:
      type: string
      nullable: true
      enum:
        - SAVINGS_ACCOUNT
        - CHECKING_ACCOUNT
        - null
      description: >-
        Os produtos adicionais que o indivíduo possui na instituição. Retornamos
        um dos seguintes valores:

          - `SAVINGS_ACCOUNT`
          - `CHECKING_ACCOUNT`
          - `null`
      example: SAVINGS_ACCOUNT
    OwnerIndividualProducts:
      type: object
      nullable: true
      required:
        - type
        - subtype
        - agency
        - clearing_code
        - number
        - check_digit
      description: >-
        Detalhes sobre quaisquer produtos adicionais que o indivíduo possua com
        a instituição.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerIndividualProductType'
        subtype:
          type: string
          nullable: true
          description: >-
            O subtipo do produto que o indivíduo possui na instituição.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `products` estiver disponível.
          example: CONJUNTA_SIMPLES
        agency:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: O código da agência onde o produto foi aberto.
          example: '6272'
        clearing_code:
          type: string
          maxLength: 3
          pattern: ^\d{3}$
          description: >-
            O código de compensação bancária para o produto.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `products` estiver disponível.
          example: '001'
        number:
          type: string
          maxLength: 20
          pattern: ^\d{8,20}$
          description: >-
            O número da conta do produto.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `procurators` estiver disponível.
          example: '24550245'
        check_digit:
          type: string
          maxLength: 2
          pattern: '[\w\W\s]*'
          description: >-
            O dígito verificador do número do produto.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `products` estiver disponível.
          example: '7'
    OwnerIndividualSalaryPortabilityRequests:
      type: object
      description: Detalhes sobre a solicitação de portabilidade salarial.
      properties:
        employer_name:
          type: string
          maxLength: 80
          pattern: ^(?!\s)[\w\W\s]*[^\s]$
          description: O nome do empregador.
          example: ACME Inc.
        employer_id_number:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^\d{14}$|^\d{11}$
          description: O CPF ou CNPJ do empregador.
          example: 12345678901
        employer_bank_id_number:
          type: string
          minLength: 14
          maxLength: 14
          pattern: ^\d{14}$
          description: O CNPJ do banco do empregador.
          example: 12345678901234
        employer_bank_code:
          type: string
          minLength: 8
          maxLength: 8
          pattern: ^[0-9]{8}$
          description: >-
            O código ISPB (*Identificador de Sistema de Pagamentos Brasileiro*)
            do banco do empregador.
          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: >-
            A data em que a solicitação de portabilidade foi aprovada, no
            formato `YYYY-MM-DD`.
          example: '2024-04-01'
    OwnerIndividualPayrollAccounts:
      type: object
      description: Detalhes sobre a conta bancária da folha de pagamento.
      properties:
        employer_name:
          type: string
          maxLength: 80
          pattern: ^(?!\s)[\w\W\s]*[^\s]$
          description: O nome do empregador.
          example: ACME Inc.
        employer_id_number:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^\d{14}$|^\d{11}$
          description: O CPF ou CNPJ do empregador.
          example: 12345678901
        employer_bank_id_number:
          type: string
          minLength: 14
          maxLength: 14
          pattern: ^\d{14}$
          description: O CNPJ do banco do empregador.
          example: 12345678901234
        employer_bank_code:
          type: string
          minLength: 8
          maxLength: 8
          pattern: ^[0-9]{8}$
          description: >-
            O código ISPB (*Identificador de Sistema de Pagamentos Brasileiro*)
            do banco do empregador.
          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: >-
            A data em que a conta bancária de salário foi aberta, no 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: >-
        Detalhes sobre qualquer relacionamento adicional que o indivíduo tenha
        com a instituição (por exemplo, outras contas ou produtos que ele possua
        com a instituição).
      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: >-
            O carimbo de data/hora ISO-8601 quando o relacionamento financeiro
            entre o indivíduo e a instituição começou.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '2021-05-21T08:30:00Z'
        product_services:
          type: array
          minItems: 1
          description: >-
            Uma lista de produtos que o indivíduo possui com a instituição.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            type: string
            description: O nome do produto, de acordo com a instituição.
            example: CONTA_DEPOSITO_A_VISTA
        product_services_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W]*$
          description: Informações adicionais sobre os produtos que o indivíduo possui.
          example: Joint account with Robin
        procurators:
          type: array
          description: >-
            Informações sobre quaisquer indivíduos ou empresas que possam agir
            em nome do proprietário.
          items:
            $ref: '#/components/schemas/OwnerProcurators'
        products:
          type: array
          description: >-
            Detalhes sobre quaisquer produtos adicionais que o indivíduo possua
            com a instituição.
          items:
            $ref: '#/components/schemas/OwnerIndividualProducts'
        salary_portability_requests:
          type: array
          description: >-
            Detalhes sobre quaisquer solicitações de portabilidade de salário
            que o indivíduo tenha feito com a instituição.


            Uma portabilidade de salário é uma solicitação para transferir o
            salário do indivíduo da conta bancária de 'folha de pagamento' do
            empregador para outra conta bancária.


            > 📘 

            >

            > Por favor, note que a conta bancária receptora não pode encerrar
            uma portabilidade de salário (ou ser informada de que ela foi
            encerrada). Apenas o banco da folha de pagamento do empregador pode
            fornecer essa informação. Assim, as portabilidades listadas aqui
            podem não estar atualizadas.
          items:
            $ref: '#/components/schemas/OwnerIndividualSalaryPortabilityRequests'
        payroll_accounts:
          type: array
          description: >-
            Detalhes sobre quaisquer contas bancárias de folha de pagamento
            associadas ao indivíduo. Ou seja, cada vez que o indivíduo tiver um
            novo empregador do qual recebe salário, isso deve ser listado aqui.


            > 📘

            >

            > Empregadores anteriores podem não fechar a conta de folha de
            pagamento do indivíduo. Assim, as contas de folha de pagamento
            listadas aqui podem não estar atualizadas.
          items:
            $ref: '#/components/schemas/OwnerIndividualPayrollAccounts'
    OwnerIndividualOpenFinanceBrazil:
      type: object
      title: Proprietário 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: O identificador interno da instituição para o proprietário.
          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: >-
            O nome completo do indivíduo, conforme fornecido pela instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: Jack Oswald White
        social_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: O nome social do indivíduo, conforme geralmente aceito pelo 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: >-
            A data de nascimento do indivíduo, no formato `YYYY-MM-DD`.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: Informações adicionais sobre o estado civil do indivíduo.
          example: It's complicated
        gender:
          $ref: '#/components/schemas/EnumOwnerGender'
        companies_id:
          type: array
          minItems: 1
          description: >-
            As instituições responsáveis pela criação e verificação do
            proprietário.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            type: string
            maxLength: 14
            pattern: ^\d{14}$
            description: >-
              As instituições responsáveis pela criação e verificação do
              proprietário.
            example: '01773247000103'
        is_local_resident:
          type: boolean
          description: >-
            Boolean para indicar se o indivíduo é residente local do país.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: true
        document_id:
          $ref: '#/components/schemas/OwnerDocumentIdOpenFinanceBrazil'
        additional_documents:
          type: array
          description: >-
            Informações detalhadas sobre documentos adicionais fornecidos para
            comprovar a identidade dos indivíduos.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          minItems: 1
          items:
            $ref: '#/components/schemas/OwnerIndividualDocumentIds'
        nationalities:
          type: array
          nullable: true
          minItems: 1
          description: >-
            Informações detalhadas sobre as nacionalidades do indivíduo.


            Só é necessário retornar quando `is_local_resident` estiver definido
            como `false`.
          items:
            $ref: '#/components/schemas/OwnerNationalities'
        email:
          type: string
          nullable: true
          format: email
          maxLength: 320
          description: >-
            O endereço de e-mail registrado do proprietário da conta.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: johndoe@belvo.com
        emails:
          type: array
          minItems: 0
          description: >-
            Lista adicional de e-mails fornecida pelo proprietário.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            $ref: '#/components/schemas/OwnerEmails'
        address:
          type: string
          nullable: true
          description: >-
            O endereço registrado do proprietário da conta.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: Carrer de la Llacuna, 162, 08018 Barcelona
        addresses:
          type: array
          minItems: 1
          description: >-
            Informações detalhadas sobre os endereços do proprietário.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            $ref: '#/components/schemas/OwnerAddresses'
        phone_number:
          type: string
          nullable: true
          description: >-
            O número de telefone registrado do proprietário da conta.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: +52-XXX-XXX-XXXX
        phone_numbers:
          type: array
          minItems: 0
          description: >-
            Informações detalhadas sobre os números de telefone do proprietário.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            $ref: '#/components/schemas/OwnerPhoneNumbers'
        filiations:
          type: array
          minItems: 1
          description: >-
            Informações sobre quaisquer relações familiares do indivíduo.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: >-
        Informações detalhadas sobre documentos adicionais fornecidos para
        comprovar a identidade da empresa.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerIndividualDocumentIdType'
        type_additional_info:
          type: string
          nullable: true
          maxLength: 70
          pattern: ^[\w\W\s]{0,70}$
          description: >-
            Informações adicionais sobre o tipo de documento.


            > Nota: Para documentos de ID Empresarial, este campo deve retornar
            um valor da rede de open finance do Brasil.
          example: EIN
        number:
          type: string
          maxLength: 40
          pattern: ^[\w\W]{0,40}$
          description: >-
            O número do documento de identidade.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: DL-7896829-7
        check_digit:
          type: string
          maxLength: 2
          pattern: ^[\w\W\s]{0,2}$
          description: >-
            O dígito verificador do documento de identidade.


            > **Nota**: Este campo não se aplica a documentos de identificação
            empresarial e retornará `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: >-
            A data em que o documento de identificação foi emitido, no formato
            `YYYY-MM-DD`.


            > **Nota**: Este campo não se aplica a documentos de identificação
            empresarial e retornará `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: >-
            A data de expiração do documento de identidade, no formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        country_of_issuance:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^(\w{3}){1}$
          description: >-
            O código de país de três letras que emitiu o documento (no formato
            ISO-3166 Alpha 3).


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: CAN
        additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: >-
            Informações adicionais sobre o documento de identificação.


            > **Nota**: Este campo não se aplica a documentos de identificação
            empresarial e retornará `null`.
          example: null
    EnumOwnerPartyPersonType:
      type: string
      nullable: true
      enum:
        - INDIVIDUAL
        - COMPANY
      description: >-
        O tipo de pessoa que é parte proprietária da conta. Retornamos um dos
        seguintes valores:

          - `INDIVIDUAL`
          - `COMPANY`
      example: INDIVIDUAL
    EnumOwnerPartyType:
      type: string
      nullable: true
      enum:
        - MEMBER
        - ADMINISTRATOR
      description: >-
        O tipo de acesso que o `person_type` tem à conta. Retornamos um dos
        seguintes valores:


        - `MEMBER` indica que o `person_type` tem acesso de leitura à conta.

        - `ADMINISTRATOR` indica que o `person_type` pode realizar todas as
        ações para a conta (incluindo transferências).
      example: MEMBER
    EnumOwnerPartyDocumentType:
      type: string
      nullable: true
      enum:
        - CPF
        - CNPJ
        - OTHER_TRAVEL_DOCUMENT
        - PASSPORT
      description: >-
        O tipo de documento de identificação que a parte forneceu ao ser
        adicionada à conta. Retornamos um dos seguintes 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: >-
        Informações detalhadas sobre as partes autorizadas a agir em nome do
        proprietário.
      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: >-
            O nome completo do indivíduo, conforme fornecido pela instituição.
            Aplicável apenas se o `person_type` for `INDIVIDUAL`.
          example: Jack Oswald White
        social_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            O nome social do indivíduo, conforme geralmente aceito pelo país.
            Aplicável apenas se o `person_type` for `INDIVIDUAL`.
          example: O Piadista
        company_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            O nome completo (oficial) da empresa. Aplicável apenas se o
            `person_type` for `COMPANY`.
          example: Wayne Enterprises
        trade_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: >-
            O nome comercial da empresa. Aplicável apenas se o `person_type` for
            `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: >-
            A data em que a parte foi adicionada à conta, no 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: A participação acionária da parte.
          example: 0.51
        document_type:
          $ref: '#/components/schemas/EnumOwnerPartyDocumentType'
        document_number:
          type: string
          maxLength: 40
          pattern: ^[\w\W\s]{0,40}$
          description: >-
            O número do documento de identidade.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: >-
            A data em que o documento de identificação foi emitido, no 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: >-
            A data de expiração do documento de identidade, no formato
            `YYYY-MM-DD`.
          example: '2019-01-01'
        document_country:
          type: string
          nullable: true
          maxLength: 3
          pattern: ^(\w{3}){1}$
          description: >-
            O código de país de três letras que emitiu o documento (no formato
            ISO-3166 Alpha 3).
          example: CAN
        document_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: ^[\w\W\s]{0,100}$
          description: Informações adicionais sobre o documento.
          example: Confirmed CPF with their driver's licence.
    OwnerBusinessEconomicActivies:
      type: object
      nullable: true
      required:
        - is_main
        - code
      description: Detalhes sobre as atividades econômicas relatadas da empresa.
      properties:
        is_main:
          type: boolean
          description: >-
            Boolean para indicar se esta é a principal atividade econômica do
            negócio.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `economic_activities` estiver
            disponível.
          example: true
        code:
          type: string
          minLength: 2
          maxLength: 7
          pattern: ^\d{2,7}$
          description: >-
            O código da atividade econômica, conforme fornecido pelo país.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `economic_activities` estiver
            disponível.
          example: '8599604'
    EnumOwnerBusinessInformedRevenueFrequency:
      type: string
      nullable: true
      enum:
        - DAILY
        - WEEKLY
        - FORTNIGHTLY
        - MONTHLY
        - BIMONTHLY
        - QUARTERLY
        - BIANNUALLY
        - ANNUALLY
        - OTHERS
        - null
      description: >-
        Indica com que frequência a empresa declara sua receita. Retornamos um
        dos seguintes 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: Informações sobre a receita reportada do negócio.
      properties:
        frequency:
          $ref: '#/components/schemas/EnumOwnerBusinessInformedRevenueFrequency'
        frequency_additional_info:
          type: string
          nullable: true
          maxLength: 100
          pattern: '[\w\W\s]*'
          description: Informações adicionais sobre a frequência.
          example: Recently switched from weekly to monthly.
        amount:
          type: number
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            A receita reportada do negócio.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `informed_revenue` estiver disponível.
          example: 45391.89
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            O código de moeda de três letras (ISO-4217).


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `informed_revenue` estiver disponível.
          example: BRL
        year:
          type: integer
          maxLength: 4
          minimum: 1700
          maximum: 2090
          description: >-
            O ano em que a receita foi declarada pela última vez.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `informed_revenue` estiver disponível.
          example: 2022
    OwnerBusinessPatrimony:
      type: object
      nullable: true
      required:
        - amount
        - currency
        - date
      description: Informações sobre os ativos relatados do indivíduo.
      properties:
        amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            Os ativos relatados do negócio.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `patrimony` estiver disponível.
          example: 45391.89
        currency:
          type: string
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            O código de moeda de três letras (ISO-4217).


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `patrimony` estiver disponível.
          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: >-
            A data em que os ativos relatados foram aplicados, no formato
            `YYYY-MM-DD`.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `patrimony` estiver disponível.
          example: '2022-12-12'
    OwnerBusinessFinancialProfile:
      type: object
      nullable: true
      required:
        - economic_activities
        - informed_revenue
        - patrimony
      description: Informações sobre o perfil financeiro do indivíduo.
      properties:
        economic_activities:
          type: array
          description: Detalhes sobre as atividades econômicas relatadas da 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: >-
        Os produtos adicionais que a empresa possui na instituição. Retornamos
        um dos seguintes valores:

          - `SAVINGS_ACCOUNT`
          - `CHECKING_ACCOUNT`
          - `null`
      example: SAVINGS_ACCOUNT
    OwnerBusinessProducts:
      type: object
      nullable: true
      required:
        - type
        - subtype
        - agency
        - clearing_code
        - number
        - check_digit
      description: >-
        Detalhes sobre quaisquer produtos adicionais que o indivíduo possua com
        a instituição.
      properties:
        type:
          $ref: '#/components/schemas/EnumOwnerBusinessProductType'
        subtype:
          type: string
          description: >-
            O subtipo do produto que a empresa possui na instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `products` estiver disponível.
          example: CONJUNTA_SIMPLES
        agency:
          type: string
          nullable: true
          maxLength: 4
          pattern: ^\d{1,4}$
          description: O código da agência onde o produto foi aberto.
          example: '6272'
        clearing_code:
          type: string
          maxLength: 3
          pattern: ^\d{3}$
          description: >-
            O código de compensação bancária para o produto.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `products` estiver disponível.
          example: '001'
        number:
          type: string
          maxLength: 20
          pattern: ^\d{8,20}$
          description: >-
            O número da conta do produto.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `products` estiver disponível.
          example: '24550245'
        check_digit:
          type: string
          maxLength: 2
          pattern: ^[\w\W\s]{0,2}$
          description: >-
            O dígito verificador do número do produto.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil se o campo `products` estiver disponível.
          example: '7'
    OwnerBusinessFinancialRelation:
      type: object
      nullable: true
      required:
        - start_date
        - product_services
        - procurators
        - products
      description: >-
        Detalhes sobre qualquer relacionamento adicional que a empresa tenha com
        a instituição (por exemplo, outras contas ou produtos que ela possua com
        a instituição).
      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: >-
            O carimbo de data/hora ISO-8601 quando o relacionamento financeiro
            entre a empresa e a instituição começou.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '2021-05-21T08:30:00Z'
        product_services:
          type: array
          minItems: 1
          description: >-
            Uma lista de produtos que a empresa possui com a instituição.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            type: string
            description: O nome do produto, de acordo com a instituição.
            example: CONTA_DEPOSITO_A_VISTA
        procurators:
          type: array
          description: >-
            Informações sobre quaisquer indivíduos ou empresas que possam agir
            em nome do proprietário.
          items:
            $ref: '#/components/schemas/OwnerProcurators'
        products:
          type: array
          description: >-
            Detalhes sobre quaisquer produtos adicionais que a empresa tenha com
            a instituição.
          items:
            $ref: '#/components/schemas/OwnerBusinessProducts'
    OwnerBusinessOpenFinanceBrazil:
      type: object
      title: Proprietário de Negócios (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: O identificador interno da instituição para o proprietário.
          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: >-
            O nome completo (oficial) do negócio, conforme fornecido pela
            instituição.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: Wayne Enterprises
        trade_name:
          type: string
          nullable: true
          maxLength: 128
          pattern: ^[\w\W]{0,128}$
          description: O nome comercial da empresa.
          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: >-
            A data em que a empresa foi constituída, no formato `YYYY-MM-DD`.


            > **Não anulável:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          example: '1988-07-15'
        companies_id:
          type: array
          minItems: 1
          description: >-
            As instituições responsáveis pela criação e verificação do
            proprietário.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            type: string
            maxLength: 14
            pattern: ^\d{14}$
            description: >-
              As instituições responsáveis pela criação e verificação do
              proprietário.
            example: '01773247000103'
        document_id:
          $ref: '#/components/schemas/OwnerDocumentIdOpenFinanceBrazil'
        additional_documents:
          type: array
          minItems: 1
          description: >-
            Informações detalhadas sobre documentos adicionais fornecidos para
            comprovar a identidade da empresa.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          items:
            $ref: '#/components/schemas/OwnerBusinessDocumentIds'
        email:
          type: string
          nullable: true
          format: email
          maxLength: 256
          description: O endereço de e-mail registrado do proprietário da conta.
          example: johndoe@belvo.com
        emails:
          type: array
          minItems: 0
          description: Lista adicional de e-mails fornecida pelo proprietário.
          items:
            $ref: '#/components/schemas/OwnerEmails'
        address:
          type: string
          nullable: true
          description: O endereço registrado do proprietário das contas.
          example: Carrer de la Llacuna, 162, 08018 Barcelona
        addresses:
          type: array
          minItems: 1
          description: Informações detalhadas sobre os endereços do proprietário.
          items:
            $ref: '#/components/schemas/OwnerAddresses'
        phone_number:
          type: string
          nullable: true
          description: O número de telefone registrado do proprietário da conta.
          example: +52-XXX-XXX-XXXX
        phone_numbers:
          type: array
          minItems: 0
          description: Informações detalhadas sobre os `phone_number`s do proprietário.
          items:
            $ref: '#/components/schemas/OwnerPhoneNumbers'
        parties:
          type: array
          minItems: 1
          description: >-
            Informações detalhadas sobre as partes autorizadas a agir em nome do
            proprietário.


            > **Non-nullable:** Um valor deve ser retornado pela rede de open
            finance do Brasil.
          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: >-
        Informações sobre o documento de identificação que o proprietário
        forneceu ao banco.
      properties:
        document_type:
          type: string
          nullable: true
          description: >-
            O tipo de documento que o proprietário forneceu à instituição para
            abrir a conta. Tipos comuns de documentos são:


            🇧🇷 Brasil

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

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


            🇨🇴 Colômbia

            - `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: O número de identificação do documento.
          example: 235578435-S
    Owner:
      type: object
      title: Proprietário Padrão (Multi-Região)
      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: O identificador interno da instituição para o proprietário.
          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: O nome completo do proprietário, conforme fornecido pelo banco.
          example: John Doe
        email:
          type: string
          nullable: true
          format: email
          maxLength: 256
          description: O endereço de e-mail registrado do proprietário da conta.
          example: johndoe@belvo.com
        phone_number:
          type: string
          nullable: true
          description: O número de telefone registrado do proprietário da conta.
          example: +52-XXX-XXX-XXXX
        address:
          type: string
          nullable: true
          description: O endereço registrado do proprietário das contas.
          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 foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *O nome do negócio.*
          example: null
        first_name:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *O primeiro nome do titular da conta.*
          example: null
        last_name:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *O sobrenome do titular da conta.*
          example: null
        second_last_name:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *O segundo sobrenome do titular da conta.*
          example: null
    InvestmentBalance:
      type: object
      title: Saldo do Instrumento de Investimento
      description: O saldo do instrumento de investimento, na data de `reference_date`.
      properties:
        reference_date:
          type: string
          format: date-time
          description: >-
            A data e hora em que o saldo foi calculado para o instrumento de
            investimento, no formato `YYYY-MM-DDTHH:MM:SSZ`.
          example: '2022-07-21T17:32:00Z'
        gross_value:
          type: number
          format: float
          description: O valor bruto do instrumento de investimento.
          example: 1000
        blocked_amount:
          type: number
          format: float
          description: >-
            O montante do instrumento de investimento que está bloqueado ou
            indisponível para transações.
          example: 100
        quantity:
          type: number
          format: float
          pattern: ‘^-?\d{1,15}\.\d{2,8}$’
          description: >-
            O número de unidades, cotas ou ativos mantidos na data de
            referência.
          example: 100
        gross_unit_price:
          type: number
          format: float
          nullable: true
          pattern: ‘^-?\d{1,15}\.\d{2,8}$’
          description: O valor bruto unitário atual do investimento na data de referência
          example: 10
        net_value:
          type: number
          format: float
          nullable: true
          pattern: ‘^-?\d{1,15}\.\d{2,8}$’
          description: >-
            O valor líquido do investimento após deduções de impostos, taxas e
            outros encargos, na data de referência.
          example: 900
        withheld_amount:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: >-
            O valor do instrumento de investimento que foi retido ou deduzido do
            valor líquido.
          example: 10
        transaction_fee:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: As taxas e impostos cobrados pela transação.
          example: 5
        purchase_unit_price:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: O preço unitário no momento da compra do título ou ativo.
          example: 10
        pre_fixed_rate:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1}\.\d{6}$’
          description: A taxa de remuneração prefixada para o produto de renda.
          example: 0.05
        post_fixed_rate:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1}\.\d{6}$’
          description: A porcentagem do indexador pós-fixado para o produto de renda.
          example: 0.05
        penalty_fee:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: >-
            A penalidade (multa) por atrasos nos pagamentos, conforme definido
            no contrato.
          example: 10
        late_payment_fee:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: Os juros cobrados por pagamentos atrasados.
          example: 10
        closing_price:
          type: number
          format: float
          nullable: true
          pattern: ‘^-?\d{1,15}\.\d{2,8}$’
          description: O preço de fechamento do investimento na data de referência.
          example: 10
        unit_price_factor:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1,15}\.\d{2,4}$’
          description: O fator usado para calcular o preço unitário.
          example: 1
    Remuneration:
      type: object
      description: Os detalhes de remuneração do instrumento de investimento.
      properties:
        pre_fixed_rate:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1}\.\d{6}$’
          description: >-
            A taxa de juros fixa definida na emissão, expressa como um decimal
            (por exemplo, `0.150000` representa 15%).
          example: 0.05
        post_fixed_rate:
          type: number
          format: float
          nullable: true
          pattern: ‘^\d{1}\.\d{6}$’
          description: >-
            A taxa de juros pós-fixada definida na emissão, expressa como um
            decimal (por exemplo, `0.150000` representa 15%).
          example: 0.05
        rate_type:
          type: string
          nullable: true
          maxLength: 30
          pattern: '[\w\W-]*'
          description: >-
            O tipo de taxa de remuneração aplicada ao instrumento financeiro.
            Pode ser:
              - `LINEAR`
              - `EXPONENCIAL`
          example: LINEAR
        rate_periodicity:
          type: string
          nullable: true
          description: >-
            A frequência com que a taxa de remuneração é aplicada ao instrumento
            financeiro. Pode ser:
              - `DIARIO`
              - `MENSAL`
              - `ANUAL`
              - `SEMESTRAL`
          example: MENSAL
        calculation_base:
          type: string
          nullable: true
          maxLength: 30
          pattern: '[\w\W-]*'
          description: >-
            Indica se o cálculo de remuneração ou juros é baseado em dias úteis
            (*dias úteis*) ou dias corridos (*dias corridos*).

            - `DIAS_UTEIS`
              - `DIAS_CORRIDOS`
          example: DIAS_CORRIDOS
        indexer:
          type: string
          nullable: true
          maxLength: 30
          pattern: '[\w\W-]*'
          description: >-
            O índice usado como referência para calcular a rentabilidade ou
            retornos do instrumento financeiro. Pode ser um dos seguintes:
              - `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: >-
            Informações adicionais sobre a taxa do `indexer`. Necessário quando
            `indexer` está definido como `OUTROS`.
          example: IPCA + 5%
    ClassificationDetails:
      type: object
      nullable: true
      description: >-
        Os detalhes de classificação do instrumento de investimento.


        > 🚧 Aplicável apenas para investimentos do tipo `INVESTMENT_FUND`.

        >

        > Este objeto é aplicável apenas para investimentos do tipo
        `INVESTMENT_FUND`. Para todos os outros tipos de investimento, este
        objeto será `null`.
      properties:
        category:
          type: string
          nullable: true
          maxLength: 11
          description: >-
            A categoria do fundo de investimento, conforme definido pelos
            padrões de classificação da ANBIMA. Pode ser uma das seguintes:
              - `RENDA_FIXA`
              - `ACOES`
              - `MULTIMERCADO`
              - `CAMBIAL`
          example: ACOES
        class:
          type: string
          nullable: true
          maxLength: 70
          pattern: '[\w\W\s]*'
          description: >-
            A classe dentro da categoria do fundo de investimento, conforme
            definido pelos padrões de classificação da ANBIMA.
          example: Ações Livre
        subclass:
          type: string
          nullable: true
          maxLength: 70
          pattern: '[\w\W\s]*'
          description: >-
            A subclasse do fundo de investimento, conforme definido pelos
            padrões de classificação da ANBIMA.
          example: Ações Livre
    VoucherPaymentDetails:
      type: object
      title: Detalhes de Pagamento do Voucher
      description: >-
        Os detalhes do pagamento do voucher (também conhecido como pagamentos de
        cupom) do instrumento de investimento.


        > 🚧 Aplicável apenas para investimentos do tipo `FIXED_INCOME_CREDIT` e
        `TREASURY_BOND`.

        >

        > Este objeto é aplicável apenas para investimentos do tipo
        `FIXED_INCOME_CREDIT` e `TREASURY_BOND`. Para todos os outros tipos de
        investimento, este objeto será `null`.
      properties:
        is_voucher_payment:
          type: boolean
          description: >-
            Indica se o instrumento financeiro paga juros periódicos (pagamentos
            de cupom).
          example: true
        periodicity:
          type: string
          nullable: true
          description: >-
            A frequência com que os pagamentos de voucher são realizados.
            Necessário quando `is_voucher_payment` está definido como `true`.
            Pode ser um dos seguintes:
              - `MENSAL` 
              - `TRIMESTRAL` 
              - `SEMESTRAL` 
              - `ANUAL` 
              - `IRREGULAR` 
              - `OUTROS`
          example: MENSAL
        periodicity_additional_info:
          type: string
          nullable: true
          maxLength: 50
          pattern: '[\w\W\s]*'
          description: >-
            Informações adicionais sobre a periodicidade do pagamento do
            voucher. Obrigatório quando `periodicity` está definido como
            `OUTROS`.
          example: 30/360
    DebtorDetails:
      type: object
      nullable: true
      title: Detalhes do Devedor
      description: >-
        Os detalhes do devedor do instrumento de investimento.


        > 🚧 Aplicável apenas para investimentos do tipo `FIXED_INCOME_CREDIT`.

        >

        > Este objeto é aplicável apenas para investimentos do tipo
        `FIXED_INCOME_CREDIT`. Para todos os outros tipos de investimento, este
        objeto será `null`.
      properties:
        name:
          type: string
          maxLength: 70
          pattern: '[\w\W\s]*'
          description: O nome do devedor.
          example: Roberto Marino
        id_document_number:
          type: string
          maxLength: 14
          pattern: ‘^\d{14}$’
          description: O número do documento de identificação do devedor (CNPJ).
          example: 12345678901
    InvestmentBrazil:
      type: object
      title: Objeto de Investimentos (Brasil)
      x-tags:
        - Investments Brazil
      properties:
        id:
          type: string
          format: uuid
          description: >-
            O identificador único criado pela Belvo usado para referenciar o
            investimento atual.
          example: 5359ddc5-31fc-4346-934b-cc24630a8d06
        type:
          type: string
          description: |-
            O tipo de investimento: Pode 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: >-
            O número do CNPJ da instituição emissora. Para Fundos de
            Investimento, este é o CNPJ do fundo.


            > 🚧 Não aplicável para investimentos `TREASURY_BOND`.
          example: '10187609364567'
        isin_number:
          type: string
          nullable: true
          maxLength: 12
          pattern: ‘^[A-Z]{2}([A-Z0-9]){9}\d{1}$’
          description: >-
            O Número de Identificação de Valores Mobiliários Internacional
            (ISIN) ISO-6166 para o instrumento financeiro.
          example: BRCST4CTF001
        currency:
          type: string
          minLength: 3
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: >-
            O código de moeda de três letras (ISO-4217) do investimento. Por
            exemplo, `BRL` para Real Brasileiro.
          example: BRL
        product_name:
          type: string
          maxLength: 250
          description: >-
            O nome do produto de investimento.


            - Para `FIXED_INCOME_BANKING`, pode ser: CDB, RDB, LCI ou LCA.

            - Para `FIXED_INCOME_CREDIT`, pode ser: DEBÊNTURES, CRI ou CRA.

            - Para `INVESTMENT_FUND`, será o nome do fundo. Por exemplo:
            CONSTELLATION MASTER FIA

            - Para `TREASURY_BOND`, será o nome do título. Por exemplo: Tesouro
            Selic 2025.

            - Para `VARIABLE_INCOME_INCOME`, será o nome da ação. Por exemplo,
            AAPL.
          example: CONSTELLATION MASTER FIA
        is_tax_exempt:
          type: boolean
          description: |-
            Indica se o investimento é isento de impostos.

            > 🚧 Aplicável apenas para investimentos `FIXED_INCOME_CREDIT`.
          example: false
        clearing_code:
          type: string
          nullable: true
          maxLength: 30
          pattern: '[\w\W-]*'
          description: >-
            O código de compensação do investimento.


            > 🚧 Aplicável apenas para `FIXED_INCOME_BANKING` e
            `FIXED_INCOME_CREDIT`.
          example: CDB421GPXXX
        due_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data de vencimento do instrumento financeiro.


            > 🚧 Aplicável apenas para investimentos `FIXED_INCOME_BANKING`,
            `FIXED_INCOME_CREDIT` e `TREASURY_BOND`.
          example: '2022-01-01'
        issue_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data em que o instrumento financeiro foi emitido.


            > 🚧 Aplicável apenas para `FIXED_INCOME_BANKING` e
            `FIXED_INCOME_CREDIT`.
          example: '2021-01-01'
        purchase_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data em que o instrumento financeiro foi adquirido.


            > 🚧 Aplicável apenas para investimentos `FIXED_INCOME_BANKING`,
            `FIXED_INCOME_CREDIT` e `TREASURY_BOND`.
          example: '2021-01-01'
        grace_period_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data do período de carência do instrumento financeiro.


            > 🚧 Aplicável apenas para `FIXED_INCOME_BANKING` e
            `FIXED_INCOME_CREDIT`.
          example: '2021-01-01'
        issue_unit_price:
          type: number
          format: float
          nullable: true
          description: >-
            O preço unitário do instrumento financeiro no momento da emissão.


            > 🚧 Aplicável apenas para `FIXED_INCOME_BANKING` e
            `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 do Corretor
      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: >-
        Detalhes sobre a nota de corretagem associada a esta transação. Este
        objeto é retornado apenas para transações associadas a um tipo de
        investimento `VARIABLE_INCOME`.


        > 📘 Informações

        >

        > Uma nota de corretagem é um documento oficial emitido por uma
        corretora detalhando as transações realizadas por um investidor em um
        determinado dia. Inclui informações sobre o valor bruto de todas as
        compras e vendas, taxas de corretagem, taxas de compensação e
        liquidação, taxas de compensação e registro, taxas de aviso de
        negociação de ativos na bolsa, taxas de bolsa, taxas de custódia de
        compensação, impostos e imposto de renda retido na fonte.
      properties:
        broker_note_number:
          type: string
          pattern: ‘^\d{1,16}$’
          minLength: 1
          maxLength: 16
          description: O número da nota de corretagem.
          example: '1854009930314350'
        gross_value:
          type: number
          format: float
          description: O valor bruto de todas as compras e vendas do dia.
          example: 1000
        brokerage_fee:
          type: number
          format: float
          description: A taxa total de corretagem cobrada no dia.
          example: 10
        clearing_settlement_fee:
          type: number
          format: float
          description: A taxa cobrada para compensação e liquidação em custódia.
          example: 2.5
        clearing_registration_fee:
          type: number
          format: float
          description: A taxa cobrada para liquidação e registro em custódia.
          example: 1
        stock_exchange_asset_trade_notice_fee:
          type: number
          format: float
          description: >-
            A taxa cobrada pela bolsa de valores para notificações de negociação
            de ativos.
          example: 0.5
        stock_exchange_fee:
          type: number
          format: float
          description: A taxa cobrada pela bolsa de valores pelos serviços de registro.
          example: 3
        clearing_custody_fee:
          type: number
          format: float
          description: >-
            A taxa cobrada por instituições financeiras por serviços de
            custódia.
          example: 1.5
        taxes:
          type: number
          format: float
          description: >-
            O valor total dos impostos cobrados na transação do dia, excluindo o
            imposto de renda retido na fonte.
          example: 10
        income_tax:
          type: number
          format: float
          description: O valor total do imposto de renda retido na fonte para o dia.
          example: 5
        net_value:
          type: number
          format: float
          description: >-
            O valor líquido da nota de corretagem após a dedução das despesas
            com taxas de corretagem, taxas de liquidação de compensação, taxas
            de registro, taxas ANA, emolumentos, taxas de custódia, impostos e
            IRRF.
          example: 980
    InvestmentTransactionBrazil:
      type: object
      description: Detalhes sobre a transação de investimento.
      title: Objeto de Transação de Investimento (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: >-
            A identificação interna da instituição para a transação de
            investimento.
          example: ABCD2126019929279212650822221989319253344
        value_date:
          type: string
          format: date
          description: >-
            A data em que a transação foi liquidada, no formato `YYYY-MM-DD`.


            > 📘 `VARIABLE_INCOME`

            >

            > Para investimentos em `VARIABLE_INCOME`, você receberá transações
            apenas até a última data de negociação. Por exemplo, se hoje é
            19.11.2024, você receberá transações apenas até 18.11.2024.


            > 📘 `INVESTMENT_FUND`

            >

            > Para investimentos em `INVESTMENT_FUND`, esta é a data em que a
            transação (compra ou resgate) é oficialmente processada em cotas do
            fundo. Para compras, esta é a data em que o dinheiro do investidor é
            aplicado para adquirir cotas do fundo. Para resgates, esta é a data
            em que as cotas do fundo são oficialmente convertidas de volta em
            dinheiro.
          example: '2024-11-18'
        gross_value:
          type: number
          format: float
          pattern: ‘^-?\d{1,15}\.\d{2,4}$’
          description: |-
            O valor bruto da transação.

            > 🚧 Não aplicável para investimentos do tipo `VARIABLE_INCOME`.
          example: 60
        net_value:
          type: number
          format: float
          pattern: ‘^-?\d{1,15}\.\d{2,4}$’
          description: |-
            O valor líquido da transação.

            > 🚧 Não aplicável para investimentos do tipo `VARIABLE_INCOME`.
          example: 60
        value:
          type: number
          format: float
          description: >-
            O valor da transação.


            Para investimentos de **`VARIABLE_INCOME`**, este é o valor da
            negociação executada pelo cliente. Se o cliente compra ou vende
            ações, este campo indica o valor total da negociação (por exemplo, o
            preço por ação × quantidade).


            Para investimentos de **`INVESTMENT_FUND`**, este é o valor
            solicitado pelo cliente para uma transação de fundo.


            > 🚧 Aplicável apenas para investimentos de `VARIABLE_INCOME` e
            `INVESTMENT_FUND`.
          example: 60
        unit_price:
          type: number
          format: float
          description: O preço para uma unidade ou cota individual.
          example: 3
        price_factor:
          type: number
          format: float
          description: >-
            O número de unidades (ações) considerado ao calcular o preço por
            ação ou unidade para uma transação.


            > 🚧 Aplicável apenas para investimentos do tipo `VARIABLE_INCOME`.
          example: 1
        transaction_tax:
          type: number
          format: float
          description: >-
            O Imposto sobre Operações Financeiras (IOF) aplicado ou retido
            durante a transação.


            > 🚧 Não aplicável para investimentos em `VARIABLE_INCOME`.
          example: 0
        income_tax:
          type: number
          format: float
          description: >-
            O Imposto de Renda (*Income Tax (IR)*) aplicado ou retido durante a
            transação.


            > 🚧 Não aplicável para investimentos `VARIABLE_INCOME`.
          example: 0
        quantity:
          type: number
          format: float
          description: O número de unidades, cotas ou ativos envolvidos em uma transação.
          example: 20
        type:
          type: string
          enum:
            - INFLOW
            - OUTFLOW
            - 'null'
          description: >-
            O tipo de transação (`INFLOW` ou `OUTFLOW`) do ponto de vista do
            investimento.
          example: INFLOW
        subtype:
          type: string
          description: >-
            O subtipo de transação.


            - 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: >-
            Informações adicionais sobre o subtipo da transação. Este campo é
            obrigatório quando o subtipo é `OUTROS`.
          example: null
        indexer_percentage:
          type: number
          format: float
          description: >-
            A porcentagem máxima do indexador para o contrato (Bancaria) ou
            transação (Credito).


            > 🚧 Aplicável apenas para investimentos `FIXED_INCOME_BANKING` e
            `FIXED_INCOME_CREDIT`.
          example: 0
        rate:
          type: number
          format: float
          description: >-
            A taxa de remuneração aplicada à transação.


            > 🚧 Aplicável apenas para investimentos em `FIXED_INCOME_BANKING`,
            `FIXED_INCOME_CREDIT` e `TREASURY_BOND`.
          example: 0
        exit_fee:
          type: number
          format: float
          description: >-
            A taxa de saída aplicada à transação do Fundo de Investimento
            (Fundos de Investimento). Esta taxa é cobrada quando um cliente
            resgata ou sai do fundo.


            > 🚧 Aplicável apenas para investimentos do tipo `INVESTMENT_FUND`.
          example: 0
        broker_note_details:
          $ref: '#/components/schemas/BrokerNote'
    EnumEmploymentRecordStatus:
      type: string
      enum:
        - EMPLOYED
        - RETIRED
        - UNEMPLOYED
        - 'null'
      description: >-
        Indica o status de emprego do indivíduo. Retornamos uma das seguintes
        respostas:


        - `EMPLOYED`

        - `RETIRED`

        - `UNEMPLOYED`

        - `null`
      example: EMPLOYED
    EmploymentRecordEntitlement:
      type: object
      description: Detalhes sobre os benefícios aos quais o indivíduo tem direito.
      properties:
        entitled_to_health_insurance:
          type: boolean
          description: Indica se o indivíduo tem ou não direito a seguro de saúde.
          example: true
        entitled_to_company_benefits:
          type: boolean
          description: Indica se o indivíduo tem ou não direito aos benefícios da empresa.
          example: true
        valid_until:
          type: string
          nullable: true
          format: date
          description: >-
            Data até quando o indivíduo está coberto pelo seguro de saúde e/ou
            benefícios da empresa. Se for `null`, o funcionário está atualmente
            trabalhando e não é necessária uma data de término.
          example: null
        status:
          $ref: '#/components/schemas/EnumEmploymentRecordStatus'
    EnumEmploymentRecordDocumentType:
      type: string
      nullable: true
      enum:
        - NSS
        - CURP
        - RFC
      description: >-
        O tipo de documento relacionado ao indivíduo. Retornamos um dos
        seguintes valores:

          - `NSS`
          - `CURP`
          - `RFC`
      example: NSS
    EmploymentRecordDocumentId:
      type: object
      description: Detalhes sobre os documentos de identificação do indivíduo.
      properties:
        document_type:
          $ref: '#/components/schemas/EnumEmploymentRecordDocumentType'
        document_number:
          type: string
          nullable: true
          description: O número do documento de identidade (como uma string).
          example: '10277663582'
    EmploymentRecordPersonalData:
      type: object
      description: Detalhes sobre as informações pessoais do indivíduo.
      properties:
        official_name:
          type: string
          nullable: true
          description: O nome legal do indivíduo.
          example: Bruce Banner del Torro
        first_name:
          type: string
          nullable: true
          description: O primeiro nome do indivíduo.
          example: Bruce
        last_name:
          type: string
          nullable: true
          description: O sobrenome do indivíduo.
          example: Banner del Torro
        birth_date:
          type: string
          nullable: true
          format: date
          description: A data de nascimento do indivíduo, no formato `YYYY-MM-DD`.
          example: '2022-02-09'
        entitlements:
          $ref: '#/components/schemas/EmploymentRecordEntitlement'
        document_ids:
          type: array
          description: Detalhes sobre os documentos de identificação do indivíduo.
          items:
            $ref: '#/components/schemas/EmploymentRecordDocumentId'
        email:
          type: string
          nullable: true
          deprecated: true
          description: O endereço de e-mail do indivíduo.
          example: bruce.banner@avengers.com
    EmploymentRecordSocialSecuritySummary:
      type: object
      nullable: true
      description: >-
        Detalhes sobre as contribuições previdenciárias do indivíduo, de acordo
        com o IMSS.


        >**Nota**: Para o ISSSTE México, este valor retornará `null`.
      properties:
        weeks_redeemed:
          type: integer
          nullable: true
          format: int32
          description: >-
            Número de semanas que o indivíduo precisou retirar de sua
            aposentadoria.
          example: 0
        weeks_reinstated:
          type: integer
          nullable: true
          format: int32
          description: >-
            Número de semanas que o indivíduo contribuiu novamente para o seu
            fundo de pensão (*AFORE*), após tê-lo resgatado anteriormente.
          example: 0
        weeks_contributed:
          type: integer
          nullable: true
          format: int32
          description: >-
            Número de semanas que o indivíduo contribuiu para a sua previdência
            social, com base no número de semanas que o indivíduo trabalhou de
            acordo com o 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 o IMSS México, este é o evento que causou a mudança no status de
        emprego ou salário. Retornamos um dos seguintes valores:


        - `DISMISSED_RESIGNED`: O funcionário foi demitido ou pediu demissão.

        - `SALARY_MODIFICATION`: O funcionário recebeu uma modificação salarial
        (aumento ou diminuição).

        - `HIRED`: O funcionário foi contratado.

        - `VOLUNTARY_CONTRIBUTION`: O funcionário fez uma contribuição
        voluntária ao IMSS.

        - `ABSENCE`: O funcionário estava ausente (como em férias).

        - `SICK_LEAVE`: O funcionário estava de licença médica.


        Para o ISSSTE México, esta é a fonte de informação sobre a mudança no
        status de emprego ou salário. Retornamos um dos seguintes valores:


        - `NORMAL`: Indica que a informação foi recebida do **Instituto de
        Seguridad y Servicios Sociales de los Trabajadores del Estado
        (ISSSTE)**.

        - `BDUTA_CERTIFICATE`: Indica que a informação foi recebida do banco de
        dados central, **Base de Datos Única de Trabajadores Activos (BDUTA)**.

        - `DYE_CERTIFICATE`: Indica que a informação foi recebida de uma
        instituição afiliada, **Dependencia y Entidad (DYE)**.
      example: HIRED
    EmploymentRecordEmploymentStatusUpdates:
      type: object
      description: Detalhes sobre quaisquer mudanças de emprego do indivíduo.
      nullable: true
      properties:
        event:
          $ref: '#/components/schemas/EnumEmploymentRecordStatusUpdateEvents'
        base_salary:
          type: number
          format: float
          description: |-
            O salário base do indivíduo, atualizado na `update_date`.

              - Para o IMSS México, esse valor é calculado incluindo os benefícios aos quais o indivíduo tem direito ao longo do ano.
              - Para o ISSSTE México, esse valor é calculado excluindo os benefícios do indivíduo.
          example: 1033.09
        update_date:
          type: string
          format: date
          description: A data em que o evento de emprego ocorreu, no formato `YYYY-MM-DD`.
          example: '2021-09-01'
    EmploymentRecordDetail:
      type: object
      description: Detalhes sobre o histórico de emprego do indivíduo.
      properties:
        collected_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 quando o ponto de dados foi
            coletado.
          example: '2020-04-23T21:32:55.336854+00:00'
        employer:
          type: string
          description: >-
            O nome oficial do empregador.


            >**Nota**: Para o ISSSTE México, este é o nome oficial da entidade
            junto com a entidade responsável por gerenciar as informações do
            empregado, separados por um ponto e vírgula (`;`). Por exemplo:
            SECRETARIA DE EDUCACION PUBLICA (SEP);SECRETARIA DE EDUCACION
            PUBLICA (SEP).
          example: Batman Enterprises CDMX
        employer_id:
          type: string
          nullable: true
          description: |-
            O ID oficial do empregador, de acordo com o país.

            >**Nota**: Para ISSSTE México, este valor retornará `null`.
          example: 780-BAT-88769-CDMX
        start_date:
          type: string
          format: date
          description: Data de início do emprego, no formato `YYYY-MM-DD`.
          example: '2019-10-10'
        end_date:
          type: string
          nullable: true
          format: date
          description: >-
            Data de término do emprego, no formato `YYYY-MM-DD`.


            >**Nota**: Este campo retornará `null` para o emprego atual do
            usuário.
          example: '2019-12-31'
        weeks_employed:
          type: integer
          format: int32
          description: Número de semanas em que o indivíduo esteve empregado.
          example: 12
        state:
          type: string
          nullable: true
          description: >-
            Em que estado geográfico o indivíduo estava empregado, de acordo com
            o país.


            >**Nota**: Para ISSSTE México, este valor retornará `null`.
          example: DISTRITO FEDERAL
        most_recent_base_salary:
          type: number
          format: float
          description: >-
            O salário base mais recente que o indivíduo recebeu.


            - Para o IMSS México, esse valor é calculado incluindo os benefícios
            aos quais o indivíduo tem direito ao longo do ano.

            - Para o ISSSTE México, esse valor é calculado dividindo o
            `monthly_salary` por 30 (dias) e exclui os benefícios do indivíduo.
          example: 762.54
        monthly_salary:
          type: number
          format: float
          description: >-
            O salário mensal do indivíduo, incluindo quaisquer benefícios
            adicionais.


            - Para o IMSS México, este valor é calculado incluindo os benefícios
            aos quais o indivíduo tem direito ao longo do ano.

            - Para o ISSSTE México, este valor é calculado excluindo os
            benefícios.
        currency:
          type: string
          description: O código de moeda de três letras em que o salário é pago.
          example: MXN
        employment_status_updates:
          type: array
          nullable: true
          description: Detalhes sobre quaisquer mudanças de emprego do indivíduo.
          items:
            $ref: '#/components/schemas/EmploymentRecordEmploymentStatusUpdates'
    EmploymentRecordScore:
      type: object
      description: >-
        O score de emprego fornece uma visão sobre a empregabilidade e o
        potencial de geração de renda em um determinado período.
      properties:
        score:
          type: integer
          nullable: true
          minimum: 300
          maximum: 900
          description: >-
            Uma pontuação entre 300 e 900 que fornece uma visão sobre a
            empregabilidade e o potencial de geração de renda.


            - Uma pontuação baixa (próxima de 300) pode indicar uma
            empregabilidade e potencial de geração de renda previstos mais
            baixos, sugerindo possíveis desafios para conseguir emprego ou
            alcançar níveis de renda mais altos no futuro.

            - Uma pontuação alta (próxima de 900) pode sugerir uma maior
            probabilidade de conseguir emprego e gerar níveis de renda mais
            altos.


            A pontuação pode retornar `null` se o indivíduo não tiver histórico
            de emprego.
          example: 612
        period:
          type: integer
          minimum: 1
          maximum: 12
          description: >-
            O número de meses (no futuro) para os quais a pontuação é calculada.


            Por exemplo, um período de `6` indica que a pontuação é calculada
            para os próximos `6` meses.


            > **Nota**: Atualmente, a Belvo calcula a pontuação para 3, 6 e 12
            meses.
          example: 6
        version:
          type: string
          description: >-
            A versão do nosso modelo de pontuação de emprego usada para realizar
            o cálculo.
          example: 1.0.0
    EmploymentRecordFile:
      type: object
      description: Arquivos binários PDF adicionais relacionados ao emprego do indivíduo.
      properties:
        type:
          type: string
          description: O título do documento.
          example: ReporteSemanasCotizadas_190123
        value:
          type: string
          nullable: true
          description: |-
            O binário PDF do arquivo (como uma string).

            > **Nota**: Em nosso ambiente sandbox, este campo retornará `null`.
          example: '=PDF_BINARY='
    EmploymentRecord:
      type: object
      description: Carga útil de resposta do registro de emprego
      title: Objeto de Registro de Emprego (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: >-
            A data em que o relatório de registro de emprego foi gerado, no
            formato `YYYY-MM-DD`.
          example: '2023-01-19'
        internal_identification:
          type: string
          description: >-
            ID único para o usuário de acordo com a instituição. Para IMSS e
            ISSSTE México, este é o CURP.
          example: BLPM951331IONVGR54
        personal_data:
          $ref: '#/components/schemas/EmploymentRecordPersonalData'
        social_security_summary:
          $ref: '#/components/schemas/EmploymentRecordSocialSecuritySummary'
        employment_records:
          type: array
          description: Detalhes sobre o histórico de emprego do indivíduo.
          items:
            $ref: '#/components/schemas/EmploymentRecordDetail'
        employment_scores:
          type: array
          nullable: true
          description: >-
            Um array de pontuações de `employment_record`. Cada pontuação
            fornece uma visão sobre a empregabilidade e o potencial de geração
            de renda em um determinado período.


            > **Nota 1**: Este campo está disponível apenas para links criados
            com o IMSS do México. Para outras instituições, este campo retornará
            `null`.


            > **Nota 2**: Este campo retornará `null` para registros de emprego
            recuperados antes de 16-04-2024. Para registros de emprego gerados
            antes de 16-04-2024, será necessário fazer uma nova solicitação POST
            para recuperar os registros de emprego e calcular as pontuações.
          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: >-
            Arquivos binários PDF adicionais relacionados ao emprego do
            indivíduo.
          items:
            $ref: '#/components/schemas/EmploymentRecordFile'
    attach_pdf:
      type: boolean
      default: false
      description: >-
        Quando definido como `true`, você receberá o PDF em formato binário na
        resposta.
      example: true
    EmployerDataBrazil:
      type: object
      description: Detalhes sobre o empregador.
      additionalProperties: false
      required:
        - name
        - code
        - economic_activity
      properties:
        name:
          type: string
          minLength: 5
          description: O nome do empregador.
          example: Wayne Industries
        code:
          type: string
          minLength: 8
          maxLength: 14
          description: O código único da instituição para o empregador.
          example: '49430669'
        economic_activity:
          type: string
          minLength: 4
          description: >-
            A principal atividade econômica em que o empregador está envolvido.
            Para o Brasil, este é o código da *Classificação Nacional de
            Atividades Econômicas* (CNAE).
          example: 6421-2 - BANCOS COMERCIAIS
    OccupationBrazil:
      type: object
      description: Detalhes sobre a ocupação que o funcionário tinha no empregador.
      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: >-
            A data em que o funcionário começou na posição, no 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: >-
            A data em que o funcionário parou de trabalhar nesta posição, no
            formato `YYYY-MM-DD`. Se for `null`, isso significa que o
            funcionário ainda ocupa esta posição.
          example: '2023-01-01'
        description:
          type: string
          minLength: 5
          description: >-
            A posição que o funcionário ocupava. Para o Brasil, essa descrição
            deve estar de acordo com o Ministério do Trabalho e listada na
            *Classificação Brasileira de Ocupações* (CBO).
          example: ANALISTA DE PRODUTOS BANCARIOS
        name:
          type: string
          minLength: 5
          description: A ocupação dos funcionários, conforme fornecida pelo empregador.
          example: ANALISTA DE PRODUTOS BANCARIOS - 2525-40
        locale:
          type: string
          description: >-
            Onde o funcionário cumpriu suas funções. Para o Brasil, isso pode
            ser:
              - `Urbana` (Urbano)
              - `Rural`
              - `Não Identificado`
              - `null`
          example: Urbana
    EnumEmploymentSalaryType:
      type: string
      nullable: true
      enum:
        - REGULAR
        - THIRTEENTH
        - null
      description: |-
        O tipo de salário.

        Retornamos um dos seguintes valores:
          - `REGULAR`
          - `THIRTEENTH`
          - `null`
      example: REGULAR
    SalaryBrazil:
      type: object
      description: Detalhes sobre o salário que o funcionário recebeu do empregador.
      additionalProperties: false
      required:
        - base_amount
        - retained_amount
        - month
        - currency
      properties:
        base_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor base do salário, antes de quaisquer deduções ou bônus.
          example: 1033.09
        retained_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: >-
            O valor retido pelo *Instituto Nacional do Seguro Social* (INSS) do
            Brasil.
          example: 0.01
        type:
          $ref: '#/components/schemas/EnumEmploymentSalaryType'
        month:
          type: string
          minLength: 7
          maxLength: 7
          pattern: ^\d{4}-\d{2}$
          description: >-
            O mês em que o funcionário recebeu seu salário, no formato
            `YYYY-MM`.
          example: 2022-01
        currency:
          type: string
          minLength: 3
          maxLength: 3
          pattern: ^[A-Z]{3}$
          description: O código de moeda de três letras (ISO-4217).
          example: BRL
    EmploymentBrazil:
      type: object
      description: >-
        Detalhes sobre o emprego que o funcionário teve em um determinado
        empregador.
      title: Objeto 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: >-
            A data de início do funcionário no empregador, no 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: >-
            A data de término do funcionário na empresa, no formato
            `YYYY-MM-DD`. Se for `null`, o funcionário ainda está trabalhando na
            empresa.
          example: '2023-01-01'
        employer_data:
          $ref: '#/components/schemas/EmployerDataBrazil'
        occupations:
          type: array
          description: As ocupações do funcionário no empregador.
          items:
            $ref: '#/components/schemas/OccupationBrazil'
        salaries:
          type: array
          description: Os salários que o funcionário recebeu do empregador.
          items:
            $ref: '#/components/schemas/SalaryBrazil'
    EnumIncomeStreamType:
      type: string
      enum:
        - SALARY
        - GOVERNMENT
        - INTEREST
        - RENT
        - RETIREMENT
        - FREELANCE
        - ALTERNATIVE_INCOME
        - TRANSFER
        - DEPOSIT
        - UNKNOWN
      description: |-
        O tipo de renda usado nos cálculos.

        Retornamos um dos seguintes valores do enum:

          - `SALARY`
          - `GOVERNMENT`
          - `INTEREST`
          - `RENT`
          - `RETIREMENT`
          - `FREELANCE`
          - `ALTERNATIVE_INCOME`
          - `TRANSFER`
          - `DEPOSIT`
          - `UNKNOWN`
      example: SALARY
    EnumIncomeStreamFrequency:
      type: string
      enum:
        - MONTHLY
        - FORTNIGHTLY
        - WEEKLY
        - IRREGULAR
        - SINGLE
      description: >-
        Com que frequência a renda é recebida.


        Retornamos um dos seguintes valores do enum:


        - `MONTHLY` - Para transações que ocorrem uma vez por mês.

        - `FORTNIGHTLY` - Para transações que ocorrem uma vez a cada duas
        semanas.

        - `WEEKLY` - Para transações que ocorrem uma vez por semana.

        - `IRREGULAR` - Para transações que não ocorrem em um padrão de
        frequência definido.

        - `SINGLE` - Para transações que ocorrem apenas uma vez e não se
        repetem.
      example: MONTHLY
    EnumIncomeStreamConfidence:
      type: string
      enum:
        - HIGH
        - MEDIUM
        - LOW
      description: |-
        Nível de confiança da Belvo para rendas futuras.

        Retornamos um dos seguintes valores do 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: |-
        Uma lista de fontes de renda para a conta.

        Para cada fonte de renda, fornecemos insights adicionais, como:
        - Frequência, estabilidade e nível de confiança das transações de renda.
        - Métricas principais sobre os valores das transações.
        ℹ️ Se nenhuma fonte de renda for encontrada, retornamos um array vazio.
      properties:
        account_id:
          type: string
          description: >-
            ID único para a conta bancária a ser verificada para fluxos de
            renda.
          example: EBACA-89077589
        income_type:
          $ref: '#/components/schemas/EnumIncomeStreamType'
        frequency:
          $ref: '#/components/schemas/EnumIncomeStreamFrequency'
        monthly_average:
          type: number
          format: float
          description: >-
            A quantidade média de renda recebida da fonte durante
            `periods_with_income`.
          example: 2500
        monthly_median:
          type: number
          format: float
          description: >-
            A quantidade mediana de renda recebida da fonte ao longo de um mês
            natural.
          example: 2200
        average_income_amount:
          type: number
          format: float
          description: O valor médio da transação de renda da fonte.
          example: 2500
        last_income_amount:
          type: number
          format: float
          description: O valor da renda mais recente recebida da fonte.
          example: 2500
        currency:
          type: string
          description: |-
            O código de moeda de três letras da receita. Por exemplo:

              • 🇧🇷 BRL (Real Brasileiro)
              • 🇨🇴 COP (Peso Colombiano)
              • 🇲🇽 MXN (Peso Mexicano)
          example: BRL
        last_income_description:
          type: string
          description: A descrição da receita mais recente do stream.
          example: Salário
        last_income_date:
          type: string
          format: date
          description: >-
            A data em que a receita mais recente do stream foi recebida, no
            formato `YYYY-MM-DD`.
          example: '2023-02-09'
        stability:
          type: number
          nullable: true
          format: float
          description: >-
            A estabilidade da renda com base em seu valor, com um intervalo de 0
            a 1, onde 1 representa estabilidade perfeita.


            **Nota:** Para transações com `frequency`=`SINGLE`, este valor
            retorna `null`.
          example: 1
        regularity:
          type: number
          nullable: true
          format: float
          description: >-
            A regularidade da renda é baseada em sua frequência, com um
            intervalo de 0 a 1, onde 1 representa regularidade perfeita.


            **Nota:** Para transações com `frequency`=`SINGLE`, este valor
            retorna `null`.
          example: 1
        trend:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de renda durante um período de tempo é calculada entre a
            última renda e a primeira renda recebida, onde:
              - um número float negativo significa que a tendência de renda está diminuindo durante o período de tempo.
              - um número float positivo significa que a tendência de renda está aumentando durante o período de tempo.

            **Nota:** Para transações com `frequency`=`SINGLE`, este valor
            retorna `null`.
          example: 0
        lookback_periods:
          type: integer
          format: int32
          description: >-
            Número de unidades de período (com base em *meses móveis*) usadas
            para gerar insights e cálculos.


            **Nota:** Um *mês móvel* é um período de 30 dias. Por exemplo, de
            2023-01-15 a 2023-02-15.
          example: 9
        full_periods:
          type: integer
          format: int32
          description: >-
            Número de unidades de período (baseado em *meses móveis*) com dados
            para realizar cálculos.


            **Nota:** Um *mês móvel* é um período de 30 dias. Por exemplo, de
            2023-01-15 a 2023-02-15.
          example: 9
        periods_with_income:
          type: integer
          format: int32
          description: >-
            Número de unidades de período (com base em *meses móveis*) com pelo
            menos uma receita disponível.


            **Nota:** Um *mês móvel* é um período de 30 dias. Por exemplo, de
            2023-01-15 a 2023-02-15.
          example: 9
        number_of_incomes:
          type: integer
          format: int32
          description: Número de transações de renda durante os `lookback_periods`.
          example: 9
        confidence:
          $ref: '#/components/schemas/EnumIncomeStreamConfidence'
    EnumIncomeSourceType:
      type: string
      enum:
        - BANK
      description: |-
        O tipo de fonte da qual geramos insights de renda.
        Retornamos um dos seguintes valores de enum:

          - `BANK`
      example: BANK
    Income:
      type: object
      description: Percepções de renda
      title: Objeto de Income
      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: Um array de objetos de fluxo de renda enriquecidos.
          items:
            $ref: '#/components/schemas/IncomeStreamsBody'
        income_source_type:
          $ref: '#/components/schemas/EnumIncomeSourceType'
        first_transaction_date:
          type: string
          nullable: true
          format: date
          description: A data em que a primeira transação ocorreu, no formato `YYYY-MM-DD`.
          example: '2022-06-09'
        last_transaction_date:
          type: string
          format: date
          description: A data em que a última transação ocorreu, no formato `YYYY-MM-DD`.
          example: '2023-02-09'
        best_working_day_to_charge:
          type: integer
          format: int32
          description: O melhor dia útil do mês para cobrar o usuário.
          example: 22
        good_working_days_to_charge:
          type: array
          minItems: 0
          maxItems: 3
          items:
            type: integer
            format: int32
          description: >-
            Dias úteis adicionais que foram identificados como bons dias para
            cobrar o usuário.
          example:
            - 17
            - 7
            - 2
        number_of_income_streams:
          type: integer
          format: int32
          description: Número total de fluxos de renda analisados.
          example: 1
        monthly_average:
          type: number
          format: float
          description: >-
            Valor médio de renda recebida por mês em todas as contas para o
            usuário específico.
          example: 2500
        monthly_average_regular:
          type: number
          format: float
          description: >-
            Valor médio de renda regular (com uma frequência de `MONTHLY`,
            `FORTNIGHTLY` ou `WEEKLY`) recebida por mês para o usuário
            específico.
          example: 2500
        monthly_average_irregular:
          type: number
          format: float
          description: >-
            Valor médio de renda irregular (com uma frequência de `SINGLE` ou
            `IRREGULAR`) recebida por mês para o usuário específico.
          example: 0
        monthly_average_low_confidence:
          type: number
          format: float
          description: >-
            Valor médio de renda recebida por mês para o usuário específico com
            confiança `LOW`.
          example: 0
        monthly_average_medium_confidence:
          type: number
          format: float
          description: >-
            Valor médio de renda recebida por mês para o usuário específico com
            confiança `MEDIUM`.
          example: 0
        monthly_average_high_confidence:
          type: number
          format: float
          description: >-
            Valor médio de renda recebida por mês para o usuário específico com
            confiança `HIGH`.
          example: 2500
        total_income_amount:
          type: number
          format: float
          description: Valor total de toda a receita recebida para o usuário específico.
          example: 22500
        total_regular_income_amount:
          type: number
          format: float
          description: >-
            Valor total da renda regular (com uma frequência de `MONTHLY`,
            `FORTNIGHTLY`, `WEEKLY`) para o usuário específico.
          example: 22500
        total_irregular_income_amount:
          type: number
          format: float
          description: >-
            Valor total da renda irregular (com uma frequência de `SINGLE` ou
            `IRREGULAR`) para o usuário específico.
          example: 0
        total_low_confidence:
          type: number
          format: float
          description: Valor total de renda para o usuário específico com confiança `LOW`.
          example: 0
        total_medium_confidence:
          type: number
          format: float
          description: >-
            Quantidade total de renda para o usuário específico com confiança
            `MEDIUM`.
          example: 0
        total_high_confidence:
          type: number
          format: float
          description: Valor total de renda para o usuário específico com confiança `HIGH`.
          example: 22500
    EnumInvoiceAllowedIncomeTypesRequest:
      type: string
      enum:
        - SALARY
        - GOVERNMENT
        - INTEREST
        - RENT
        - RETIREMENT
        - FREELANCE
        - ALTERNATIVE_INCOME
        - TRANSFER
        - DEPOSIT
        - UNKNOWN
      description: >-
        As categorias de rendimentos para as quais você deseja obter
        informações.


        Você pode enviar um ou mais dos seguintes valores:
          - `SALARY`
          - `GOVERNMENT`
          - `INTEREST`
          - `RENT`
          - `RETIREMENT`
          - `FREELANCE`
          - `ALTERNATIVE_INCOME`
          - `TRANSFER`
          - `DEPOSIT`
          - `UNKNOWN`
      example: SALARY
    EnumIncomeMinimumConfidenceLevelRequest:
      type: string
      enum:
        - HIGH
        - MEDIUM
        - LOW
      description: >-
        O nível mínimo de confiança das receitas para as quais você deseja obter
        informações.


        Você pode enviar um dos seguintes 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: |-
        O tipo de conta.  
        Retornamos um dos seguintes valores do 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: Detalhes sobre os saldos atual e disponível para a conta.
      properties:
        current:
          type: number
          nullable: true
          format: float
          description: >-
            O saldo atual é calculado de maneira diferente de acordo com o tipo
            de conta.


            - **💰 Contas correntes e poupança**:


            O saldo da conta do usuário no timestamp `collected_at`.


            - **💳 Cartões de crédito**:


            O valor que o usuário gastou no período de faturamento atual do
            cartão (consulte `credit_data.cutting_date` para informações sobre
            quando o período de faturamento atual termina).


            - **🏡 Contas de empréstimo**:


            O valor restante a pagar no empréstimo do usuário.
          example: 5874.13
        available:
          type: number
          nullable: true
          format: float
          description: >-
            O saldo que o proprietário da conta pode usar.


            - **💰 Contas correntes e poupança**:


            O saldo disponível pode ser diferente do saldo `current` devido a
            transações pendentes.


            - **💳 Cartões de crédito**:


            O valor de crédito que o usuário ainda tem disponível para o período
            atual. O saldo `available` pode ser diferente do saldo `current`
            devido a transações pendentes ou parcelas futuras.


            - **🏡 Contas de empréstimo**:


            O valor presente necessário para quitar o empréstimo, conforme
            fornecido pela instituição.


            **Nota:** Se a instituição não fornecer este valor, retornamos
            `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: As opções de crédito associadas a esta conta.
      properties:
        credit_limit:
          type: number
          nullable: true
          format: float
          example: 192000
          description: O valor máximo de crédito que o proprietário pode receber.
        collected_at:
          $ref: '#/components/schemas/collected_at'
        cutting_date:
          type: string
          nullable: true
          example: '2019-12-11'
          description: >-
            A data de encerramento do período de crédito, no formato
            `YYYY-MM-DD`.
        next_payment_date:
          type: string
          description: >-
            A data de vencimento para o próximo pagamento, no formato
            `YYYY-MM-DD`.
          example: '2019-12-13'
        minimum_payment:
          type: number
          nullable: true
          format: float
          example: 2400.3
          description: O valor mínimo a ser pago na `next_payment_date`.
        no_interest_payment:
          type: number
          nullable: true
          format: float
          example: 2690.83
          description: O valor mínimo necessário para pagar para evitar a geração de juros.
        interest_rate:
          type: number
          nullable: true
          format: float
          description: A taxa de juros anualizada do crédito.
          example: 4
        monthly_payment:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *O pagamento mensal recorrente, se aplicável.*
          example: null
        last_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *A data em que o último pagamento de crédito foi realizado, no
            formato `YYYY-MM-DD`.*
          example: null
        last_period_balance:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *O saldo restante após o `last_payment_date`.*
          example: null
    EnumLoanDataInterestRateType:
      type: string
      nullable: true
      enum:
        - MONTHLY
        - YEARLY
      description: >-
        O período em que o juro é aplicado ao empréstimo. Retornamos um dos
        seguintes valores:

          - `MONTHLY`
          - `YEARLY`
      example: MONTHLY
    AccountsLoanDataInterestRate:
      type: object
      required:
        - name
        - type
        - value
      description: Detalhamento dos juros aplicados ao empréstimo.
      properties:
        name:
          type: string
          nullable: true
          description: O nome do tipo de taxa de juros aplicada ao empréstimo.
          example: jurosEfetivo
        type:
          $ref: '#/components/schemas/EnumLoanDataInterestRateType'
        value:
          type: number
          nullable: true
          format: float
          description: A taxa de juros (em porcentagem ou valor monetário).
          example: 7.85
    EnumLoanDataFeeType:
      type: string
      enum:
        - OPERATION_FEE
        - INSURANCE_FEE
        - OTHERS
      description: |-
        O tipo de taxa. Retornamos um dos seguintes valores:

          - `OPERATION_FEE`
          - `INSURANCE_FEE`
          - `OTHERS`
      example: OPERATION_FEE
    AccountsLoanDataFees:
      type: object
      nullable: true
      required:
        - type
        - value
      description: Detalhamento das taxas aplicadas ao empréstimo.
      properties:
        type:
          $ref: '#/components/schemas/EnumLoanDataFeeType'
        value:
          type: number
          format: float
          description: O valor total da taxa. Mesma moeda do Empréstimo.
          example: 5.6
    AccountsLoanData:
      type: object
      nullable: true
      required:
        - principal
        - monthly_payment
        - outstanding_balance
        - interest_rates
        - collected_at
      description: As opções de empréstimo associadas a esta conta.
      properties:
        collected_at:
          $ref: '#/components/schemas/collected_at'
        contract_amount:
          type: number
          nullable: true
          format: float
          description: >-
            O valor total inicial do empréstimo, calculado pela instituição,
            quando o contrato foi assinado. Este valor inclui o principal +
            juros + impostos + taxas.
          example: 202000
        principal:
          type: number
          nullable: true
          format: float
          description: Valor total do empréstimo (o valor que o usuário recebe).
          example: 192000
        loan_type:
          type: string
          nullable: true
          description: O tipo do empréstimo, de acordo com a instituição.
          example: Consignado
        payment_day:
          type: string
          nullable: true
          description: >-
            O dia do mês em que o proprietário precisa pagar o empréstimo
            (`DD`).
          example: '27'
        outstanding_principal:
          type: number
          nullable: true
          format: float
          description: >-
            Montante pendente do empréstimo, ou seja, quanto resta a pagar sobre
            o principal (não incluindo juros).
          example: 142023
        outstanding_balance:
          type: number
          nullable: true
          format: float
          description: O valor restante a pagar no total, incluindo juros.
          example: 182000
        monthly_payment:
          type: number
          nullable: true
          format: float
          description: O pagamento mensal recorrente, se aplicável.
          example: 1000
        interest_rates:
          type: array
          nullable: true
          description: Detalhamento dos juros aplicados ao empréstimo.
          items:
            $ref: '#/components/schemas/AccountsLoanDataInterestRate'
        fees:
          type: array
          nullable: true
          description: Detalhamento das taxas aplicadas ao empréstimo.
          items:
            $ref: '#/components/schemas/AccountsLoanDataFees'
        number_of_installments_total:
          type: integer
          nullable: true
          format: int32
          description: O número total de parcelas necessárias para pagar o empréstimo.
          example: 60
        number_of_installments_outstanding:
          type: integer
          nullable: true
          format: int32
          description: O número de parcelas restantes para pagar.
          example: 48
        contract_start_date:
          type: string
          nullable: true
          description: >-
            A data em que o contrato de empréstimo foi assinado, no formato
            `YYYY-MM-DD`.
          example: '2020-03-01'
        contract_end_date:
          type: string
          format: date
          description: >-
            A data em que se espera que o empréstimo seja concluído, no formato
            `YYYY-MM-DD`.
          example: '2027-10-01'
        contract_number:
          type: string
          nullable: true
          description: >-
            O número do contrato do empréstimo, conforme fornecido pela
            instituição.
          example: 890ASLDJF87SD00
        credit_limit:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            Por favor, consulte `principal` em vez disso.
          example: null
        last_period_balance:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            Por favor, consulte `outstanding_balance` em vez disso.
          example: null
        interest_rate:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            Por favor, consulte o objeto `interest_rates`.
          example: null
        limit_day:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            Consulte `payment_day` em vez disso.
          example: null
        cutting_day:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre campos
            descontinuados.*


            O dia de fechamento do mês para o empréstimo.
          example: null
        cutting_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            A data de encerramento do período do empréstimo, no formato
            `YYYY-MM-DD`.
          example: null
        last_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            A data em que o último pagamento do empréstimo foi realizado, no
            formato `YYYY-MM-DD`.
        next_payment_date:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            Por favor, use `payment_day` em vez disso, no formato `YYYY-MM-DD`.
          example: null
        no_interest_payment:
          type: number
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            O valor mínimo necessário para pagar e evitar a geração de juros.
          example: null
    AccountsFundsDataPublicIdentifications:
      type: object
      required:
        - name
        - value
      properties:
        name:
          type: string
          description: O tipo de número de identificação para o fundo.
          example: CNPJ
        value:
          type: string
          nullable: true
          description: O número de identificação do fundo.
          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: O nome do fundo de pensão.
        type:
          type: string
          nullable: true
          example: CNPJ
          description: Tipo de fundo de pensão.
        public_identifications:
          type: array
          nullable: true
          description: Os IDs públicos do fundo.
          items:
            $ref: '#/components/schemas/AccountsFundsDataPublicIdentifications'
        balance:
          type: number
          nullable: true
          format: float
          example: 88427.94
          description: O montante no fundo.
        percentage:
          type: number
          nullable: true
          format: float
          example: 100
          description: >-
            Quanto este fundo, em porcentagem, contribui para o total da conta
            de pensão.
    Account:
      type: object
      nullable: true
      title: Contas Padrão (Multi-Região)
      description: >-
        Detalhes sobre a conta.


        **Nota**: Para o nosso recurso de despesas recorrentes, esta conta está
        relacionada à conta que foi analisada para gerar o relatório de despesas
        recorrentes.
      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 se esta conta é um `ASSET` ou um `LIABILITY`. Você pode
            considerar o saldo de um `ASSET` como positivo, enquanto o saldo de
            um `LIABILITY` como negativo.
          example: ASSET
        type:
          type: string
          nullable: true
          description: O tipo de conta, conforme designado pela instituição.
          example: Cuentas de efectivo
        name:
          type: string
          nullable: true
          description: O nome da conta, conforme fornecido pela instituição.
          example: Cuenta Perfiles- M.N. - MXN-666
        number:
          type: string
          nullable: true
          description: O número da conta, conforme designado pela instituição.
          example: '4057068115181'
        balance:
          $ref: '#/components/schemas/AccountsBalance'
        currency:
          type: string
          nullable: true
          description: >-
            A moeda da conta. Por exemplo:

            - 🇧🇷 BRL (Real Brasileiro)

            - 🇨🇴 COP (Peso Colombiano)

            - 🇲🇽 MXN (Peso Mexicano)


            Por favor, note que outras moedas além das listadas acima podem ser
            retornadas.
          example: MXN
        public_identification_name:
          type: string
          nullable: true
          description: >-
            O nome público para o tipo de identificação. Por exemplo: `"CLABE"`.


            ℹ️ Para contas de poupança e corrente 🇧🇷 brasileiras, este campo
            será `AGENCY/ACCOUNT`.
          example: CLABE
        public_identification_value:
          type: string
          nullable: true
          description: >-
            O valor para o `public_identification_name`.


            ℹ️ Para contas de poupança e corrente brasileiras, este campo será o
            número da agência e da conta bancária, separados por uma barra. Por
            exemplo: `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: Um ou mais fundos que contribuem para a conta de pensão.
          items:
            $ref: '#/components/schemas/AccountsFundsData'
        bank_product_id:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuações, consulte nossa explicação sobre Campos
            descontinuados.*


            *O ID de produto da instituição para o tipo de conta.*
          example: null
        internal_identification:
          deprecated: true
          type: string
          nullable: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *Identificação interna da instituição para a conta.*
          example: null
    RecurringExpenseSourceTransaction:
      type: object
      nullable: true
      required:
        - amount
        - description
        - value_date
      description: >-
        Um array de objetos de transação minificados usado para avaliar a
        despesa recorrente. Se nenhuma transação for encontrada, retornamos um
        array vazio.
      properties:
        amount:
          type: number
          format: float
          description: O valor da transação.
          example: 2145.45
        description:
          type: string
          nullable: true
          description: >-
            A descrição da transação fornecida pela instituição. Normalmente,
            este é o texto que o usuário final veria no extrato bancário. A
            descrição pode ser uma string vazia.


            **Nota:** Para o EYOD Risk Insights, a descrição é aquela que você
            forneceu na solicitação inicial.
          example: Netflix.com/march
        value_date:
          type: string
          format: date
          description: A data em que a transação ocorreu, no formato `YYYY-MM-DD`.
          example: '2019-10-23'
    EnumRecurringExpenseFrequency:
      type: string
      enum:
        - MONTHLY
      default: MONTHLY
      description: |-
        A frequência com que essa despesa recorrente ocorre.

        ℹ️ **Nota:** A Belvo identifica apenas frequências `MONTHLY`.
      example: MONTHLY
    EnumRecurringExpenseCategory:
      type: string
      enum:
        - Bills & Utilities
        - Credits & Loans
        - Insurance
        - Online Platforms & Leisure
        - Transport & Travel
        - Taxes
      description: >-
        A categoria de transação para a despesa recorrente. Para mais
        informações sobre as categorias disponíveis, consulte nossa <a
        href="https://developers.belvo.com/docs/banking#categorizing-transactions"
        target="_blank">documentação de categorização de transações</a>.


        - `Online Platforms & Leisure` (Netflix, Spotify, Assinaturas de
        Academia)

        - `Bills & Utilities` (eletricidade, telefone, internet)

        - `Credits & Loans` (adiantamentos de cartão de crédito, empréstimo
        estudantil, leasing de embarcações)

        - `Insurance` (seguro residencial, automotivo, e de saúde & vida)

        - `Transport & Travel` (viagem de Uber, airbnb, estacionamento)

        - `Taxes` (taxa de serviço, doação, impostos judiciais)
      example: Online Platforms & Leisure
    EnumRecurringExpensePaymentType:
      type: string
      nullable: true
      enum:
        - SUBSCRIPTION
        - REGULAR
      description: |-
        O tipo de despesa recorrente. Retornamos um dos seguintes valores:

          - `SUBSCRIPTION`
          - `REGULAR`
      example: SUBSCRIPTION
    RecurringExpenses:
      type: object
      title: Objeto de Despesas Recorrentes
      x-tags:
        - Recurring Expenses
      required:
        - account
        - name
        - transactions
        - frequency
        - average_transaction_amount
        - median_transaction_amount
        - days_since_last_transaction
        - category
        - payment_type
      description: >-
        Insights sobre despesas recorrentes.


        ℹ️ Se nenhuma informação sobre despesas recorrentes for encontrada,
        retornamos um array vazio.
      properties:
        id:
          $ref: '#/components/schemas/id'
        account:
          $ref: '#/components/schemas/Account'
        name:
          type: string
          nullable: true
          default: null
          description: >-
            O nome para a despesa recorrente.


            ℹ️ **Nota**: Esta informação é retirada da seção de descrição de uma
            transação e, em seguida, normalizada para fornecer um nome de fácil
            leitura. Assim, às vezes o nome refletirá o comerciante para o qual
            o pagamento é feito (por exemplo, Netflix.com), enquanto para outras
            despesas recorrentes, isso pode ser algo como "Pagamento mensal para
            John".
          example: Netflix
        transactions:
          type: array
          description: >-
            Um array de objetos de transação minificados usado para avaliar a
            despesa recorrente. Se nenhuma transação for encontrada, retornamos
            um array vazio.
          items:
            $ref: '#/components/schemas/RecurringExpenseSourceTransaction'
        frequency:
          $ref: '#/components/schemas/EnumRecurringExpenseFrequency'
        average_transaction_amount:
          type: number
          format: float
          description: O valor médio da transação da despesa recorrente.
          example: 32.9
        median_transaction_amount:
          type: number
          format: float
          description: O valor mediano da transação da despesa recorrente.
          example: 32.9
        days_since_last_transaction:
          type: integer
          format: int32
          description: >-
            Número de dias desde que a última despesa recorrente ocorreu.


            Com base na frequência, você pode inferir quantos dias faltam até
            que a próxima cobrança ocorra.
          example: 5
        category:
          $ref: '#/components/schemas/EnumRecurringExpenseCategory'
        payment_type:
          $ref: '#/components/schemas/EnumRecurringExpensePaymentType'
    RiskInsightsAssetMetrics:
      type: object
      nullable: true
      description: >-
        Agregue detalhes sobre os ativos utilizados na análise de percepção de
        risco. Para métricas de ativos, consideramos apenas contas correntes e
        contas de poupança.


        > As métricas de ativos podem fornecer uma visão geral da riqueza e dos
        ativos líquidos do seu usuário, indicando como eles gerenciam sua
        riqueza e seu status financeiro atual.
      required:
        - institutions
        - num_accounts
        - num_checking_accounts
        - num_savings_accounts
        - checking_accounts_balance
        - savings_accounts_balance
      properties:
        institutions:
          type: array
          nullable: true
          description: >-
            Um array de instituições das quais as informações da conta foram
            recuperadas para o usuário.


            > **Nota**: Para a maioria dos casos de uso, este array retornará
            apenas um item.
          items:
            type: string
            description: O nome da instituição
            example: erebor_mx_retail
          example:
            - erebor_mx_retail
        num_assets_accounts:
          type: integer
          nullable: true
          format: int32
          description: O número total de contas encontradas para o usuário.
          example: 1
        num_checking_accounts:
          type: integer
          nullable: true
          format: int32
          description: O número total de contas correntes encontradas para o usuário.
          example: 1
        num_savings_accounts:
          type: integer
          nullable: true
          format: int32
          description: O número total de contas poupança encontradas para o usuário.
          example: 1
        checking_accounts_balance:
          type: number
          nullable: true
          format: float
          description: O saldo total de fechamento de todas as contas correntes.
          example: 35901.46
        savings_accounts_balance:
          type: number
          nullable: true
          format: float
          description: O saldo total de fechamento de todas as contas poupança.
          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 com base nas contas de cartão de crédito
        do usuário.


        > As métricas de cartão de crédito ilustram os hábitos de um cliente em
        relação aos cartões de crédito, revelando quantas contas de cartão de
        crédito um cliente possui, seu limite de crédito total, quanto desse
        limite está sendo utilizado e a taxa de utilização do limite do cartão
        de crédito.
      properties:
        num_accounts:
          type: integer
          format: int32
          minimum: 0
          description: Número de contas de cartões de crédito associadas ao usuário.
          example: 2
        sum_credit_limit:
          type: number
          nullable: true
          format: float
          description: Soma total de todos os limites dos cartões de crédito.
          example: 106560
        sum_credit_used:
          type: number
          nullable: true
          format: float
          description: Soma total de todo o crédito utilizado.
          example: 101020.14
        credit_card_limit_utilization:
          type: number
          nullable: true
          format: float
          description: A porcentagem do limite do cartão de crédito utilizado.
          example: 0.95
    RiskInsightsLoansMetrics:
      type: object
      nullable: true
      description: >-
        Métricas agregadas calculadas com base nas contas de empréstimo do
        usuário e contas correntes que possuem cheque especial.


        > As métricas de empréstimo ajudam a entender o comportamento de
        empréstimo e reembolso de um cliente, o que pode ajudar a avaliar sua
        capacidade de assumir crédito adicional e os potenciais riscos de
        inadimplência.
      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: O número de contas de empréstimo associadas ao usuário.
          example: 1
        sum_loans_principal:
          type: number
          nullable: true
          format: float
          description: >-
            Soma total do principal para todas as contas de empréstimo do
            usuário.
          example: 5000
        sum_loans_outstanding_principal:
          type: number
          nullable: true
          format: float
          description: >-
            Soma total do principal pendente para todas as contas de empréstimo
            do usuário.
          example: 2000
        sum_loans_monthly_payment:
          type: number
          nullable: true
          format: float
          description: >-
            Soma total dos pagamentos mensais de todas as contas de empréstimo
            do usuário.
          example: 400
        loan_limit_utilization:
          type: number
          nullable: true
          format: float
          description: A porcentagem do limite do empréstimo utilizado.
          example: 0.3
        overdraft_limit:
          type: number
          nullable: true
          format: float
          description: >-
            O limite total de cheque especial de todas as contas correntes e de
            poupança.
          example: 900
        overdraft_limit_utilization:
          type: number
          nullable: true
          format: float
          description: A porcentagem do limite de cheque especial utilizado.
          example: 0.4
    RiskInsightsBalanceMetrics:
      type: object
      nullable: true
      description: >-
        Métricas de saldo calculadas com base nos saldos do usuário em contas
        correntes e de poupança.
      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: O saldo de todas as contas no momento `collected_at`.
          example: 35901.46
        min_balance_3d:
          type: number
          nullable: true
          format: float
          description: O saldo mínimo nos últimos três dias.
          example: 35417.68
        min_balance_1w:
          type: number
          nullable: true
          format: float
          description: O saldo mínimo na última semana).
          example: 34150.5
        min_balance_1m:
          type: number
          nullable: true
          format: float
          description: O saldo mínimo no último mês.
          example: 33990.59
        min_balance_3m:
          type: number
          nullable: true
          format: float
          description: O saldo mínimo nos últimos três meses.
          example: 33990.59
        min_balance_6m:
          type: number
          nullable: true
          format: float
          description: O saldo mínimo nos últimos seis meses.
          example: 33990.59
        min_balance_12m:
          type: number
          nullable: true
          format: float
          description: O saldo mínimo nos últimos doze meses.
          example: 33990.59
        mean_balance_3d:
          type: number
          nullable: true
          format: float
          description: O saldo médio nos últimos três dias.
          example: 35659.57
        mean_balance_1w:
          type: number
          nullable: true
          format: float
          description: O saldo médio na última semana.
          example: 35077.1
        mean_balance_1m:
          type: number
          nullable: true
          format: float
          description: O saldo médio no último mês.
          example: 34816.08
        mean_balance_3m:
          type: number
          nullable: true
          format: float
          description: O saldo médio nos últimos três meses.
          example: 34816.08
        mean_balance_6m:
          type: number
          nullable: true
          format: float
          description: O saldo médio nos últimos seis meses.
          example: 34816.08
        mean_balance_12m:
          type: number
          nullable: true
          format: float
          description: O saldo médio nos últimos doze meses.
          example: 34816.08
        max_balance_3d:
          type: number
          nullable: true
          format: float
          description: O saldo máximo nos últimos três dias.
          example: 35901.46
        max_balance_1w:
          type: number
          nullable: true
          format: float
          description: O saldo máximo na última semana.
          example: 35901.46
        max_balance_1m:
          type: number
          nullable: true
          format: float
          description: O saldo máximo no último mês.
          example: 35901.46
        max_balance_3m:
          type: number
          nullable: true
          format: float
          description: O saldo máximo nos últimos três meses.
          example: 35901.46
        max_balance_6m:
          type: number
          nullable: true
          format: float
          description: O saldo máximo nos últimos seis meses.
          example: 35901.46
        max_balance_12m:
          type: number
          nullable: true
          format: float
          description: O saldo máximo nos últimos doze meses.
          example: 35901.46
        std_balance_3d:
          type: number
          nullable: true
          format: float
          description: O desvio padrão do saldo nos últimos três dias.
          example: 279.31
        std_balance_1w:
          type: number
          nullable: true
          format: float
          description: O desvio padrão do saldo na última semana.
          example: 764.03
        std_balance_1m:
          type: number
          nullable: true
          format: float
          description: O desvio padrão do saldo no último mês.
          example: 586.55
        std_balance_3m:
          type: number
          nullable: true
          format: float
          description: O desvio padrão do saldo nos últimos três meses.
          example: 586.55
        std_balance_6m:
          type: number
          nullable: true
          format: float
          description: O desvio padrão do saldo nos últimos seis meses.
          example: 586.55
        std_balance_12m:
          type: number
          nullable: true
          format: float
          description: O desvio padrão do saldo nos últimos doze meses.
          example: 586.55
        balance_trend_3d:
          type: number
          nullable: true
          format: float
          description: A tendência de saldo do usuário nos últimos três dias.
          example: 193.51
        balance_trend_1w:
          type: number
          nullable: true
          format: float
          description: A tendência de saldo do usuário na última semana.
          example: 290.18
        balance_trend_1m:
          type: number
          nullable: true
          format: float
          description: A tendência de saldo do usuário no último mês.
          example: 22.6
        balance_trend_3m:
          type: number
          nullable: true
          format: float
          description: A tendência de saldo do usuário nos últimos três meses.
          example: 22.6
        balance_trend_6m:
          type: number
          nullable: true
          format: float
          description: A tendência de saldo do usuário nos últimos seis meses.
          example: 22.6
        balance_trend_12m:
          type: number
          nullable: true
          format: float
          description: A tendência de saldo do usuário nos últimos doze meses.
          example: 22.6
        days_balance_below_0_3d:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual a 0
            nos últimos três dias.
          example: 0
        days_balance_below_0_1w:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual a 0
            na última semana.
          example: 0
        days_balance_below_0_1m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual a 0
            no último mês.
          example: 0
        days_balance_below_0_3m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual a 0
            nos últimos três meses.
          example: 0
        days_balance_below_0_6m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual a 0
            nos últimos seis meses.
          example: 0
        days_balance_below_0_12m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual a 0
            nos últimos doze meses.
          example: 0
        days_balance_below_mean_3d:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo médio da conta é menor ou igual ao
            valor especificado em `mean_daily_balance_3d`.
          example: 2
        days_balance_below_mean_1w:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo médio da conta é menor ou igual ao
            valor especificado em `mean_daily_balance_1w`.
          example: 3
        days_balance_below_mean_1m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo médio da conta é menor ou igual ao
            valor especificado em `mean_daily_balance_1m`.
          example: 17
        days_balance_below_mean_3m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo médio da conta é menor ou igual ao
            valor especificado em `mean_daily_balance_3m`.
          example: 17
        days_balance_below_mean_6m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo médio da conta é menor ou igual ao
            valor especificado em `mean_daily_balance_6m`.
          example: 17
        days_balance_below_mean_12m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo médio da conta é menor ou igual ao
            valor especificado em `mean_daily_balance_12m`.
          example: 17
        days_balance_below_x_3d:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual ao
            valor especificado em `balance_threshold_x` nos últimos três dias.
          example: 0
        days_balance_below_x_1w:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual ao
            valor especificado em `balance_threshold_x` na última semana.
          example: 0
        days_balance_below_x_1m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual ao
            valor especificado em `balance_threshold_x` no último mês.
          example: 0
        days_balance_below_x_3m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual ao
            valor especificado em `balance_threshold_x` nos últimos três meses.
          example: 0
        days_balance_below_x_6m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual ao
            valor especificado em `balance_threshold_x` nos últimos seis meses.
          example: 0
        days_balance_below_x_12m:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de dias em que o saldo total da conta é menor ou igual ao
            valor especificado em `balance_threshold_x` nos últimos doze meses.
          example: 0
        balance_threshold_x:
          type: number
          format: float
          description: >-
            O limite usado para calcular `days_balance_below_x_period`. Por
            favor, note que este valor é específico para cada país (tanto em
            termos de quantia quanto de moeda).
          example: 1000
    RiskInsightsTransactionMetrics:
      type: object
      nullable: true
      description: >-
        Métricas agregadas calculadas com base nas transações do usuário em
        contas correntes, poupança, cartão de crédito e empréstimo.


        > ℹ️ **Nota**

        >

        > Se não houver dados transacionais suficientes para um determinado
        período, retornamos `null` para campos calculados e `0` para campos
        baseados em contagem. Por exemplo, se a conta foi aberta há apenas cinco
        dias (ou se você forneceu dados apenas para cinco dias), retornamos
        valores para `_3d`, `_1w` e `_1m`, no entanto:

        > 

        > - `mean_num_transactions_3m` retornará `null`, pois não há dados para
        os meses dois e três (campo calculado).

        > - `num_transactions_3m` retornará `0`, pois não há dados para os meses
        dois e três (campo baseado em contagem).
      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: >-
            O número total de transações analisadas para determinar as
            percepções de risco nos últimos três dias (entradas e saídas).
          example: 26
        num_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: >-
            O número total de transações analisadas para determinar as
            percepções de risco da última semana (entradas e saídas).
          example: 46
        num_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: >-
            O número total de transações analisadas para determinar as
            percepções de risco do último mês (entradas e saídas).
          example: 168
        num_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: >-
            O número total de transações analisadas para determinar as
            percepções de risco nos últimos três meses (entradas e saídas).
          example: 460
        num_transactions_6m:
          type: integer
          format: int32
          default: 670
          description: >-
            O número total de transações analisadas para determinar as
            percepções de risco nos últimos seis meses (entradas e saídas).
          example: 472
        num_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: >-
            O número total de transações analisadas para determinar as
            percepções de risco nos últimos doze meses (entradas e saídas).
          example: 496
        max_num_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações nos últimos três dias.
          example: 10
        max_num_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações da última semana.
          example: 10
        max_num_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações do último mês.
          example: 18
        max_num_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações nos últimos três meses.
          example: 18
        max_num_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações nos últimos seis meses.
          example: 18
        max_num_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações nos últimos doze meses.
          example: 18
        mean_num_transactions_3d:
          type: number
          format: float
          default: 0
          description: O número médio de transações nos últimos três dias.
          example: 6.5
        mean_num_transactions_1w:
          type: number
          format: float
          default: 0
          description: O número médio de transações da última semana.
          example: 5.75
        mean_num_transactions_1m:
          type: number
          format: float
          default: 0
          description: O número médio de transações do último mês.
          example: 5.42
        mean_num_transactions_3m:
          type: number
          format: float
          default: 0
          description: O número médio de transações nos últimos três meses.
          example: 5.05
        mean_num_transactions_6m:
          type: number
          format: float
          default: 0
          description: O número médio de transações nos últimos seis meses.
          example: 2.61
        mean_num_transactions_12m:
          type: number
          format: float
          default: 0
          description: O número médio de transações nos últimos doze meses.
          example: 1.37
        num_incoming_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: O número total de transações de entrada nos últimos três dias.
          example: 12
        num_incoming_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: O número total de transações de entrada na última semana.
          example: 21
        num_incoming_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: O número total de transações de entrada do último mês.
          example: 80
        num_incoming_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: O número total de transações de entrada nos últimos três meses.
          example: 229
        num_incoming_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: O número total de transações de entrada nos últimos seis meses.
          example: 238
        num_incoming_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: O número total de transações de entrada nos últimos doze meses.
          example: 256
        max_num_incoming_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de entrada nos últimos três dias.
          example: 6
        max_num_incoming_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de entrada na última semana.
          example: 6
        max_num_incoming_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de entrada no último mês.
          example: 10
        max_num_incoming_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de entrada nos últimos três meses.
          example: 10
        max_num_incoming_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de entrada nos últimos seis meses.
          example: 10
        max_num_incoming_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de entrada nos últimos doze meses.
          example: 10
        mean_num_incoming_transactions_3d:
          type: number
          format: float
          default: 0
          description: O número médio de transações de entrada nos últimos três dias.
          example: 3
        mean_num_incoming_transactions_1w:
          type: number
          format: float
          default: 0
          description: O número médio de transações de entrada na última semana.
          example: 2.62
        mean_num_incoming_transactions_1m:
          type: number
          format: float
          default: 0
          description: O número médio de transações de entrada no último mês.
          example: 2.58
        mean_num_incoming_transactions_3m:
          type: number
          format: float
          default: 0
          description: O número médio de transações de entrada nos últimos três meses.
          example: 2.52
        mean_num_incoming_transactions_6m:
          type: number
          format: float
          default: 0
          description: O número médio de transações de entrada nos últimos seis meses.
          example: 1.31
        mean_num_incoming_transactions_12m:
          type: number
          format: float
          default: 0
          description: O número médio de transações de entrada nos últimos doze meses.
          example: 0.71
        sum_incoming_amount_3d:
          type: number
          nullable: true
          format: float
          description: >-
            A soma total de todas as transações de entrada dos últimos três
            dias.
          example: 17142.16
        sum_incoming_amount_1w:
          type: number
          nullable: true
          format: float
          description: A soma total de todas as transações de entrada da última semana.
          example: 24825.92
        sum_incoming_amount_1m:
          type: number
          nullable: true
          format: float
          description: A soma total de todas as transações de entrada do último mês.
          example: 75993.36
        sum_incoming_amount_3m:
          type: number
          nullable: true
          format: float
          description: >-
            A soma total de todas as transações de entrada dos últimos três
            meses.
          example: 198197.28
        sum_incoming_amount_6m:
          type: number
          nullable: true
          format: float
          description: >-
            A soma total de todas as transações de entrada dos últimos seis
            meses.
          example: 223697.28
        sum_incoming_amount_12m:
          type: number
          nullable: true
          format: float
          description: >-
            A soma total de todas as transações de entrada dos últimos doze
            meses.
          example: 274697.28
        max_incoming_amount_3d:
          type: number
          nullable: true
          format: float
          description: A transação de entrada de maior valor nos últimos três dias.
          example: 3000
        max_incoming_amount_1w:
          type: number
          nullable: true
          format: float
          description: A transação de entrada de maior valor na última semana.
          example: 3000
        max_incoming_amount_1m:
          type: number
          nullable: true
          format: float
          description: A transação de entrada de maior valor no último mês.
          example: 3000
        max_incoming_amount_3m:
          type: number
          nullable: true
          format: float
          description: A transação de entrada de maior valor nos últimos três meses.
          example: 3000
        max_incoming_amount_6m:
          type: number
          nullable: true
          format: float
          description: A transação de entrada de maior valor nos últimos seis meses.
          example: 3000
        max_incoming_amount_12m:
          type: number
          nullable: true
          format: float
          description: A transação de entrada de maior valor nos últimos doze meses.
          example: 3000
        mean_incoming_amount_3d:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio de entrada de todas as transações nos últimos três
            dias.
          example: 1428.51
        mean_incoming_amount_1w:
          type: number
          nullable: true
          format: float
          description: O valor médio de entrada de todas as transações na última semana.
          example: 1182.19
        mean_incoming_amount_1m:
          type: number
          nullable: true
          format: float
          description: O valor médio de entrada de todas as transações no último mês.
          example: 949.92
        mean_incoming_amount_3m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio de entrada de todas as transações nos últimos três
            meses.
          example: 865.49
        mean_incoming_amount_6m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio de entrada de todas as transações nos últimos seis
            meses.
          example: 939.9
        mean_incoming_amount_12m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio de entrada de todas as transações nos últimos doze
            meses.
          example: 1073.04
        num_outgoing_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: Para o número total de transações de saída nos últimos três dias.
          example: 14
        num_outgoing_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: Para o número total de transações de saída na última semana.
          example: 25
        num_outgoing_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: Total de transações de saída no último mês.
          example: 88
        num_outgoing_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: Total de transações de saída nos últimos três meses.
          example: 231
        num_outgoing_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: Para o número total de transações de saída nos últimos seis meses.
          example: 234
        num_outgoing_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: Total de transações de saída nos últimos doze meses.
          example: 240
        max_num_outgoing_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de saída nos últimos três dias.
          example: 6
        max_num_outgoing_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de saída na última semana.
          example: 6
        max_num_outgoing_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de saída no último mês.
          example: 8
        max_num_outgoing_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de saída nos últimos três meses.
          example: 9
        max_num_outgoing_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de saída nos últimos seis meses.
          example: 9
        max_num_outgoing_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: O número máximo de transações de saída nos últimos doze meses.
          example: 9
        mean_num_outgoing_transactions_3d:
          type: number
          format: float
          default: 0
          description: O número médio de transações de saída nos últimos três dias.
          example: 3.5
        mean_num_outgoing_transactions_1w:
          type: number
          format: float
          default: 0
          description: O número médio de transações de saída na última semana.
          example: 3.12
        mean_num_outgoing_transactions_1m:
          type: number
          format: float
          default: 0
          description: O número médio de transações de saída no último mês.
          example: 2.84
        mean_num_outgoing_transactions_3m:
          type: number
          format: float
          default: 0
          description: O número médio de transações de saída nos últimos três meses.
          example: 2.54
        mean_num_outgoing_transactions_6m:
          type: number
          format: float
          default: 0
          description: O número médio de transações de saída nos últimos seis meses.
          example: 1.29
        mean_num_outgoing_transactions_12m:
          type: number
          format: float
          default: 0
          description: O número médio de transações de saída nos últimos doze meses.
          example: 0.66
        sum_outgoing_amount_3d:
          type: number
          nullable: true
          format: float
          description: A soma total de todas as transações de saída dos últimos três dias.
          example: 18246.95
        sum_outgoing_amount_1w:
          type: number
          nullable: true
          format: float
          description: A soma total de todas as transações de saída da última semana.
          example: 26362.25
        sum_outgoing_amount_1m:
          type: number
          nullable: true
          format: float
          description: A soma total de todas as transações de saída do último mês.
          example: 78243.82
        sum_outgoing_amount_3m:
          type: number
          nullable: true
          format: float
          description: A soma total de todas as transações de saída dos últimos três meses.
          example: 192608.77
        sum_outgoing_amount_6m:
          type: number
          nullable: true
          format: float
          description: A soma total de todas as transações de saída dos últimos seis meses.
          example: 201608.77
        sum_outgoing_amount_12m:
          type: number
          nullable: true
          format: float
          description: A soma total de todas as transações de saída dos últimos doze meses.
          example: 219608.77
        max_outgoing_amount_3d:
          type: number
          nullable: true
          format: float
          description: A transação de saída de maior valor nos últimos três dias.
          example: 3000
        max_outgoing_amount_1w:
          type: number
          nullable: true
          format: float
          description: A transação de saída de maior valor na última semana.
          example: 3000
        max_outgoing_amount_1m:
          type: number
          nullable: true
          format: float
          description: A transação de saída de maior valor no último mês.
          example: 3000
        max_outgoing_amount_3m:
          type: number
          nullable: true
          format: float
          description: A transação de saída de maior valor nos últimos três meses.
          example: 3000
        max_outgoing_amount_6m:
          type: number
          nullable: true
          format: float
          description: A transação de saída de maior valor nos últimos seis meses.
          example: 3000
        max_outgoing_amount_12m:
          type: number
          nullable: true
          format: float
          description: A transação de saída de maior valor nos últimos doze meses.
          example: 3000
        mean_outgoing_amount_3d:
          type: number
          nullable: true
          format: float
          description: O valor médio de saída de todas as transações nos últimos três dias.
          example: 1303.35
        mean_outgoing_amount_1w:
          type: number
          nullable: true
          format: float
          description: O valor médio de saída de todas as transações na última semana.
          example: 1054.49
        mean_outgoing_amount_1m:
          type: number
          nullable: true
          format: float
          description: O valor médio de saída de todas as transações no último mês.
          example: 889.13
        mean_outgoing_amount_3m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio de saída de todas as transações nos últimos três
            meses.
          example: 833.8
        mean_outgoing_amount_6m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio de saída de todas as transações nos últimos seis
            meses.
          example: 861.58
        mean_outgoing_amount_12m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio de saída de todas as transações nos últimos doze
            meses.
          example: 915.04
        days_without_transactions_3d:
          type: integer
          format: int32
          default: 0
          description: >-
            O número de dias em que nenhuma transação ocorreu nos últimos três
            dias.
          example: 0
        days_without_transactions_1w:
          type: integer
          format: int32
          default: 0
          description: O número de dias em que não ocorreram transações na última semana.
          example: 0
        days_without_transactions_1m:
          type: integer
          format: int32
          default: 0
          description: O número de dias em que não ocorreram transações no último mês.
          example: 0
        days_without_transactions_3m:
          type: integer
          format: int32
          default: 0
          description: >-
            O número de dias em que não ocorreram transações nos últimos três
            meses.
          example: 0
        days_without_transactions_6m:
          type: integer
          format: int32
          default: 0
          description: >-
            O número de dias em que não ocorreram transações nos últimos seis
            meses.
          example: 87
        days_without_transactions_12m:
          type: integer
          format: int32
          default: 0
          description: >-
            O número de dias em que não ocorreram transações nos últimos doze
            meses.
          example: 261
        days_since_last_transaction:
          type: integer
          format: int32
          default: 0
          description: O número de dias desde que a última transação ocorreu.
          example: 0
        days_since_last_incoming_transaction:
          type: integer
          format: int32
          default: 0
          description: O número de dias desde que a última transação de entrada ocorreu.
          example: 0
        days_since_last_outgoing_transaction:
          type: integer
          format: int32
          default: 0
          description: O número de dias desde que a última transação de saída ocorreu.
          example: 0
        days_history:
          type: integer
          format: int32
          default: 0
          description: >-
            O número de dias entre a solicitação de insight de risco e a
            primeira transação.
          example: 365
    RiskInsightsCashflowMetrics:
      type: object
      nullable: true
      description: >-
        Métricas agregadas calculadas com base nas transações do usuário em
        contas correntes, poupança, de crédito e de empréstimo. No entanto,
        transferências internas (transferências entre contas pertencentes ao
        mesmo link) não são usadas no cálculo.


        {% admonition type="info" %}
          Se não houver dados transacionais suficientes para um determinado período, retornamos `null`. Por exemplo, se a conta foi aberta há apenas 15 dias (ou você forneceu dados apenas para 15 dias), retornamos valores para `_3d`, `_1w` e `_1m`, no entanto, para `_3m` retornaremos `null`, pois não há dados para os meses dois e três.
        {% /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: >-
            O maior valor de transações de fluxo de caixa positivo nos últimos
            três dias.
          example: 1850.12
        max_positive_1w:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa positivo na semana
            passada.
          example: 3808.99
        max_positive_1m:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa positivo no mês
            passado.
          example: 4012.61
        max_positive_3m:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa positivo nos últimos
            três meses.
          example: 5001.08
        max_positive_6m:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa positivo nos últimos
            seis meses.
          example: 8500
        max_positive_12m:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa positivo nos últimos
            doze meses.
          example: 8500
        max_negative_3d:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa negativo nos últimos
            três dias.
          example: 3375.43
        max_negative_1w:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa negativo na última
            semana.
          example: 3375.43
        max_negative_1m:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa negativo no último
            mês.
          example: 5305.92
        max_negative_3m:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa negativo nos últimos
            três meses.
          example: 7535.85
        max_negative_6m:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa negativo nos últimos
            seis meses.
          example: 7535.85
        max_negative_12m:
          type: number
          nullable: true
          format: float
          description: >-
            O maior valor de transações de fluxo de caixa negativo nos últimos
            doze meses.
          example: 7535.85
        mean_positive_3d:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa positivo nos últimos
            três dias.
          example: 1410.54
        mean_positive_1w:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa positivo na última
            semana.
          example: 1665.74
        mean_positive_1m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa positivo no último
            mês.
          example: 1827.36
        mean_positive_3m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa positivo nos últimos
            três meses.
          example: 1881.58
        mean_positive_6m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa positivo nos últimos
            seis meses.
          example: 2102.19
        mean_positive_12m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa positivo nos últimos
            doze meses.
          example: 2502.06
        mean_negative_3d:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa negativo nos últimos
            três dias.
          example: 3373.48
        mean_negative_1w:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa negativo na última
            semana.
          example: 2477.04
        mean_negative_1m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa negativo no último
            mês.
          example: 1904.96
        mean_negative_3m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa negativo nos últimos
            três meses.
          example: 1838.47
        mean_negative_6m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa negativo nos últimos
            seis meses.
          example: 1877.63
        mean_negative_12m:
          type: number
          nullable: true
          format: float
          description: >-
            O valor médio das transações de fluxo de caixa negativo nos últimos
            doze meses.
          example: 1948.51
        sum_positive_3d:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            positivo nos últimos três dias.
          example: 5642.16
        sum_positive_1w:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            positivo na última semana.
          example: 13325.92
        sum_positive_1m:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            positivo no último mês.
          example: 52993.36
        sum_positive_3m:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            positivo nos últimos três meses.
          example: 163697.28
        sum_positive_6m:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            positivo nos últimos seis meses.
          example: 189197.28
        sum_positive_12m:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            positivo nos últimos doze meses.
          example: 240197.28
        sum_positive_trend_3d:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa positivo com base na soma de todas as
            transações positivas nos últimos três dias.
          example: 98.902
        sum_positive_trend_1w:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa positivo com base na soma de todas as
            transações positivas na última semana.
          example: -84.0393
        sum_positive_trend_1m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa positivo com base na soma de todas as
            transações positivas no último mês.
          example: 22.7315
        sum_positive_trend_3m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa positivo com base na soma de todas as
            transações positivas nos últimos três meses.
          example: 1.8398
        sum_positive_trend_6m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa positivo com base na soma de todas as
            transações positivas nos últimos seis meses.
          example: -17.1869
        sum_positive_trend_12m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa positivo com base na soma de todas as
            transações positivas nos últimos doze meses.
          example: -25.9856
        sum_negative_3d:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            negativo nos últimos três dias.
          example: 6746.95
        sum_negative_1w:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            negativo na última semana.
          example: 14862.25
        sum_negative_1m:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            negativo no último mês.
          example: 55243.82
        sum_negative_3m:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            negativo nos últimos três meses.
          example: 158108.77
        sum_negative_6m:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            negativo nos últimos seis meses.
          example: 167108.77
        sum_negative_12m:
          type: number
          nullable: true
          format: float
          description: >-
            O total de todas as transações que resultaram em um fluxo de caixa
            negativo nos últimos doze meses.
          example: 185108.77
        sum_negative_trend_3d:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa negativo com base na soma de todas as
            transações negativas nos últimos três dias.
          example: -3.91
        sum_negative_trend_1w:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa negativo com base na soma de todas as
            transações negativas na última semana.
          example: 254.2517
        sum_negative_trend_1m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa negativo com base na soma de todas as
            transações negativas no último mês.
          example: 58.376
        sum_negative_trend_3m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa negativo com base na soma de todas as
            transações negativas nos últimos três meses.
          example: 2.5895
        sum_negative_trend_6m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa negativo com base na soma de todas as
            transações negativas nos últimos seis meses.
          example: -1.4824
        sum_negative_trend_12m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de fluxo de caixa negativo com base na soma de todas as
            transações negativas nos últimos doze meses.
          example: -4.2394
        positive_to_negative_ratio_3d:
          type: number
          nullable: true
          format: float
          description: >-
            A razão entre sum_positive / sum_negative nos últimos três dias.


            ℹ️ Se a razão for maior que `1`, isso significa que o usuário tem
            mais entradas do que saídas, indicando que ele gasta menos do que
            ganha.


            **Nota**: No caso de não haver transações de saída, o valor será
            `null`.
          example: 0.84
        positive_to_negative_ratio_1w:
          type: number
          nullable: true
          format: float
          description: >-
            A razão entre sum_positive / sum_negative na última semana.


            ℹ️ Se a razão for maior que `1`, isso significa que o usuário tem
            mais entradas do que saídas, indicando que ele gasta menos do que
            ganha.


            **Nota**: No caso de não haver transações de saída, o valor será
            `null`.
          example: 0.9
        positive_to_negative_ratio_1m:
          type: number
          nullable: true
          format: float
          description: >-
            A razão entre sum_positive / sum_negative no último mês.


            ℹ️ Se a razão for maior que `1`, isso significa que o usuário tem
            mais receitas do que despesas, indicando que ele gasta menos do que
            ganha.


            **Nota**: No caso de não haver transações de saída, o valor será
            `null`.
          example: 0.96
        positive_to_negative_ratio_3m:
          type: number
          nullable: true
          format: float
          description: >-
            A razão entre sum_positive / sum_negative nos últimos três meses.


            ℹ️ Se a razão for maior que `1`, isso significa que o usuário tem
            mais entradas do que saídas, indicando que ele gasta menos do que
            ganha.


            **Nota**: No caso de não haver transações de saída, o valor será
            `null`.
          example: 1.04
        positive_to_negative_ratio_6m:
          type: number
          nullable: true
          format: float
          description: >-
            A razão entre sum_positive / sum_negative nos últimos seis meses.


            ℹ️ Se a razão for maior que `1`, isso significa que o usuário tem
            mais entradas do que saídas, indicando que ele gasta menos do que
            ganha.


            **Nota**: No caso de não haver transações de saída, o valor será
            `null`.
          example: 1.13
        positive_to_negative_ratio_12m:
          type: number
          nullable: true
          format: float
          description: >-
            A razão entre sum_positive / sum_negative nos últimos doze meses.


            ℹ️ Se a razão for maior que `1`, isso significa que o usuário tem
            mais receitas do que despesas, indicando que ele gasta menos do que
            ganha.


            **Nota**: No caso de não haver transações de saída, o valor será
            `null`.
          example: 1.3
        net_cashflow_3d:
          type: number
          nullable: true
          format: float
          description: O fluxo de caixa líquido nos últimos três dias.
          example: -1104.79
        net_cashflow_1w:
          type: number
          nullable: true
          format: float
          description: O fluxo de caixa líquido na última semana.
          example: -1536.33
        net_cashflow_1m:
          type: number
          nullable: true
          format: float
          description: O fluxo de caixa líquido no último mês.
          example: -2250.46
        net_cashflow_3m:
          type: number
          nullable: true
          format: float
          description: O fluxo de caixa líquido nos últimos três meses.
          example: 5588.51
        net_cashflow_6m:
          type: number
          nullable: true
          format: float
          description: O fluxo de caixa líquido nos últimos seis meses.
          example: 22088.51
        net_cashflow_12m:
          type: number
          nullable: true
          format: float
          description: O fluxo de caixa líquido nos últimos doze meses.
          example: 55088.51
        net_cashflow_trend_3d:
          type: number
          nullable: true
          format: float
          description: A tendência do fluxo de caixa líquido nos últimos três dias meses.
          example: 1448.683
        net_cashflow_trend_1w:
          type: number
          nullable: true
          format: float
          description: A tendência do fluxo de caixa líquido na última semana.
          example: 163.8856
        net_cashflow_trend_1m:
          type: number
          nullable: true
          format: float
          description: A tendência do fluxo de caixa líquido no último mês.
          example: 1.3034
        net_cashflow_trend_3m:
          type: number
          nullable: true
          format: float
          description: A tendência do fluxo de caixa líquido nos últimos três meses.
          example: -0.472
        net_cashflow_trend_6m:
          type: number
          nullable: true
          format: float
          description: A tendência do fluxo de caixa líquido nos últimos seis meses.
          example: -15.1286
        net_cashflow_trend_12m:
          type: number
          nullable: true
          format: float
          description: A tendência do fluxo de caixa líquido nos últimos doze 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: >-
            O valor líquido das transações para esta categoria nos últimos três
            meses (calculado como o total de transações de entrada - total de
            transações de saída para esta categoria).
          example: 642.76
        category_inflow_ratio_3m:
          type: number
          nullable: true
          format: float
          description: >-
            A razão de `net_amount_3m` dividida pela soma de todas as transações
            categorizadas de entrada (incluindo a categoria atual) para o mesmo
            período.


            Nota: Se não houver transações de entrada para o período, este valor
            retornará `null`.
          example: 1
        trend_3m:
          type: number
          nullable: true
          format: float
          description: >-
            A tendência de transações líquidas da categoria (transações de
            entrada - transações de saída para a categoria) para o período.
          example: 0
    RiskInsights:
      type: object
      title: Objeto de Insights de Risco
      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: >-
            Um array de números de conta gerados pela Belvo (UUIDs) que foram
            usados durante a análise de insights de risco. Se nenhuma conta for
            encontrada, retornamos um array vazio.
          items:
            type: string
            format: uuid
            description: O ID gerado pela Belvo para a conta.
            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: >-
            Um array de métricas agregadas referentes às categorias e
            subcategorias de transações que a Belvo identificou no histórico de
            transações do usuário.


            No array, a Belvo retorna apenas as categorias que foram
            identificadas.
          items:
            $ref: '#/components/schemas/RiskInsightsCategoryMetrics'
    EmploymentMetric:
      type: object
      description: Detalhes das Métricas de Emprego
      title: Objeto de Métricas de Emprego
      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: >-
            O carimbo de data/hora ISO-8601 de quando o cálculo das métricas de
            emprego foi atualizado pela última vez.
          example: '2023-08-30T15:31:35.728607Z'
        reference_date:
          type: string
          nullable: true
          format: date
          description: >-
            A reference_date que você forneceu em sua solicitação. Se você não
            forneceu uma, este campo retornará `null`, indicando que os cálculos
            são realizados até a data da solicitação.


            **Nota:** Todos os cálculos são relativos a esta data.
          example: '2023-06-01'
        age:
          type: integer
          format: int32
          description: A idade do indivíduo.
          example: 32
        current_status:
          $ref: '#/components/schemas/EnumEmploymentRecordStatus'
        current_employer_count:
          type: integer
          nullable: true
          format: int32
          description: O número de empregadores que o indivíduo tem no momento.
          example: 1
        base_salary_last:
          type: number
          nullable: true
          format: float
          description: >-
            O salário base mais recente do usuário. Se `current_status` for
            `EMPLOYED`, este é o salário base atual do usuário.
          example: 42.17
        weeks_employed_last_job:
          type: number
          nullable: true
          format: float
          description: >-
            O número de semanas em que o usuário esteve empregado em seu último
            emprego. Se `current_status` for `EMPLOYED`, então este campo indica
            o número de semanas em que o usuário está empregado em seu emprego
            atual.
          example: 327.1429
        weeks_since_last_job:
          type: number
          nullable: true
          format: float
          description: >-
            O número de semanas desde o último emprego. Se o valor deste campo
            for `0`, isso indica que o usuário está atualmente empregado.
          example: 0
        weeks_employed_total:
          type: number
          nullable: true
          format: float
          description: >-
            O número total de semanas em que o usuário esteve empregado, de
            acordo com a instituição.


            > **Nota:**

            >

            > No caso de o usuário estar empregado em dois ou mais lugares ao
            mesmo tempo, ainda calculamos essas semanas como uma semana. Por
            exemplo, se um usuário tem três empregos simultâneos por um mês,
            isso é calculado como 4 semanas.
          example: 148.2
        weeks_with_multiple_employers:
          type: number
          nullable: true
          format: float
          description: >-
            O número de semanas em que o indivíduo teve mais de um empregador ao
            mesmo tempo.
          example: 0
        employer_count:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de empregadores que o usuário teve. Útil para indicar
            a estabilidade de emprego ao longo de sua vida.
          example: 14
        unique_employer_count:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número de empregadores únicos que o indivíduo teve.


            > **Nota:**

            >

            > Se o usuário saiu de uma empresa e retornou, por exemplo, seis
            meses depois para a mesma empresa, isso é contado como um
            empregador.
          example: 3
        employers_per_year:
          type: number
          nullable: true
          format: float
          description: >-
            Número de empregadores por ano. Útil para indicar a estabilidade no
            emprego ao longo de um ano.


            > **Nota:**

            >

            > Se o usuário saiu de uma empresa e retornou, por exemplo, seis
            meses depois para a mesma empresa, isso é contado como um
            empregador.
          example: 0.6326
        weeks_between_jobs:
          type: number
          nullable: true
          format: float
          description: O número total de semanas em que o indivíduo esteve desempregado.
          example: 687.2865
        max_weeks_between_jobs:
          type: number
          nullable: true
          format: float
          description: O número máximo de semanas em que o indivíduo esteve desempregado.
          example: 249.8571
        increases_last_job:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de aumentos salariais que o usuário teve em seu
            último emprego. Se `current_status` for `EMPLOYED`, isso se refere
            ao emprego atual do usuário.


            > **Nota:**

            >

            > Para todos os aumentos ou reduções salariais, consideramos apenas
            aqueles em que a mudança no salário é superior a 2%.
          example: 0
        decreases_last_job:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de aumentos salariais que o usuário teve em seu
            último emprego. Se `current_status` for `EMPLOYED`, isso se refere
            ao emprego atual do usuário.
          example: 0
        increases_after_change:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de aumentos salariais entre o penúltimo emprego do
            indivíduo e o último (ou atual) emprego.
          example: 0
        decreases_after_change:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de reduções salariais entre o penúltimo emprego do
            indivíduo e o último (ou atual) emprego.
          example: 0
        increases_overall:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de aumentos salariais ao longo da carreira
            profissional do indivíduo.
          example: 0
        decreases_overall:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de reduções salariais ao longo da carreira
            profissional do indivíduo.
          example: 0
        increases_1y:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de aumentos salariais ao longo do último ano do
            indivíduo (YTD).
          example: 0
        decreases_1y:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de reduções salariais ao longo do último ano do
            indivíduo (YTD).
          example: 0
        increases_3y:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de aumentos salariais ao longo dos últimos três anos
            do indivíduo.


            > **Nota:**

            >

            > Se a carreira profissional do indivíduo for inferior a três anos,
            retornamos `null`.
          example: null
        decreases_3y:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de reduções salariais ao longo dos últimos três anos
            do indivíduo.


            > **Nota:**

            >

            > Se a carreira profissional do indivíduo for inferior a três anos,
            retornamos `null`.
          example: null
        increases_5y:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de aumentos salariais ao longo dos últimos cinco anos
            do indivíduo.


            > **Nota:**

            >

            > Se a carreira profissional do indivíduo for inferior a cinco anos,
            retornamos `null`.
          example: null
        decreases_5y:
          type: integer
          nullable: true
          format: int32
          description: >-
            O número total de reduções salariais ao longo dos últimos cinco anos
            do indivíduo.


            > **Nota:**

            >

            > Se a carreira profissional do indivíduo for inferior a cinco anos,
            retornamos `null`.
          example: null
        yearly_change_1y:
          type: number
          nullable: true
          format: float
          description: >-
            A mudança percentual do salário do indivíduo para o último ano
            (YTD).
          example: 0
        yearly_change_3y:
          type: number
          nullable: true
          format: float
          description: >-
            A variação percentual do salário do indivíduo nos últimos três anos.


            > **Nota:**

            >

            > Se a carreira profissional do indivíduo for inferior a três anos,
            retornamos `null`.
          example: null
        yearly_change_5y:
          type: number
          nullable: true
          format: float
          description: >-
            A variação percentual do salário do indivíduo nos últimos cinco
            anos.


            > **Nota:**

            >

            > Se a carreira profissional do indivíduo for inferior a cinco anos,
            retornamos `null`.
          example: null
        min_monthly_salary_1y:
          type: number
          nullable: true
          format: float
          description: O salário mensal mínimo do indivíduo no último ano.
          example: 3402.88
        min_monthly_salary_3y:
          type: number
          nullable: true
          format: float
          description: O salário mensal mínimo do indivíduo nos últimos três anos.
          example: 3402.88
        min_monthly_salary_5y:
          type: number
          nullable: true
          format: float
          description: O salário mensal mínimo do indivíduo nos últimos cinco anos.
          example: 3402.88
        average_monthly_salary_1y:
          type: number
          nullable: true
          format: float
          description: O salário médio mensal do indivíduo no último ano.
          example: 3402.88
        average_monthly_salary_3y:
          type: number
          nullable: true
          format: float
          description: O salário médio mensal do indivíduo nos últimos três anos.
          example: 3402.88
        average_monthly_salary_5y:
          type: number
          nullable: true
          format: float
          description: O salário médio mensal do indivíduo nos últimos cinco anos.
          example: 3402.88
        max_monthly_salary_1y:
          type: number
          nullable: true
          format: float
          description: O salário mensal máximo do indivíduo no último ano.
          example: 3402.88
        max_monthly_salary_3y:
          type: number
          nullable: true
          format: float
          description: O salário mensal máximo do indivíduo nos últimos três anos.
          example: 3402.88
        max_monthly_salary_5y:
          type: number
          nullable: true
          format: float
          description: O salário mensal máximo do indivíduo nos últimos cinco anos.
          example: 3402.88
    FinancialStatementBalanceSheetCurrentAssets:
      type: object
      description: Os ativos circulantes da empresa para o ano em questão.
      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: >-
            O montante total de caixa e equivalentes de caixa, incluindo moeda,
            contas bancárias e outros investimentos líquidos que podem ser
            rapidamente convertidos em dinheiro.
          example: 48572.01
        short_term_investments:
          type: number
          format: float
          nullable: true
          description: >-
            O valor dos investimentos que se espera serem liquidados em dinheiro
            dentro de um ano, como títulos negociáveis.
          example: 21345.01
        accounts_receivable:
          type: number
          format: float
          nullable: true
          description: >-
            O valor devido pelos clientes por vendas realizadas a crédito, que
            se espera receber em um curto período.
          example: 154321.01
        notes_receivable:
          type: number
          format: float
          nullable: true
          description: >-
            O valor de notas promissórias escritas recebidas de clientes ou
            outras partes, prometendo pagar um valor especificado até uma
            determinada data.
          example: 31789.01
        other_debtors:
          type: number
          format: float
          nullable: true
          description: >-
            Os valores totais devidos por vários outros devedores, excluindo
            contas a receber e notas promissórias.
          example: 12345.01
        bad_debt_provision:
          type: number
          format: float
          nullable: true
          description: >-
            O valor estimado de recebíveis que se espera serem incobráveis,
            frequentemente referido como provisão para devedores duvidosos.
          example: 0.01
        tax_recoverable:
          type: number
          format: float
          nullable: true
          description: >-
            O valor dos pagamentos de impostos que pode ser recuperado das
            autoridades fiscais.
          example: 8976.01
        inventory:
          type: number
          format: float
          nullable: true
          description: >-
            O valor total dos bens disponíveis para venda, matérias-primas,
            produtos em processo e produtos acabados.
          example: 65432.01
        prepaid_expenses:
          type: number
          format: float
          nullable: true
          description: >-
            O valor pago antecipadamente por bens ou serviços a serem recebidos
            no futuro, como prêmios de seguro ou aluguel.
          example: 14321.01
        assets_available_for_sale:
          type: number
          format: float
          nullable: true
          description: >-
            O valor dos ativos não circulantes que estão disponíveis para venda,
            mas ainda não foram vendidos, como equipamentos excedentes ou
            propriedades.
          example: 54321.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            A soma de todos os ativos circulantes, representando o valor total
            dos ativos que se espera serem convertidos em caixa ou utilizados
            dentro de um ano.
          example: 372480.01
    FinancialStatementBalanceSheetNonCurrentAssets:
      type: object
      description: >-
        Os ativos não circulantes da empresa, que são investimentos de longo
        prazo ou propriedades que não são facilmente convertidos em dinheiro,
        para o ano em questão.
      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: >-
            O valor total de propriedades, instalações e equipamentos de
            propriedade da empresa, incluindo terrenos, edifícios, maquinário e
            veículos, utilizados para operações de longo prazo.
          example: 1123456.01
        accumulated_depreciation_and_amortization:
          type: number
          format: float
          nullable: true
          description: >-
            Depreciação e amortização acumuladas totais, representando a
            alocação cumulativa do custo dos ativos não circulantes ao longo do
            período em que se espera que eles proporcionem benefícios
            econômicos.
          example: 123456.01
        long_term_accounts_receivable:
          type: number
          format: float
          nullable: true
          description: >-
            O valor devido pelos clientes por vendas feitas a crédito, esperado
            para ser recebido após um ano.
          example: 10987.01
        prepayment_to_suppliers:
          type: number
          format: float
          nullable: true
          description: >-
            O valor pago antecipadamente a fornecedores por bens ou serviços a
            serem recebidos no futuro, esperado para ser utilizado a longo
            prazo.
          example: 5432.01
        goodwill:
          type: number
          format: float
          nullable: true
          description: >-
            O valor dos ativos intangíveis que surgem da aquisição de outras
            empresas, representando o ágio pago sobre o valor justo dos ativos
            líquidos adquiridos.
          example: 47654.01
        intangible_assets:
          type: number
          format: float
          nullable: true
          description: >-
            O valor total dos ativos intangíveis de propriedade da empresa, como
            patentes, marcas registradas e direitos autorais, com vidas úteis
            que se estendem além de um ano.
          example: 43210.01
        investments_in_associates:
          type: number
          format: float
          nullable: true
          description: >-
            O valor dos investimentos em outras empresas nas quais a companhia
            tem influência significativa, mas não controle, tipicamente
            representado pela posse de 20-50% das ações com direito a voto do
            associado.
          example: 65432.01
        long_term_financial_instruments:
          type: number
          format: float
          nullable: true
          description: >-
            O valor dos instrumentos financeiros que se espera serem mantidos
            por mais de um ano, como títulos, debêntures e empréstimos de longo
            prazo.
          example: 32876.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            A soma de todos os ativos não circulantes, representando o valor
            total dos ativos que se espera serem utilizados ou mantidos por mais
            de um ano.
          example: 1346647.01
    FinancialStatementBalanceSheetCurrentLiabilities:
      type: object
      description: >-
        Os passivos circulantes da empresa, que se espera serem liquidados
        dentro do ano em questão.
      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: >-
            O valor total dos empréstimos contraídos de bancos ou instituições
            financeiras, com expectativa de serem pagos dentro de um ano.
          example: 49876.01
        accounts_payable:
          type: number
          format: float
          nullable: true
          description: >-
            O valor devido aos fornecedores por bens ou serviços adquiridos a
            crédito, que se espera ser pago dentro de um curto período.
          example: 103298.01
        notes_payable:
          type: number
          format: float
          nullable: true
          description: >-
            O valor das notas promissórias escritas emitidas para fornecedores
            ou outros, prometendo pagar um valor especificado até uma
            determinada data.
          example: 25643.01
        financial_instruments:
          type: number
          format: float
          nullable: true
          description: >-
            O valor dos instrumentos financeiros que se espera serem liquidados
            em dinheiro dentro de um ano, como títulos, debêntures e empréstimos
            de curto prazo.
          example: 14321.01
        other_creditors:
          type: number
          format: float
          nullable: true
          description: >-
            Os valores totais devidos a vários outros credores, excluindo contas
            a pagar e notas promissórias.
          example: 21987.01
        income_tax_payable:
          type: number
          format: float
          nullable: true
          description: >-
            O valor do imposto de renda devido às autoridades fiscais, que se
            espera ser pago em um curto período.
          example: 12765.01
        customer_advances:
          type: number
          format: float
          nullable: true
          description: >-
            O valor total recebido antecipadamente de clientes por bens ou
            serviços a serem entregues no futuro, esperado para ser utilizado
            dentro de um ano.
          example: 18765.01
        provisions:
          type: number
          format: float
          nullable: true
          description: >-
            O valor estimado reservado para passivos ou perdas futuras, como
            garantias, reivindicações legais ou custos de reestruturação.
          example: 10987.01
        taxes_payable:
          type: number
          format: float
          nullable: true
          description: >-
            O valor total de impostos devidos às autoridades fiscais, que se
            espera ser pago em um curto período.
          example: 5321.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            A soma de todos os passivos circulantes, representando o valor total
            das obrigações que se espera serem liquidadas dentro de um ano.
          example: 260963.01
    FinancialStatementBalanceSheetNonCurrentLiabilities:
      type: object
      description: >-
        As obrigações não circulantes da empresa, que são obrigações de longo
        prazo não exigíveis dentro do ano em questão.
      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: >-
            O valor devido aos fornecedores por bens ou serviços adquiridos a
            crédito, com expectativa de pagamento após um ano.
          example: 30876.01
        long_term_financial_instruments:
          type: number
          format: float
          nullable: true
          description: >-
            O valor dos instrumentos financeiros que se espera serem mantidos
            por mais de um ano, como títulos, debêntures e empréstimos de longo
            prazo.
          example: 42310.01
        deferred_revenue:
          type: number
          format: float
          nullable: true
          description: >-
            O montante recebido antecipadamente de clientes por bens ou serviços
            a serem entregues no futuro, esperado para ser reconhecido como
            receita a longo prazo (como aluguel).
          example: 21987.01
        contributions_for_future_capital_increases:
          type: number
          format: float
          nullable: true
          description: >-
            As contribuições totais recebidas de acionistas ou outros
            investidores para futuros aumentos de capital, que se espera serem
            utilizadas a longo prazo.
          example: 10987.01
        deferred_income_tax:
          type: number
          format: float
          nullable: true
          description: >-
            O valor do imposto de renda que é diferido para períodos futuros,
            esperado para ser pago após um ano.
          example: 26543.01
        employee_benefits:
          type: number
          format: float
          nullable: true
          description: >-
            O valor total dos benefícios devidos aos empregados, como pensões,
            gratificações e outros benefícios pós-emprego, que se espera serem
            liquidados a longo prazo.
          example: 30218.01
        long_term_provisions:
          type: number
          format: float
          nullable: true
          description: >-
            O valor estimado reservado para passivos ou perdas futuras, como
            garantias, reivindicações legais ou custos de reestruturação, que se
            espera serem liquidados após um ano.
          example: 15432.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            A soma de todos os passivos não circulantes, representando o valor
            total das obrigações que se espera serem liquidadas após um ano.
          example: 178353.01
    FinancialStatementBalanceSheetEquity:
      type: object
      description: >-
        O patrimônio líquido da empresa, representando o interesse residual nos
        ativos após a dedução dos passivos.
      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: >-
            O valor total das ações emitidas pela empresa, representando o
            interesse de propriedade dos acionistas no negócio.
          example: 501234.01
        future_capital_contributions:
          type: number
          format: float
          nullable: true
          description: >-
            Os fundos recebidos dos acionistas que são especificamente
            designados para futuros aumentos de capital ou investimentos.
          example: 75000.01
        legal_reserve:
          type: number
          format: float
          nullable: true
          description: >-
            A reserva legal exigida por lei, geralmente separada dos lucros,
            para fornecer proteção financeira contra perdas ou obrigações
            futuras.
          example: 25000.01
        capital_update_excess:
          type: number
          format: float
          nullable: true
          description: >-
            O excedente resultante de ajustes feitos no capital próprio,
            frequentemente devido à inflação ou à reavaliação de ativos.
          example: 15000.01
        capital_update_insufficiency:
          type: number
          format: float
          nullable: true
          description: >-
            O déficit resultante de ajustes feitos no capital próprio, muitas
            vezes devido à inflação ou à reavaliação de ativos.
          example: -5000.01
        capital_reserve:
          type: number
          format: float
          nullable: true
          description: >-
            A reserva de capital derivada de atividades não operacionais, como
            ganhos de reavaliações de ativos ou certas transações de capital.
          example: 10000.01
        share_premium_on_stock_sales:
          type: number
          format: float
          nullable: true
          description: >-
            O valor excedente recebido por uma empresa quando as ações são
            emitidas a um preço acima do seu valor nominal (par).
          example: 50000.01
        retained_earnings:
          type: number
          format: float
          nullable: true
          description: >-
            Os lucros ou prejuízos acumulados da empresa que não foram
            distribuídos aos acionistas como dividendos.
          example: 202345.01
        other_comprehensive_income:
          type: number
          format: float
          nullable: true
          description: >-
            Os ganhos ou perdas que não estão incluídos no lucro líquido, mas
            são reportados diretamente no patrimônio, como ganhos não realizados
            em investimentos ou ajustes de tradução de moeda estrangeira.
          example: 10987.01
        controlling_interest:
          type: number
          format: float
          nullable: true
          description: >-
            O interesse de propriedade na empresa detido pela entidade
            controladora ou pelos acionistas majoritários, representando a
            participação controladora no negócio.
          example: 70876.01
        non_controlling_interest:
          type: number
          format: float
          nullable: true
          description: >-
            O interesse de propriedade na empresa detido por acionistas
            minoritários, representando a participação não controladora no
            negócio.
          example: 50321.01
        total:
          type: number
          format: float
          nullable: true
          description: >-
            A soma do capital social, lucros retidos, outros resultados
            abrangentes, participação controladora e participação não
            controladora, representando o patrimônio total da empresa.
          example: 836763.01
    FinancialStatementBalanceSheet:
      type: object
      description: >-
        O balanço patrimonial detalhando os ativos, passivos e patrimônio
        líquido da empresa para o ano em questão.
      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: >-
        A demonstração de resultados detalhando as receitas, despesas e lucros
        da empresa para o ano em questão.
      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: >-
            A receita total gerada pela empresa a partir de suas operações
            principais, excluindo quaisquer deduções para descontos, devoluções
            ou abatimentos.


            > **Nota**: `domestic_sales` + `foreign_sales` não somarão o
            `net_revenue` devido à exclusão de descontos, devoluções e
            abatimentos.
          example: 1212345.01
        domestic_sales:
          type: number
          format: float
          nullable: true
          description: >-
            A receita gerada pela empresa a partir da venda de bens ou serviços
            dentro de seu país de origem.
          example: 1123456.01
        foreign_sales:
          type: number
          format: float
          nullable: true
          description: >-
            A receita gerada pela empresa com a venda de bens ou serviços em
            países estrangeiros.
          example: 88987.01
        materials_used:
          type: number
          format: float
          nullable: true
          description: >-
            O custo total dos materiais utilizados ou comercializados pela
            empresa durante o período de relatório.
          example: 609876.01
        cost_of_goods_sold:
          type: number
          format: float
          nullable: true
          description: >-
            O custo total incorrido pela empresa para produzir ou adquirir os
            bens vendidos durante o período de relatório.
          example: 412345.01
        cost_of_services_sold:
          type: number
          format: float
          nullable: true
          description: >-
            O custo total incorrido pela empresa para fornecer os serviços
            vendidos durante o período de relatório.
          example: 101234.01
        gross_profit:
          type: number
          format: float
          nullable: true
          description: >-
            A diferença entre a receita líquida e o custo total dos bens e
            serviços vendidos, representando o lucro obtido com as operações
            principais do negócio antes de deduzir as despesas operacionais.
          example: 190890.01
        gross_loss:
          type: number
          format: float
          nullable: true
          description: >-
            A diferença negativa entre a receita líquida e o custo total dos
            bens e serviços vendidos, representando a perda incorrida nas
            operações principais do negócio antes de deduzir as despesas
            operacionais.
          example: null
        operating_expenses:
          type: number
          format: float
          nullable: true
          description: >-
            As despesas totais incorridas pela empresa em suas atividades
            operacionais normais, incluindo despesas de vendas, gerais e
            administrativas.
          example: 122345.01
        operating_income:
          type: number
          format: float
          nullable: true
          description: >-
            O lucro obtido das operações principais do negócio após a dedução
            das despesas operacionais, mas antes de considerar juros, impostos e
            outros itens não operacionais.
          example: 68545.01
        operating_loss:
          type: number
          format: float
          nullable: true
          description: >-
            O prejuízo incorrido nas operações principais do negócio após
            deduzir as despesas operacionais, mas antes de considerar juros,
            impostos e outros itens não operacionais.
          example: null
        financial_result:
          type: number
          format: float
          nullable: true
          description: >-
            O resultado líquido das atividades financeiras, incluindo receita de
            juros, despesa de juros e outros ganhos ou perdas financeiras.
          example: 15098.01
        income_statement_financial_gains:
          type: number
          format: float
          nullable: true
          description: >-
            A receita financeira total positiva, incluindo receita de juros,
            ganhos cambiais e outros ganhos de atividades de financiamento. Este
            valor deve ser sempre positivo.
          minimum: 0
          example: 85000.01
        income_statement_financial_costs:
          type: number
          format: float
          nullable: true
          description: >-
            As despesas financeiras totais, incluindo despesas com juros, perdas
            cambiais e outros custos incorridos em atividades de financiamento.
            Este valor deve ser sempre negativo.
          maximum: 0
          example: -32000.01
        equity_in_earnings_of_affiliates:
          type: number
          format: float
          nullable: true
          description: >-
            A participação da empresa no lucro ou prejuízo de suas associadas,
            entidades sobre as quais ela tem influência significativa, mas não
            controle.
          example: 5678.01
        income_before_taxes:
          type: number
          format: float
          nullable: true
          description: >-
            O lucro obtido antes de contabilizar as despesas com imposto de
            renda.
          example: 89321.01
        loss_before_taxes:
          type: number
          format: float
          nullable: true
          description: >-
            O prejuízo incorrido antes de contabilizar as despesas com imposto
            de renda.
          example: null
        income_taxes:
          type: number
          format: float
          nullable: true
          description: >-
            O valor total das despesas com imposto de renda incorridas durante o
            período de relatório.
          example: 20123.01
        income_from_continuing_operations:
          type: number
          format: float
          nullable: true
          description: >-
            O lucro obtido das operações comerciais contínuas da empresa após a
            dedução das despesas operacionais e impostos.
          example: 69198.01
        loss_from_continuing_operations:
          type: number
          format: float
          nullable: true
          description: >-
            O prejuízo incorrido pelas operações comerciais contínuas da empresa
            após a dedução das despesas operacionais e impostos.
          example: null
        discontinued_operations:
          type: number
          format: float
          nullable: true
          description: >-
            O resultado líquido das operações que foram descontinuadas ou
            vendidas durante o período de relatório.
          example: 0.01
        net_income:
          type: number
          format: float
          nullable: true
          description: >-
            O lucro total obtido pela empresa após deduzir todas as despesas,
            incluindo operacionais, não operacionais, juros e impostos.
          example: 69198.01
        net_loss:
          type: number
          format: float
          nullable: true
          description: >-
            O prejuízo total incorrido pela empresa após deduzir todas as
            despesas, incluindo operacionais, não operacionais, juros e
            impostos.
          example: null
    FinancialStatement:
      type: object
      description: >-
        A demonstração financeira detalhando o desempenho financeiro da empresa
        para o ano em questão.
      title: Objeto de Declaração Financeira (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: >-
            Em casos onde surgem problemas durante a extração de demonstrações
            financeiras da instituição fiscal, as seguintes mensagens de erro
            podem ser fornecidas para explicar os 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: O ano da demonstração financeira.
          example: 2020
        currency:
          type: string
          description: A moeda da demonstração financeira.
          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: |-
        A classificação da fatura pela instituição fiscal.

        Para o SAT do México, retornamos um dos seguintes valores:

          - `Egreso`
          - `Ingreso`
          - `Nómina`
          - `Pago`
          - `Traslado`
      example: Ingreso
    EnumInvoiceType:
      type: string
      nullable: true
      enum:
        - OUTFLOW
        - INFLOW
        - null
      description: |-
        A direção da fatura (do ponto de vista do proprietário do Link).
        - `OUTFLOW` indica uma fatura enviada.
        - `INFLOW` indica uma fatura recebida.
      example: INFLOW
    TaxDetailsInvoicesSat:
      type: object
      description: Informações gerais sobre os impostos da fatura.
      properties:
        total_tax_retained:
          type: number
          format: float
          description: Valor total dos impostos retidos.
          example: 194.27
        total_tax_transferred:
          type: number
          format: float
          description: Valor total dos impostos transferidos.
          example: 150.4
        retained_taxes:
          type: array
          description: Lista de impostos retidos.
          items:
            type: object
            properties:
              tax:
                type: string
                description: O tipo de imposto retido (por exemplo, ISR, IVA ou IEPS).
                example: ISR
              tax_percentage:
                type: number
                format: float
                nullable: true
                description: A porcentagem de imposto retido.
                example: null
              pre_tax_amount:
                type: number
                format: float
                nullable: true
                description: O valor antes dos impostos.
                example: null
              tax_amount:
                type: number
                format: float
                description: O valor do imposto retido.
                example: 94
        transferred_taxes:
          type: array
          description: Lista de impostos transferidos.
          items:
            type: object
            properties:
              tax:
                type: string
                description: O tipo de imposto transferido (por exemplo, ISR, IVA ou IEPS).
                example: IVA
              tax_percentage:
                type: number
                format: float
                description: A porcentagem de imposto transferido.
                example: 16
              pre_tax_amount:
                type: number
                format: float
                description: O valor antes dos impostos.
                example: 940
              tax_amount:
                type: number
                format: float
                description: O valor do imposto transferido.
                example: 150.4
    EnumInvoiceSatPaymentMethod:
      type: string
      nullable: true
      enum:
        - PUE
        - PPD
        - null
      description: >-
        O código do método de pagamento usado para esta fatura, conforme
        definido pela entidade legal do país.


        - 🇲🇽 México <a
        href="https://developers.belvo.com/docs/sat-catalogs#payment-method"
        target="_blank">artigo de referência do catálogo SAT</a>. Para o México,
        retornamos `PUE`, `PPD` ou `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: O tipo de imposto retido (por exemplo, ISR, IVA ou IEPS).
          example: ISR
        tax_percentage:
          type: number
          nullable: true
          format: float
          description: A porcentagem de imposto retido.
          example: 10
        retained_tax_amount:
          type: number
          nullable: true
          format: float
          description: O valor do imposto retido.
          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: O tipo de imposto transferido (por exemplo, ISR, IVA ou IEPS).
          example: IVA
        tax_percentage:
          type: number
          nullable: true
          format: float
          description: A porcentagem de imposto transferido.
          example: 10
        transferred_tax_amount:
          type: number
          nullable: true
          format: float
          description: O valor do imposto 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: >-
            A descrição do item da fatura (uma fatura pode ter um ou mais
            itens).
          example: December 2019 accounting fees
        product_identification:
          type: string
          nullable: true
          description: >-
            O código de identificação do produto ou serviço, conforme definido
            pela entidade legal no 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: A quantidade deste item da fatura.
          example: 10
        unit_code:
          type: string
          nullable: true
          description: >-
            A unidade de medida, conforme definida pela entidade legal no país.
            \n- \U0001F1F2\U0001F1FD México <a
            href="https://developers.belvo.com/docs/sat-catalogs#unit-code"
            target="_blank">referência do catálogo SAT</a>.
          example: E48
        unit_description:
          type: string
          nullable: true
          description: >-
            A descrição do item, conforme definido pela entidade legal no
            país.\n- \U0001F1F2\U0001F1FD México <a
            href="https://developers.belvo.com/docs/sat-catalogs#unit-code"
            target="_blank">referência do catálogo SAT</a>.
          example: Unidad de servicio
        unit_amount:
          type: number
          nullable: true
          format: float
          description: O preço de um único item.
          example: 200
        tax_type:
          type: string
          nullable: true
          description: O tipo de imposto do item.
          example: null
        pre_tax_amount:
          type: number
          nullable: true
          format: float
          description: >-
            O preço total deste item antes da aplicação de impostos é
            (`quantity` x `unit_amount`).
          example: 400
        tax_percentage:
          type: number
          nullable: true
          format: float
          description: A porcentagem de imposto a ser aplicada.
          example: 16
        tax_amount:
          type: number
          nullable: true
          format: float
          description: >-
            O valor do imposto para este item da fatura (`pre_tax_amount` x
            `tax_percentage`).
          example: 64
        total_amount:
          type: number
          nullable: true
          format: float
          description: >-
            O preço total para este item da fatura (`pre_tax_amount` +
            `tax_amount`).
          example: 464
        retained_taxes:
          type: array
          description: O imposto retido no item da fatura.
          items:
            $ref: '#/components/schemas/InvoiceDetailRetainedTaxSat'
        transferred_taxes:
          type: array
          description: Os impostos transferidos relacionados à fatura.
          items:
            $ref: '#/components/schemas/InvoiceDetailTransferredTaxSat'
    RelatedInvoiceSat:
      type: object
      description: Item de fatura relacionado.
      properties:
        relationship_type:
          type: string
          nullable: true
          description: >-
            O tipo de relação entre esta fatura e a fatura relacionada, conforme
            definido pela entidade legal no país. Para mais informações,
            consulte nosso <a
            href="https://developers.belvo.com/docs/sat-catalogs#related-invoices"
            target="_blank">artigo de referência do catálogo SAT</a>.
          example: '01'
        related_invoice_identification:
          type: string
          nullable: true
          description: O ID SAT da nota fiscal relacionada.
          example: INV-123456
    InvoicesPaymentsRelatedDocumentsSat:
      type: object
      required:
        - invoice_identification
        - currency
        - payment_method
        - previous_balance
        - amount_paid
        - outstanding_balance
      description: >-
        Lista de todas as faturas diferidas relacionadas afetadas pelo
        pagamento.
      properties:
        invoice_identification:
          type: string
          nullable: true
          description: >-
            O ID exclusivo da instituição fiscal para a fatura diferida
            relacionada.
          example: 7EE015F3-6311-11EA-B02A-00155D014007
        currency:
          type: string
          nullable: true
          description: >-
            A moeda da fatura relacionada. Por exemplo:


            - 🇧🇷 BRL (Real Brasileiro)

            - 🇨🇴 COP (Peso Colombiano)

            - 🇲🇽 MXN (Peso Mexicano)


            Por favor, note que outras moedas além das listadas acima podem ser
            retornadas.
          example: MXN
        payment_method:
          type: string
          nullable: true
          description: O método de pagamento da fatura relacionada.
          example: PPD
        partiality_number:
          type: integer
          format: int32
          description: O número da parcela de pagamento.
          example: 1
        previous_balance:
          type: number
          nullable: true
          format: float
          description: O valor da fatura antes do pagamento.
          example: 18877.84
        amount_paid:
          type: number
          nullable: true
          format: float
          description: O valor pago nesta parcela.
          example: 8000
        outstanding_balance:
          type: number
          nullable: true
          format: float
          description: O valor restante a ser pago.
          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: Carimbo de data/hora ISO-8601 quando o pagamento foi realizado.
          example: '2020-03-17T12:00:00.000Z'
        payment_type:
          type: string
          nullable: true
          description: >-
            Código do tipo de pagamento usado para esta fatura, conforme
            definido pela entidade legal do país.


            - 🇲🇽 México <a
            href="https://developers.belvo.com/docs/sat-catalogs#payment-type"
            target="_blank">artigo de referência do catálogo SAT</a>
          example: '03'
        currency:
          type: string
          nullable: true
          description: >-
            A moeda do pagamento. Por exemplo:


            - 🇧🇷 BRL (Real Brasileiro)

            - 🇨🇴 COP (Peso Colombiano)

            - 🇲🇽 MXN (Peso Mexicano)


            Por favor, note que outras moedas além das listadas acima podem ser
            retornadas.
          example: BRL
        exchange_rate:
          type: string
          nullable: true
          description: >-
            A taxa de câmbio de `currency` para MXN no momento em que o
            pagamento foi realizado.
          example: '3.75'
        amount:
          type: number
          nullable: true
          format: float
          description: O valor da fatura, na moeda da fatura original.
          example: 8000.5
        operation_number:
          type: string
          nullable: true
          description: O identificador interno da instituição fiscal para a operação.
          example: '831840'
        beneficiary_rfc:
          type: string
          nullable: true
          description: O ID fiscal do beneficiário do pagamento.
          example: BNM840515VB1
        beneficiary_account_number:
          type: string
          nullable: true
          description: O número da conta bancária do beneficiário do pagamento.
          example: '12343453245633'
        payer_rfc:
          type: string
          nullable: true
          description: O ID fiscal do emissor do pagamento.
          example: BKJM840515VB1
        payer_account_number:
          type: string
          nullable: true
          description: O número da conta bancária do emissor do pagamento.
          example: '13343663245699'
        payer_bank_name:
          type: string
          nullable: true
          description: A instituição bancária que foi utilizada pelo emissor do pagamento.
          example: CITI BANAMEX
        related_documents:
          type: array
          description: >-
            Uma lista de todas as faturas diferidas relacionadas afetadas pelo
            pagamento.
          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: |-
        Com que frequência o pagamento da folha de pagamento é realizado.

        Para o SAT do México, retornamos um dos seguintes 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: Uma análise detalhada dos ganhos para o pagamento da folha de pagamento.
      properties:
        type:
          type: string
          nullable: true
          description: >-
            O tipo de renda. Para uma lista completa de valores possíveis,
            consulte a <a
            href="https://developers.belvo.com/docs/sat-catalogs#payroll-earnings-breakdown-type"
            target="_blank">tabela de tipos de detalhamento de ganhos da folha
            de pagamento</a>.
          example: CHRISTMAS_BONUS
        taxable_amount:
          type: number
          format: float
          description: O valor da renda que é tributável.
          example: 1505
        vat_free_amount:
          type: number
          format: float
          description: O valor da receita que não está sujeito ao IVA.
          example: 0
    InvoicePayrollTaxDeductions:
      type: object
      nullable: true
      description: Uma análise das deduções fiscais no pagamento da folha de pagamento.
      properties:
        type:
          type: string
          nullable: true
          description: >-
            O tipo de dedução fiscal. Para uma lista completa de valores
            possíveis, consulte a <a
            href="https://developers.belvo.com/docs/sat-catalogs#payroll-tax-deductions-type"
            target="_blank">tabela de tipos de deduções fiscais de folha de
            pagamento</a>.
          example: UNION_FEES
        amount:
          type: number
          format: float
          description: O valor da dedução fiscal.
          example: 1505
    InvoicePayrollOtherPayments:
      type: object
      nullable: true
      description: Uma análise detalhada de outros pagamentos para a folha de pagamento.
      properties:
        type:
          type: string
          nullable: true
          description: >-
            O tipo de outro pagamento. Para uma lista completa de valores
            possíveis, consulte a <a
            href="https://developers.belvo.com/docs/sat-catalogs#payroll-other-payments-type"
            target="_blank">tabela de tipos de outros pagamentos de folha de
            pagamento</a>.
          example: EMPLOYMENT_SUBSIDY
        amount:
          type: number
          format: float
          description: O valor do outro pagamento.
          example: 1505
    InvoicesPayrollSat:
      type: object
      nullable: true
      required:
        - version
        - type
        - payment_date
        - date_from
        - date_to
        - days
        - amount
      description: >-
        Detalhes sobre o pagamento da folha de pagamento. Aplicável apenas para
        faturas de folha de pagamento.
      properties:
        days:
          type: integer
          nullable: true
          format: int32
          description: O número de dias cobertos pelo pagamento.
          example: 30
        type:
          type: string
          nullable: true
          description: >-
            O tipo de folha de pagamento, conforme definido pela entidade legal
            do país.


            - 🇲🇽 México <a
            href="https://developers.belvo.com/docs/sat-catalogs#payroll-type"
            target="_blank">artigo de referência do catálogo SAT</a>
          example: O
        amount:
          type: number
          format: float
          description: O valor total do pagamento da folha de pagamento.
          example: 20400.1
        version:
          type: string
          description: A versão do objeto de folha de pagamento.
          example: '1.2'
        date_from:
          type: string
          nullable: true
          format: date
          description: A data de início do período de pagamento, no formato `YYYY-MM-DD`.
          example: '2018-07-01'
        date_to:
          type: string
          nullable: true
          format: date
          description: A data de término do período de pagamento, no formato `YYYY-MM-DD`.
          example: '2018-07-31'
        collected_at:
          $ref: '#/components/schemas/collected_at'
        payment_date:
          type: string
          format: date
          description: A data de pagamento, no formato `YYYY-MM-DD`.
          example: '2018-07-16'
        periodicity:
          $ref: '#/components/schemas/EnumInvoicePayrollPeriodicity'
        earnings_breakdown:
          type: array
          nullable: true
          description: >-
            Uma análise detalhada dos ganhos para o pagamento da folha de
            pagamento.
          items:
            $ref: '#/components/schemas/InvoicePayrollEarningsBreakdown'
        tax_deductions:
          type: array
          nullable: true
          description: Uma análise das deduções fiscais no pagamento da folha de pagamento.
          items:
            $ref: '#/components/schemas/InvoicePayrollTaxDeductions'
        other_payments:
          type: array
          nullable: true
          description: >-
            Uma análise detalhada de outros pagamentos para a folha de
            pagamento.
          items:
            $ref: '#/components/schemas/InvoicePayrollOtherPayments'
    InvoiceWarningsSat:
      type: object
      nullable: true
      required:
        - code
        - message
      description: >-
        Objeto contendo informações sobre quaisquer avisos relacionados a esta
        fatura.
      properties:
        code:
          type: string
          nullable: true
          description: |-
            O código de aviso. Pode ser um dos seguintes:

              - `sat_xml_limit_reached`
              - `sat_service_unavailable`
              - `null`
          example: sat_xml_limit_reached
        message:
          type: string
          nullable: true
          description: >-
            A descrição do aviso.


            A mensagem dependerá do código de aviso:


            `sat_xml_limit_reached`<br>

            O limite diário para downloads de XML definido pelo SAT foi
            atingido, portanto, esta nota fiscal pode estar com dados faltando.
            Por favor, verifique https://tinyurl.com/yydzhy5d para mais
            informações sobre este erro.


            `sat_service_unavailable`<br>

            O download dos detalhes das notas fiscais não está disponível. O
            portal do SAT retornou um erro 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 Faturas (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: O ID único da instituição fiscal para a fatura.
          example: A1A1A1A1-2B2B-3C33-D44D-555555E55EE
        invoice_date:
          type: string
          nullable: true
          description: A data da fatura, no formato `YYYY-MM-DD`.
          example: '2019-12-01'
        status:
          type: string
          nullable: true
          description: >-
            O status da fatura. Pode ser *Vigente* (válido) ou *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: O ID fiscal do remetente da fatura
          example: AAA111111AA11
        sender_fiscal_regime:
          type: string
          nullable: true
          description: >-
            O regime tributário do remetente, conforme definido pela pessoa
            jurídica no país.
          example: '601'
        sender_name:
          type: string
          nullable: true
          description: O nome do remetente da fatura.
          example: ACME CORP
        sender_tax_fraud_status:
          type: string
          nullable: true
          description: >-
            Indica se o remetente está ou não na lista de fraude fiscal do SAT
            por ter enviado dados incorretos, ter pagamentos pendentes ou ter
            realizado negócios que violam os regulamentos da instituição
            fiscal.<br><br>


            O SAT atualiza a lista de fraude fiscal a cada três meses. <br><br>


            Para mais informações sobre os motivos pelos quais um contribuinte
            pode ser incluído na lista de fraude fiscal, consulte o <a
            href="http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69.html"
            target="_blank">Artigo 69</a> e o <a
            href="http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html"
            target="_blank">Artigo 69-B</a> do Código Fiscal da Federação do
            México.

            <br><br>


            Os status possíveis são:


            - `INVESTIGATING` <br>

            A instituição fiscal identificou irregularidades e abriu uma
            investigação sobre o contribuinte.

            <br>

            - `DISMISSED` <br>

            A instituição fiscal investigou o contribuinte e o declarou
            inocente.

            <br>

            - `CONFIRMED` <br>

            A instituição fiscal confirmou que o contribuinte é culpado.

            <br>

            - `OVERTURNED` <br>

            A instituição fiscal reavaliou um contribuinte previamente
            confirmado e, com base em novas evidências, retirou o contribuinte
            da lista de fraude fiscal.

            <br>

            - `NO_TAX_FRAUD_STATUS` <br>

            O receptor ou remetente não é encontrado na lista (ou seja, está em
            conformidade com os regulamentos da instituição fiscal).
          example: NO_TAX_FRAUD_STATUS
        receiver_id:
          type: string
          nullable: true
          description: O ID fiscal do destinatário da fatura.
          example: BBB222222BB22
        receiver_postal_code:
          type: string
          description: O código postal do destinatário.
          example: '11560'
        receiver_fiscal_regime:
          type: string
          nullable: true
          description: >-
            O regime tributário do recebedor, conforme definido pela pessoa
            jurídica no país.
          example: '601'
        receiver_name:
          type: string
          nullable: true
          description: O nome do destinatário da fatura.
          example: BELVO CORP
        receiver_tax_fraud_status:
          type: string
          nullable: true
          description: >-
            Indica se o destinatário está ou não na lista de fraude fiscal do
            SAT por ter enviado dados incorretos, ter pagamentos pendentes ou
            ter realizado negócios que violam os regulamentos da instituição
            fiscal.<br><br>


            O SAT atualiza a lista de fraude fiscal a cada três meses. <br><br>


            Para mais informações sobre os motivos pelos quais um contribuinte
            pode ser incluído na lista de fraude fiscal, consulte o <a
            href="http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69.html"
            target="_blank">Artigo 69</a> e o <a
            href="http://omawww.sat.gob.mx/cifras_sat/Paginas/datos/vinculo.html?page=ListCompleta69B.html"
            target="_blank">Artigo 69-B</a> do Código Fiscal da Federação do
            México.

            <br><br>


            Os status possíveis são:


            - `INVESTIGATING` <br>

            A instituição fiscal identificou irregularidades e abriu uma
            investigação sobre o contribuinte.

            <br>

            - `DISMISSED` <br>

            A instituição fiscal investigou o contribuinte e o declarou
            inocente.

            <br>

            - `CONFIRMED` <br>

            A instituição fiscal confirmou que o contribuinte é culpado.

            <br>

            - `OVERTURNED` <br>

            A instituição fiscal reavaliou um contribuinte previamente
            confirmado e, com base em novas evidências, retirou o contribuinte
            da lista de fraude fiscal.

            <br>

            - `NO_TAX_FRAUD_STATUS` <br>

            O destinatário ou remetente não é encontrado na lista (ou seja, está
            em conformidade com os regulamentos da instituição fiscal).
          example: NO_TAX_FRAUD_STATUS
        cancelation_status:
          type: string
          nullable: true
          description: >-
            Se a fatura for cancelada, este campo indica o status do
            cancelamento.
        cancelation_update_date:
          type: string
          nullable: true
          format: date
          description: A data do cancelamento da fatura, no formato `YYYY-MM-DD`.
          example: '2019-12-02'
        certification_date:
          type: string
          nullable: true
          format: date
          description: A data da certificação fiscal, no formato `YYYY-MM-DD`.
          example: '2019-12-01'
        certification_authority:
          type: string
          nullable: true
          description: O ID fiscal do provedor de certificação.
          example: CCC333333CC33
        payment_type:
          type: string
          nullable: true
          description: >-
            O código do tipo de pagamento usado para esta fatura, conforme
            definido pela entidade legal do país.


            - 🇲🇽 México <a
            href="https://developers.belvo.com/docs/sat-catalogs#payment-type"
            target="_blank">Artigo de referência do catálogo SAT</a>
          example: '99'
        payment_type_description:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*
          example: null
        payment_method:
          $ref: '#/components/schemas/EnumInvoiceSatPaymentMethod'
        payment_method_description:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*


            *A descrição do método de pagamento utilizado para esta fatura.*
          example: null
        usage:
          type: string
          nullable: true
          description: >-
            O código de uso da fatura, conforme definido pela entidade legal do
            país.


            - 🇲🇽 México <a
            href="https://developers.belvo.com/docs/sat-catalogs#usage"
            target="_blank">artigo de referência do catálogo SAT</a>
          example: P01
        version:
          type: string
          nullable: true
          description: A versão CFDI da fatura.
          example: '3.3'
        place_of_issue:
          type: string
          nullable: true
          description: O código postal de onde a fatura foi emitida.
          example: '01165'
        invoice_details:
          type: array
          description: >-
            Uma lista de descrições para cada item (produto comprado ou serviço
            prestado) na fatura.
          items:
            $ref: '#/components/schemas/InvoiceDetailSat'
        currency:
          type: string
          nullable: true
          description: |-
            A moeda da fatura. Por exemplo:

            - 🇧🇷 BRL (Real Brasileiro)
            - 🇨🇴 COP (Peso Colombiano)
            - 🇲🇽 MXN (Peso Mexicano)
            - 🇺🇸 USD (Dólar dos Estados Unidos)
          example: MXN
        subtotal_amount:
          type: number
          nullable: true
          format: float
          description: >-
            O valor antes dos impostos desta fatura (soma do `pre_tax_amount` de
            cada item).
          example: 400
        exchange_rate:
          type: number
          nullable: true
          format: float
          description: A taxa de câmbio utilizada nesta fatura para a moeda.
          example: 0.052
        tax_amount:
          type: number
          nullable: true
          format: float
          description: >-
            O valor do imposto para esta fatura (soma do `tax_amount` de cada
            item).
          example: 64
        discount_amount:
          type: number
          nullable: true
          format: float
          description: O valor total descontado nesta fatura.
          example: 10
        total_amount:
          type: number
          nullable: true
          format: float
          description: >-
            O valor total da fatura (`subtotal_amount` + `tax_amount` -
            `discount_amount`)
          example: 454
        related_invoices:
          type: array
          description: Uma lista de faturas relacionadas.
          items:
            $ref: '#/components/schemas/RelatedInvoiceSat'
        payments:
          type: array
          description: Uma lista detalhando todos os pagamentos de faturas.
          items:
            $ref: '#/components/schemas/InvoicesPaymentsSat'
        payroll:
          $ref: '#/components/schemas/InvoicesPayrollSat'
        folio:
          type: string
          nullable: true
          description: >-
            O número de controle interno que o contribuinte atribui à nota
            fiscal.
          example: '26'
        export_type:
          type: string
          nullable: true
          description: >-
            O tipo de exportação da fatura, conforme definido pela entidade
            legal no país. Para mais informações, consulte nosso <a
            href="https://developers.belvo.com/docs/sat-catalogs#export-type"
            target="_blank">artigo de referência do catálogo SAT</a>.
          example: '01'
        xml:
          type: string
          nullable: true
          description: XML do documento da fatura.
        warnings:
          $ref: '#/components/schemas/InvoiceWarningsSat'
        sender_blacklist_status:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*

            Por favor, use `sender_tax_fraud_status` em vez disso.
          example: null
        receiver_blacklist_status:
          type: string
          nullable: true
          deprecated: true
          description: >-
            *Este campo foi descontinuado. Para mais informações sobre a Belvo e
            descontinuação, consulte nossa explicação sobre Campos
            descontinuados.*

            Por favor, use `receiver_tax_fraud_status` em vez disso.
          example: null
    attach_xml:
      type: boolean
      default: false
      description: Quando definido como `true`, você receberá a fatura XML na resposta.
      example: false
    EnumTaxComplianceStatusOutcome:
      type: string
      nullable: true
      enum:
        - POSITIVE
        - NEGATIVE
        - NO_OBLIGATIONS
      description: >-
        Indica se o contribuinte está cumprindo todas as suas obrigações fiscais
        (`POSITIVE`), se não está (`NEGATIVE`), ou se não tem obrigações a
        cumprir (`NO_OBLIGATIONS`).
      example: NEGATIVE
    TaxComplianceStatus:
      type: object
      title: Objeto de Status 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: O número de identificação interno da instituição para o documento.
          example: 20NE1234567
        pdf:
          type: string
          nullable: true
          format: binary
          description: Status de conformidade fiscal em PDF como binário.
          example: '=PDF-STRING='
        rfc:
          type: string
          nullable: true
          description: >-
            O número RFC (Registro Federal de Contribuyentes) do titular da
            conta.
          example: KDFC211118IS0
        outcome:
          $ref: '#/components/schemas/EnumTaxComplianceStatusOutcome'
    TaxReturnPersonal:
      type: object
      additionalProperties: true
      title: Declaração de Imposto de Renda Pessoal (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: >-
            Informações gerais sobre a declaração de imposto (ano, RFC, tipo de
            declaração, nome da pessoa/empresa, etc.).
        sueldos_salarios:
          type: object
          nullable: true
          description: >-
            Detalhes sobre as informações de renda juntamente com os impostos
            retidos.
        servicios_profesionales:
          type: object
          nullable: true
          description: >-
            Detalhes sobre a renda e informações fiscais provenientes de
            serviços profissionais prestados.
        deducciones_personales:
          type: object
          nullable: true
          description: Lista de todas as deduções fiscais pessoais.
        determinacion_impuesto:
          type: object
          nullable: true
          description: Detalhes sobre a declaração de imposto final.
        retenciones:
          type: object
          nullable: true
          description: Detalhes sobre os impostos já retidos.
        dividendos:
          type: object
          nullable: true
          description: Detalhes sobre dividendos.
        datos_informativos:
          type: object
          nullable: true
          description: Dados informativos adicionais na declaração de imposto.
        pdf:
          type: string
          nullable: true
          format: binary
          description: Declaração de imposto em PDF como binário.
          example: '=PDF-STRING='
        receipt_pdf:
          type: string
          nullable: true
          format: binary
          description: >-
            O recibo de confirmação da instituição fiscal confirmando que eles
            receberam a declaração de imposto.
          example: '=PDF-STRING='
    TaxReturnPersonalMonthly:
      type: object
      additionalProperties: true
      title: Declaração de Imposto de Renda Pessoal (Mensal)
      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: >-
            Informações gerais sobre a declaração de imposto (ano, RFC, tipo de
            declaração, nome da pessoa/empresa, etc.).
        isr:
          type: object
          nullable: true
          description: >-
            Informações utilizadas para calcular os pagamentos mensais
            provisórios do imposto de renda.
        iva:
          type: object
          nullable: true
          description: >-
            Informações usadas para calcular os pagamentos provisórios mensais
            do imposto sobre o IVA.
        pdf:
          type: string
          nullable: true
          format: binary
          description: Declaração de imposto em PDF como binário.
          example: '=PDF-STRING='
        receipt_pdf:
          type: string
          nullable: true
          format: binary
          description: >-
            O recibo de confirmação da instituição fiscal confirmando que eles
            receberam a declaração de imposto.
          example: '=PDF-STRING='
        type:
          type: string
          description: O tipo de declaração de imposto. Pode ser mensal ou anual.
          example: monthly
    TaxReturnBusiness:
      type: object
      additionalProperties: true
      title: Declaração de Imposto de Renda 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: >-
            Informações gerais sobre a declaração de imposto (ano, RFC, tipo de
            declaração, nome da pessoa/empresa, etc.).
        datos_adicionales:
          type: object
          nullable: true
          description: Dados adicionais sobre a declaração de imposto de renda.
        estado_resultados:
          type: object
          nullable: true
          description: >-
            Informações detalhadas sobre o lucro e perda anual da entidade
            legal.


            > **Nota**: Para declarações de imposto submetidas para o ano fiscal
            de 2022 e posteriores, este campo retornará nulo, pois não é mais um
            campo obrigatório ao enviar sua declaração de imposto.
        estado_posicion_financiera_balance:
          type: object
          nullable: true
          description: >-
            Detalhes sobre o balanço patrimonial da entidade legal.


            > **Nota**: Para declarações de imposto apresentadas para o ano
            fiscal de 2022 e posteriores, este campo retornará nulo, pois não é
            mais um campo obrigatório ao enviar sua declaração de imposto.
        conciliacion_entre_resultado_contable_fiscal:
          type: object
          nullable: true
          description: >-
            Detalhes sobre a reconciliação contábil.


            > **Nota**: Para declarações de imposto submetidas para o ano fiscal
            de 2022 e posteriores, este campo retornará nulo, pois não é mais um
            campo obrigatório ao enviar sua declaração de imposto.
        deducciones_autorizadas:
          type: object
          nullable: true
          description: Detalhes sobre as deduções da entidade legal.
        cifras_cierre_ejercicio:
          type: object
          nullable: true
          description: Detalhes sobre os números-chave no final do exercício fiscal.
        determinacion_del_impuesto_sobre_la_renta:
          type: object
          nullable: true
          description: Detalhes sobre a declaração de imposto final.
        dividendos_o_utilidades_distribuidos:
          type: object
          nullable: true
          description: Detalhes sobre dividendos distribuídos.
        detalle_pago_r1_isr_personas_morales:
          type: object
          nullable: true
          description: Detalhes do pagamento de impostos.
        ingressos:
          type: object
          nullable: true
          description: >-
            > **Nota**: Aplicável apenas para declarações de imposto
            apresentadas em ou após 2022. Para declarações de imposto
            apresentadas antes de 2022, este campo retornará `null`.


            Detalhes sobre os valores totais ganhos no ano fiscal.
        determinacion:
          type: object
          nullable: true
          description: >-
            > **Nota**: Aplicável apenas para declarações de imposto
            apresentadas em ou após 2022. Para declarações de imposto
            apresentadas antes de 2022, este campo retornará `null`.


            Detalhes sobre o imposto devido ou crédito fiscal.
        pdf:
          type: string
          nullable: true
          format: binary
          description: Declaração de imposto em PDF como binário.
          example: '=PDF-STRING='
        receipt_pdf:
          type: string
          nullable: true
          format: binary
          description: >-
            O recibo de confirmação da instituição fiscal confirmando que eles
            receberam a declaração de imposto.
          example: '=PDF-STRING='
    TaxReturnBusinessMonthly:
      type: object
      additionalProperties: true
      title: Declaração de Imposto de Renda Empresarial (Mensal)
      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: >-
            Informações gerais sobre a declaração de imposto (ano, RFC, tipo de
            declaração, nome da pessoa/empresa, etc.).
        determinacion_isr:
          type: object
          nullable: true
          description: >-
            Informações utilizadas para calcular o imposto de renda provisório
            para o período.
        detalle_pago_isr:
          type: object
          nullable: true
          description: >-
            Informações sobre os pagamentos mensais provisórios para o imposto
            de renda.
        determinacion_iva:
          type: object
          nullable: true
          description: >-
            Informações usadas para calcular o imposto provisório de IVA para o
            período.
        detalle_pago_iva:
          type: object
          nullable: true
          description: >-
            Informações sobre os pagamentos mensais provisórios para o imposto
            sobre o valor agregado (IVA).
        pdf:
          type: string
          nullable: true
          format: binary
          description: Declaração de imposto em PDF como binário.
          example: '=PDF-STRING='
        receipt_pdf:
          type: string
          nullable: true
          format: binary
          description: >-
            O recibo de confirmação da instituição fiscal confirmando que eles
            receberam a declaração de imposto.
          example: '=PDF-STRING='
        type:
          type: string
          nullable: true
          description: O tipo de declaração de imposto. Pode ser mensal ou anual.
          example: monthly
    TaxReturnsMonthlyRequest:
      type: object
      title: Declarações Mensais de Impostos
      description: Corpo da solicitação para declarações de impostos mensais
      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: >-
            O tipo de declaração de imposto a ser retornada. Para declarações de
            imposto mensais, este campo deve ser definido como `monthly`.
        date_from:
          $ref: '#/components/schemas/date_from'
        date_to:
          $ref: '#/components/schemas/date_to'
    TaxReturnsYearlyRequest:
      type: object
      title: Declarações de Imposto de Renda Anual
      description: Corpo da solicitação para declarações de imposto de renda anuais
      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: >-
            O tipo de declaração de imposto a ser retornada. Para declarações de
            imposto anuais, isso deve ser definido como `yearly`.


            Por padrão, a Belvo retorna as declarações de imposto anuais
            (anuais).
        year_from:
          type: string
          pattern: ^(19|20)\d{2}$
          description: >-
            O ano inicial para o qual você deseja obter dados, no formato
            `YYYY`.
          example: '2018'
        year_to:
          type: string
          pattern: ^(19|20)\d{2}$
          description: O ano em que você deseja parar de receber dados, no formato `YYYY`.
          example: '2019'
    EnumTaxRetentionReceiverNationality:
      type: string
      nullable: true
      enum:
        - NATIONAL
        - FOREIGN
      description: >-
        Se o destinatário da fatura é um nacional mexicano ou não. Se o
        destinatário não for considerado um nacional mexicano, os impostos
        retidos podem ser calculados de forma diferente. Valores possíveis:
          - `NATIONAL`
          - `FOREIGN`
      example: NATIONAL
    EnumTaxRetentionPaymentStatus:
      type: string
      nullable: true
      enum:
        - PAID
        - PROVISIONED
      description: |-
        Indica se o imposto foi pago ou não. Pode ser:
          - `PAID`
          - `PROVISIONED`
      example: PAID
    RetentionBreakdown:
      type: object
      required:
        - base_amount
        - tax_type
        - retained_amount
        - payment_status
      description: Uma análise dos impostos retidos
      properties:
        base_amount:
          type: number
          nullable: true
          format: float
          description: O valor base que foi utilizado para calcular a retenção de imposto.
          example: 0.03
        tax_type:
          type: string
          nullable: true
          description: >-
            Atributo opcional para indicar o tipo de imposto retido para o
            período ou ano de acordo com o <a
            href="https://developers.belvo.com/docs/sat-catalogs#retention-code"
            target="_blank">catálogo SAT</a>.
          example: '01'
        retained_amount:
          type: number
          nullable: true
          format: float
          description: O valor retido.
          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: >-
            O ID único da instituição fiscal para a fatura à qual a retenção de
            imposto se refere.
          example: def404af-5eef-4112-aa99-d1ec8493b89a
        version:
          type: string
          nullable: true
          description: A versão CFDI das retenções de impostos.
          example: '1.0'
        code:
          type: integer
          nullable: true
          format: int32
          description: >-
            O código de retenção de impostos. Para mais informações, consulte
            nosso <a
            href="https://developers.belvo.com/docs/sat-catalogs#retention-code"
            target="_blank">artigo SAT Catalogs no DevPortal</a>.
          example: 25
        issued_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi
            emitida.
          example: '2019-01-03T21:10:40.000Z'
        certified_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi
            certificada.
          example: '2019-01-03T21:10:41.000Z'
        cancelled_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 de quando a retenção de imposto foi
            cancelada (se aplicável).
          example: null
        sender_id:
          type: string
          nullable: true
          description: O ID fiscal do remetente da fatura.
          example: JKUF980404P0
        sender_name:
          type: string
          nullable: true
          description: O nome do remetente da fatura.
          example: Roberto Nunez Batman
        receiver_nationality:
          $ref: '#/components/schemas/EnumTaxRetentionReceiverNationality'
        receiver_id:
          type: string
          nullable: true
          description: O ID fiscal do destinatário da fatura.
          example: GYGK3207809L1
        receiver_name:
          type: string
          nullable: true
          description: O nome do destinatário da fatura.
          example: ACME LTD
        total_invoice_amount:
          type: number
          nullable: true
          format: float
          description: O valor total da fatura ao qual a retenção de imposto se refere.
          example: 53249.8
        total_exempt_amount:
          type: number
          nullable: true
          format: float
          description: Valor total isento de tributação.
          example: 1000.8
        total_retained_amount:
          type: number
          nullable: true
          format: float
          description: Total de impostos retidos.
          example: 1550.7
        total_taxable_amount:
          type: number
          nullable: true
          format: float
          description: >-
            O valor total que pode ser tributado. Calculado como
            `total_invoice_amount` - `total_exempt_amount`.
          example: 43249
        retention_breakdown:
          type: array
          nullable: true
          description: Uma análise detalhada dos impostos retidos.
          items:
            $ref: '#/components/schemas/RetentionBreakdown'
        xml:
          type: string
          nullable: true
          description: O documento de retenção de impostos em formato XML.
          example: '=XML-STRING='
    EnumTaxRetentionType:
      type: string
      enum:
        - OUTFLOW
        - INFLOW
      description: >-
        O tipo de retenção de imposto em relação à fatura (do ponto de vista do
        proprietário do Link).


        - `OUTFLOW` refere-se a uma retenção de imposto para uma fatura enviada.

        - `INFLOW` refere-se a uma retenção de imposto para uma fatura recebida.
      example: INFLOW
    TaxStatusTaxPayerInformationSat:
      type: object
      nullable: true
      required:
        - rfc
        - start_operations_date
        - status_padron
        - last_status_change_date
      description: Detalhes sobre o contribuinte.
      properties:
        rfc:
          type: string
          nullable: true
          description: >-
            O número de identificação do contribuinte (para o México, este é o
            RFC).
          example: BEMP12345G58
        curp:
          type: string
          nullable: true
          description: >-
            O número *Clave Única de Registro de Población* (CURP) do
            contribuinte.
          example: null
        name:
          type: string
          nullable: true
          description: O primeiro nome do contribuinte.
          example: JOHN
        first_last_name:
          type: string
          nullable: true
          description: O primeiro sobrenome do contribuinte.
          example: DOE
        second_last_name:
          type: string
          nullable: true
          description: O segundo sobrenome do contribuinte.
          example: SCHMOE
        start_operations_date:
          type: string
          nullable: true
          format: date
          description: >-
            Data em que o contribuinte iniciou atividades comerciais
            tributáveis, no formato `YYYY-MM-DD`.
          example: null
        status_padron:
          type: string
          nullable: true
          description: >-
            Status do contribuinte no Registro Federal de Contribuintes (RFC).
            Pode ser `ACTIVO` ou `INACTIVO`.
          example: null
        last_status_change_date:
          type: string
          nullable: true
          format: date
          description: >-
            Data em que `status_padron` foi atualizado mais recentemente, no
            formato `YYYY-MM-DD`.
          example: null
        commercial_name:
          type: string
          nullable: true
          description: |-
            O nome da empresa designado para consumidores e o público em geral.

            **Nota**: Aplicável apenas para empresas.
          example: Jar Jar Transport
        social_name:
          type: string
          nullable: true
          description: >-
            O nome único e exclusivo dentro do território nacional que as
            empresas recebem para fins legais ou administrativos.


            **Nota**: Aplicável apenas para empresas.
          example: John Doe SA DE CV
        email:
          type: string
          nullable: true
          description: Endereço de e-mail de contato do contribuinte.
          example: john_doe@gmail.com
        phone:
          type: string
          nullable: true
          description: Número de telefone de contato do contribuinte.
          example: '1234567890'
    TaxStatusAddressBetweenStreetSat:
      type: object
      properties:
        street_one:
          type: string
          nullable: true
          description: A primeira rua entre a qual `street` está localizada.
          example: CALLE PRINCIPE
        street_two:
          type: string
          nullable: true
          description: A segunda rua entre a qual `street` está localizada.
          example: CALLE NUEVA ROMA
    TaxStatusAddressSat:
      type: object
      nullable: true
      required:
        - postal_code
      description: Os detalhes do endereço do contribuinte.
      properties:
        postal_code:
          type: string
          nullable: true
          description: O código postal do endereço.
          example: '21255'
        street_type:
          type: string
          nullable: true
          description: O tipo `street`.
          example: CALLE
        street:
          type: string
          nullable: true
          description: A rua dos contribuintes.
          example: LA MALINCHE
        exterior_number:
          type: string
          nullable: true
          description: O número da rua.
          example: '432'
        interior_number:
          type: string
          nullable: true
          description: Informações adicionais do endereço.
          example: PLANTA BAJA
        suburb:
          type: string
          nullable: true
          description: O subúrbio do contribuinte.
          example: BUENAVENTURA
        locality:
          type: string
          nullable: true
          description: A localidade do endereço.
          example: none
        municipality:
          type: string
          nullable: true
          description: O município do endereço.
          example: CDMX DC
        state:
          type: string
          nullable: true
          description: O estado em que o endereço está.
          example: Federal
        between_street:
          type: array
          nullable: true
          description: Informações adicionais sobre onde a `street` está localizada.
          items:
            $ref: '#/components/schemas/TaxStatusAddressBetweenStreetSat'
    TaxStatusEconomicActivitySat:
      type: object
      properties:
        economic_activity:
          type: string
          nullable: true
          description: A descrição da atividade econômica.
          example: Asalariado
        initial_date:
          type: string
          nullable: true
          description: A data de início da atividade econômica, no formato `YYYY-MM-DD`.
          example: '2020-12-06'
        end_date:
          type: string
          nullable: true
          format: date
          description: A data de término da atividade econômica, no formato `YYYY-MM-DD`.
          example: null
        order:
          type: string
          nullable: true
          description: A ordem da atividade econômica.
          example: '2'
        percentage:
          type: string
          nullable: true
          description: A porcentagem da atividade econômica.
          example: '1'
    TaxStatusRegimensSat:
      type: object
      required:
        - regimen
        - initial_date
        - end_date
      properties:
        end_date:
          type: string
          nullable: true
          format: date
          description: A data de término do regime, no formato `YYYY-MM-DD`.
          example: null
        initial_date:
          type: string
          nullable: true
          format: date
          description: A data de início do regime, no formato `YYYY-MM-DD`.
          example: '2020-12-06'
        regimen:
          type: string
          nullable: true
          description: A descrição do regime.
          example: Régimen de Ingresos por Dividendos (socios y accionistas)
    TaxStatusObligationsSat:
      type: object
      description: |-
        Detalhes sobre as obrigações de uma empresa.

        ℹ️ Para contas não comerciais, este campo retornará vazio.
      properties:
        obligation:
          type: string
          nullable: true
          description: A descrição da obrigação.
          example: Declaración informativa de IVA con la anual de ISR
        expiration:
          type: string
          nullable: true
          description: >-
            O prazo para cumprir a obrigação, conforme imposto pela autoridade
            fiscal.
          example: Conjuntamente con la declaración anual del ejercicio.
        initial_date:
          type: string
          nullable: true
          format: date
          description: A data em que a obrigação começou, no formato `YYYY-MM-DD`.
          example: '2020-12-06'
        end_date:
          type: string
          nullable: true
          format: date
          description: A data em que a obrigação terminou, no formato `YYYY-MM-DD`.
          example: null
    TaxStatusSat:
      type: object
      title: Objeto de Status 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: O local e a data em que o status fiscal foi emitido.
          example: TLALPAN , CIUDAD DE MEXICO A 19 DE MARZO DE 2020
        official_name:
          type: string
          nullable: true
          description: O nome da pessoa ou empresa.
          example: John Doe
        id_cif:
          type: string
          nullable: true
          description: O *Cédula de Identificación Fiscal* (CIF) ID do contribuinte.
          example: '12345678901'
        tax_payer_information:
          $ref: '#/components/schemas/TaxStatusTaxPayerInformationSat'
        address:
          $ref: '#/components/schemas/TaxStatusAddressSat'
        economic_activity:
          type: array
          nullable: true
          description: Uma lista de objetos de atividade econômica.
          items:
            $ref: '#/components/schemas/TaxStatusEconomicActivitySat'
        regimes:
          type: array
          nullable: true
          description: Uma lista de objetos de regime.
          items:
            $ref: '#/components/schemas/TaxStatusRegimensSat'
        obligations:
          type: array
          nullable: true
          description: |-
            Detalhes sobre as obrigações de uma empresa.

            ℹ️ Para contas não comerciais, este campo retornará vazio.
          items:
            $ref: '#/components/schemas/TaxStatusObligationsSat'
        digital_stamp:
          type: string
          nullable: true
          description: O certificado de validação do documento.
          example: |
            ||2020/04/26|GHTF980303F7|CONSTANCIA DE SITUACIÓN
            FISCAL|2044441088666600000034||
        digital_stamp_chain:
          type: string
          nullable: true
          description: >-
            Uma cadeia de dados contendo a estrutura básica de um cheque fiscal
            digital. Para o México, este é o *Comprobante Fiscal Digital por
            Internet* (CFDI).
          example: >
            EtenSA9t1adG7bn+Jj23kj43JK+XbMPxdOppwabhXD+pXseSqYowWWDna0mpUk3264lkj2345j23faNZB852dCDt9KAjow=
        pdf:
          type: string
          nullable: true
          format: binary
          description: PDF de status fiscal como uma string binária.
          example: '=PDF-STRING='
    invoice_chile:
      type: object
      title: Objeto de Fatura (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: >-
            O valor total da fatura, incluindo IVA e outros impostos ou
            encargos.
          example: 3272500.02
        net_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor total da fatura após o IVA e outros impostos.
          example: 2750000.02
        vat_amount:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor total do IVA da fatura.
          example: 522500.02
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: O código de moeda de três letras (ISO-4217) da fatura.
          example: CLP
        issue_date:
          type: string
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          description: A data em que a fatura foi emitida, no formato `YYYY-MM-DD`.
          example: '2024-09-23'
        received_at:
          type: string
          format: date-time
          description: O carimbo de data/hora ISO-8601 de quando a fatura foi recebida.
          example: '2024-09-02T15:23:47-03:00'
        acknowledged_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data e hora ISO-8601 de quando a fatura foi reconhecida
            como recebida.
          example: '2024-09-02T15:23:47-03:00'
        claim_date:
          type: string
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          nullable: true
          description: >-
            A data em que uma reclamação ou disputa foi levantada sobre a
            fatura, no formato `YYYY-MM-DD`.
          example: null
        status:
          type: string
          description: |-
            O status da fatura. Pode ser:

              - `REGISTERED`
              - `PENDING`
              - `REJECTED`
              - `CANCELLED`
          example: REGISTERED
        document_code:
          type: integer
          description: >-
            Um código que indica se o documento é uma fatura, uma nota de
            crédito ou débito, e assim por diante.
          example: 33
        category:
          type: string
          description: A categoria da fatura, de acordo com a instituição.
          example: Del Giro
        folio:
          type: string
          description: O código único da instituição para a fatura.
          example: '23559723'
        sender_id:
          type: string
          description: >-
            O número de identificação do remetente. Para o SII Chile, este é o
            RUT.
          example: 59324768-2
        sender_name:
          type: string
          description: O nome registrado do remetente.
          example: Cafe del Sur
        receiver_id:
          type: string
          description: >-
            O número de identificação do receptor. Para o SII Chile, este é o
            RUT.
          example: 82136549-6
        receiver_name:
          type: string
          description: O nome registrado do receptor.
          example: Alejandra Gonzalez
        type:
          type: string
          enum:
            - INFLOW
            - OUTFLOW
          description: Indica se a fatura é um INFLOW ou OUTFLOW.
          example: INFLOW
        purchase_invoice_details:
          type: object
          nullable: true
          description: >-
            Detalhes sobre a nota fiscal de compra. Se a nota fiscal for uma
            nota de venda (`type` = `OUTFLOW`), este campo retornará `null`.
          properties:
            vat_refundable_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                O valor do IVA pago que é elegível para ser reivindicado como
                crédito fiscal.
              example: 300.02
            vat_non_refundable_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                O valor do IVA pago que não pode ser recuperado como crédito
                fiscal.
              example: 20.02
            vat_non_refundable_code:
              type: integer
              format: int32
              nullable: true
              description: >-
                Um código que identifica o motivo pelo qual o VAT não é
                recuperável.
              example: 90
            net_amount_fixed_assets:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor líquido dos ativos fixos adquiridos.
              example: 8000.02
            vat_fixed_assets:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor do IVA na compra de ativos fixos.
              example: 80.02
            vat_common_use:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                O IVA que se aplica a compras usadas para fins tanto tributáveis
                quanto não tributáveis.
              example: 129.02
            tax_non_credit_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor do imposto que não pode ser reivindicado como crédito.
              example: 5.02
            vat_non_withheld:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor do IVA que não foi retido pelo comprador.
              example: 8.02
            tax_exempt_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: A parte da compra que é isenta de IVA.
              example: 33.02
            credit_or_debit_note_on_purchase:
              type: boolean
              nullable: true
              description: >-
                Indica se a fatura está vinculada a uma nota de crédito ou
                débito.
              example: false
            tax_cigarettes_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor total do imposto aplicado sobre cigarros.
              example: 50.02
            tax_cigar_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor total do imposto aplicado sobre charutos.
              example: 51.02
            tax_processed_tobacco_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor total do imposto aplicado sobre o tabaco processado.
              example: 49.02
            additional_tax_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor total do imposto do imposto adicional.
              example: 1005.02
            additional_tax_rate:
              type: string
              nullable: true
              description: A alíquota do imposto adicional.
              example: '2.1'
            additional_tax_code:
              type: integer
              format: int32
              nullable: true
              description: O código tributário para o imposto adicional.
              example: 50993
        sales_invoice_details:
          type: object
          nullable: true
          description: >-
            Detalhes sobre a nota fiscal de vendas. Se a nota fiscal for uma
            nota de compra (`type` = `INFLOW`), este campo retornará `null`.
          properties:
            construction_sector_tax_credit:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor do crédito fiscal aplicável para empresas de construção.
              example: 50000.02
            tax_free_trade_zone_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: Imposto aplicável para transações em zonas de livre comércio.
              example: 38490.02
            container_deposit_guarantee:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: Refere-se a depósitos ou garantias em recipientes, se aplicável.
              example: 0.02
            is_free_of_charge:
              type: boolean
              nullable: true
              description: >-
                Indique se esta venda foi feita sem custo (por exemplo, a fatura
                é para material promocional, reabastecimentos periódicos
                gratuitos e similares).
              example: false
            periodic_billing_type:
              type: boolean
              nullable: true
              description: Marca se a fatura é para serviços periódicos.
              example: false
            non_billable_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: A parte da transação que não é faturável.
              example: 40.02
            total_amount_for_period:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                O valor total para um período específico, frequentemente usado
                para faturamento periódico.
            domestic_transportation_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor total gasto em transporte doméstico.
              example: 67.02
            international_transportation_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor total gasto em transporte internacional.
              example: 56.02
            branch_code:
              type: integer
              format: int32
              nullable: true
              description: >-
                O código da filial fiscal onde a nota fiscal de vendas foi
                emitida.
              example: 76129014
            tax_exempt_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: A parte da venda que é isenta de IVA.
              example: 4000.02
            credit_or_debit_note_on_purchase:
              type: boolean
              nullable: true
              description: >-
                Indica se a fatura está vinculada a uma nota de crédito ou
                débito.
              example: false
            additional_tax_code:
              type: integer
              nullable: true
              description: O código tributário para o imposto adicional.
              example: 50993
            additional_tax_rate:
              type: string
              nullable: true
              description: A alíquota do imposto adicional.
              example: '2.1'
            additional_tax_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor total do imposto do imposto adicional.
              example: 1005.02
            vat_total_withheld:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O total do IVA retido.
              example: 33.02
            vat_partially_withheld:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor do IVA parcialmente retido.
              example: 30.02
            vat_non_withheld:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor do IVA que não foi retido.
              example: 40.02
            vat_sales:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor do IVA correspondente às próprias vendas do vendedor.
              example: 100.02
            vat_third_party:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                Valor do IVA relacionado a vendas de terceiros ao atuar como
                intermediário.
              example: 1000.02
            vat_past_due:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: IVA que é contabilizado ou pago após a data de vencimento.
              example: 31.02
            invoice_settlement_sender_id:
              type: string
              nullable: true
              description: O RUT da entidade que emitiu a liquidação para a fatura.
              example: 55524768-7
            invoice_settlement_net_commission:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: O valor líquido da comissão na liquidação da fatura.
              example: 54.02
            invoice_settlement_exempt_commission:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: >-
                A parte da comissão na liquidação da fatura que está isenta de
                impostos.
              example: 16.02
            invoice_settlement_vat_commission:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              nullable: true
              description: IVA cobrado sobre o valor da comissão na liquidação da fatura.
              example: 78.02
            reference_document_type:
              type: string
              nullable: true
              description: >-
                Indica o tipo de documento ao qual esta fatura se refere ou está
                vinculada.
              example: null
            reference_document_folio:
              type: string
              nullable: true
              description: O número do fólio do documento referido.
              example: null
            foreign_recipient_id:
              type: string
              nullable: true
              description: O número de identificação de um indivíduo estrangeiro.
              example: JANM-7820234
            foreign_recipient_nationality:
              type: string
              nullable: true
              description: A nacionalidade do indivíduo estrangeiro.
              example: Peru
        summary_invoice_details:
          type: object
          description: >-
            Detalhes sobre o resumo das faturas `BOLETA_ELECTRONICA` ou
            `COMPROBANTE_PAGO`.
          properties:
            month:
              type: string
              pattern: ^\d{4}-\d{2}$
              description: O ano e o mês das faturas, no formato `YYYY-MM`.
              example: 2024-08
            updated_at:
              type: string
              format: date-time
              description: >-
                O carimbo de data e hora ISO-8601 de quando a lista de faturas
                foi atualizada pela última vez.
              example: '2024-09-02T15:23:47-03:00'
            total_documents:
              type: integer
              format: int32
              description: O número total de faturas no resumo.
              example: 23
            tax_exempt_amount:
              type: number
              format: float
              pattern: ^\d{1,15}\.\d{2,4}$
              description: >-
                O valor total da fatura (de todas as faturas no resumo) que está
                isento de IVA.
              example: 4000.02
    tax_status_sii_entity_details:
      type: object
      description: >-
        Detalhes sobre a entidade fiscal (datas importantes e informações de
        identificação).
      required:
        - incorporation_date
        - start_date
        - end_date
        - document_id_type
        - document_id_number
        - name
      properties:
        incorporation_date:
          type: string
          format: date
          description: >-
            A data em que a entidade fiscal foi constituída, no formato
            `YYYY-MM-DD`.
          example: 24-09-2010
        start_date:
          type: string
          format: date
          description: >-
            A data em que a entidade fiscal começou a operar, no formato
            `YYYY-MM-DD`.
          example: 24-09-2010
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data em que a entidade fiscal encerrou suas operações, no formato
            `YYYY-MM-DD`. Se a entidade ainda estiver operando, este campo
            retornará `null`.
          example: null
        document_id_type:
          type: string
          description: >-
            O tipo de ID de documento que a entidade fiscal possui. Para o
            Chile, será o `RUT`.
          example: RUT
        document_id_number:
          type: string
          description: O número de ID do documento da entidade fiscal.
          example: 197476427-K
        name:
          type: string
          description: O nome da entidade fiscal.
          example: Empresa de Prueba
    tax_status_sii_address:
      type: object
      description: Detalhes sobre o endereço da entidade fiscal.
      required:
        - type
        - date
        - address
      properties:
        type:
          type: string
          enum:
            - PRIMARY
            - SECONDARY
            - MAILING_ADDRESS
            - NOTIFICATION_ADDRESS
          description: |-
            O tipo de endereço. Pode ser:

              - `PRIMARY` (*domicilio*)
              - `SECONDARY` (*sucursal*)
              - `MAILING_ADDRESS` (*DOM. POSTAL*)
              - `NOTIFICATION_ADDRESS` (*DOM. URBANO_VALIDO_NOTIFICACIONES*)
          example: PRIMARY
        date:
          type: string
          format: date
          description: >-
            A data em que o endereço foi adicionado aos registros da entidade
            fiscal, no formato `YYYY-MM-DD`.
          example: 24-09-2010
        address:
          type: string
          description: O endereço da entidade fiscal.
          example: Calle Falsa 123
    tax_status_sii_emails:
      type: object
      description: Detalhes sobre os endereços de e-mail da entidade fiscal.
      required:
        - type
        - email
      properties:
        type:
          type: string
          enum:
            - CONTACT
            - NOTIFICATION
            - OTHER
          description: |-
            O tipo de e-mail. Pode ser:

            - `CONTACT` (*Correo electrónico de contacto*)
            - `NOTIFICATION` (*Correo electrónico para notificaciones*)
            - `OTHER`.
          example: CONTACT
        email:
          type: string
          format: email
          description: O endereço de e-mail da entidade fiscal.
          example: mi-email@empresa.cl
    tax_status_sii_phone:
      type: object
      description: Detalhes sobre os números de telefone da entidade fiscal.
      required:
        - number
        - type
      properties:
        type:
          type: string
          nullable: true
          enum:
            - LANDLINE
            - MOBILE
            - OTHER
            - 'null'
          description: |-
            O tipo de número de telefone. Pode ser:

              - `LANDLINE`
              - `MOBILE`
              - `OTHER`
          example: LANDLINE
        number:
          type: string
          description: O número de telefone da entidade fiscal.
          example: 123456789
    tax_status_sii_economic_activity:
      type: object
      description: Detalhes sobre a atividade econômica da entidade fiscal.
      required:
        - type
        - activity
        - code
        - tax_category
        - vat_affected
        - start_date
      properties:
        type:
          type: string
          description: >-
            O tipo geral de atividade econômica, de acordo com o Servicio de
            Impuestos Internos (SII).
          example: ASESORIA EN INGENIERIA
        activity:
          type: string
          description: >-
            A atividade econômica específica, de acordo com o Servicio de
            Impuestos Internos (SII).
          example: ACTIVIDADES DE CONSULTORIA DE GESTION
        code:
          type: string
          description: >-
            O código de atividade econômica, de acordo com o Servicio de
            Impuestos Internos (SII).
          example: '702000'
        tax_category:
          type: integer
          description: >-
            A categoria tributária da atividade econômica, de acordo com o
            Servicio de Impuestos Internos (SII).
          example: 1
        vat_affected:
          type: boolean
          description: Indica se a atividade econômica é afetada pelo IVA.
          example: true
        start_date:
          type: string
          format: date
          description: >-
            A data em que a entidade fiscal iniciou esta atividade econômica, no
            formato `YYYY-MM-DD`.
          example: 24-09-2010
    tax_status_sii_legal_representative:
      type: object
      description: Detalhes sobre os representantes legais da entidade fiscal.
      required:
        - is_current
        - name
        - document_id_type
        - document_id_number
        - start_date
      properties:
        is_current:
          type: boolean
          description: >-
            Indica se o representante legal é o atual representante legal da
            entidade fiscal.
          example: true
        name:
          type: string
          description: O nome do representante legal.
          example: Juan Perez
        document_id_type:
          type: string
          enum:
            - RUT
          description: >-
            O tipo de ID do documento do representante legal. Para o Chile, isso
            será sempre definido como `RUT`.
          example: RUT
        document_id_number:
          type: string
          description: >-
            O número de identificação do documento do representante legal. Para
            o Chile, este será o número RUT.
          example: 12345678-9
        start_date:
          type: string
          format: date
          description: >-
            A data em que o representante legal começou a representar a entidade
            fiscal, no formato `YYYY-MM-DD`.
          example: 24-09-2010
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data em que o representante legal deixou de representar a entidade
            fiscal, no formato `YYYY-MM-DD`. Se o representante legal ainda
            estiver representando a entidade fiscal, este campo retornará
            `null`.
          example: null
    tax_status_sii_equity_holder:
      type: object
      description: Detalhes sobre os detentores de ações da entidade 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 se o detentor de ações está atualmente ativo.
          example: true
        name:
          type: string
          description: O nome do detentor de ações.
          example: Juan Perez
        document_id_type:
          type: string
          enum:
            - RUT
          description: >-
            O tipo de ID de documento do detentor de ações. Para o Chile, isso
            será sempre definido como `RUT`.
          example: RUT
        document_id_number:
          type: string
          description: >-
            O número de identificação do documento do detentor de ações. Para o
            Chile, este será o número RUT.
          example: 12345678-9
        inactive:
          type: boolean
          description: Indica se o detentor de ações está atualmente inativo.
          example: false
        start_date:
          type: string
          format: date
          description: >-
            A data em que o detentor de ações começou a possuir ações na
            entidade fiscal, no formato `YYYY-MM-DD`.
          example: 24-09-2010
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data em que o detentor de ações deixou de possuir ações na
            entidade fiscal, no formato `YYYY-MM-DD`. Se o detentor de ações
            ainda estiver possuindo ações na entidade fiscal, este campo
            retornará `null`.
          example: null
        capital_contributed:
          type: number
          description: O valor do capital contribuído pelo detentor de ações.
          example: 1000000
        capital_contribution_outstanding:
          type: number
          description: O valor da contribuição de capital pendente pelo detentor de ações.
          example: 3750
        ownership_share:
          type: number
          description: A porcentagem de participação acionária do detentor de ações.
          example: 25.25
        profit_share:
          type: number
          description: A porcentagem de participação nos lucros do detentor de ações.
          example: 31.25
    tax_status_sii_company_stake:
      type: object
      description: Detalhes sobre as participações societárias da entidade 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: O nome da entidade que esta entidade fiscal.
          example: Empresa de Prueba
        document_id_type:
          type: string
          enum:
            - RUT
          description: >-
            O tipo de ID de documento do negócio. Para o Chile, isso será sempre
            definido como `RUT`.
          example: RUT
        document_id_number:
          type: string
          description: >-
            O número de ID do documento da empresa. Para o Chile, este será o
            número RUT.
          example: 12345678-9
        inactive:
          type: boolean
          description: Indica se o negócio está atualmente ativo.
          example: false
        start_date:
          type: string
          format: date
          description: >-
            A data em que a empresa começou a deter participação acionária na
            entidade fiscal, no formato `YYYY-MM-DD`.
          example: 24-09-2010
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data em que o titular da empresa deixou de possuir participação
            acionária na entidade fiscal, no formato `YYYY-MM-DD`. Se o titular
            ainda estiver mantendo participação acionária na entidade fiscal,
            este campo retornará `null`.
          example: null
        capital_contributed:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O montante de capital contribuído pela empresa.
          example: 1000000.02
        capital_contribution_outstanding:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: O valor da contribuição de capital pendente pela empresa.
          example: 3750.02
        ownership_share:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: A porcentagem de participação acionária da empresa.
          example: 25.25
        profit_share:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          description: A porcentagem de participação nos lucros da empresa.
          example: 31.25
    tax_status_sii_regime:
      type: object
      description: Detalhes sobre o regime tributário da entidade fiscal.
      required:
        - type
        - start_date
      properties:
        type:
          type: string
          description: >-
            O tipo de regime tributário, conforme definido pelo Servicio de
            Impuestos Internos (SII).
          example: MICRO EMPRESA
        start_date:
          type: string
          format: date
          description: >-
            A data em que a entidade fiscal iniciou este regime tributário, no
            formato `YYYY-MM-DD`.
          example: '2023-01-01'
    tax_status_sii_authorized_tax_document:
      type: object
      description: Detalhes sobre um documento fiscal autorizado para a entidade fiscal.
      required:
        - type
        - document_limit
        - authorization_date
      properties:
        type:
          type: string
          description: >-
            O tipo de documento fiscal autorizado, conforme definido pelo
            Servicio de Impuestos Internos (SII).
          example: CONTABILIDAD EN HOJAS SUELTAS CON NRO.UN
        document_limit:
          type: integer
          description: >-
            O número máximo de documentos que podem ser emitidos sob esta
            autorização.
          example: 2000
        authorization_date:
          type: string
          format: date
          description: >-
            A data em que o documento fiscal e o limite foram estabelecidos, no
            formato `YYYY-MM-DD`.
          example: '2010-18-11'
    tax_status_sii_property_tax_liabilities:
      type: object
      description: >-
        Detalhes sobre as obrigações fiscais de uma propriedade com a qual a
        entidade está associada.
      required:
        - property_id
        - district
        - address
        - type
        - overdue_tax_payments
        - scheduled_tax_payments
      properties:
        property_id:
          type: string
          description: >-
            O identificador único da propriedade, de acordo com o Servicio de
            Impuestos Internos (SII).
          example: '12345'
        district:
          type: string
          description: O distrito onde a propriedade está localizada.
          example: NUNAO
        address:
          type: string
          description: O endereço da propriedade.
          example: 123 Example Street
        type:
          type: string
          description: O tipo de propriedade associado à responsabilidade fiscal.
          example: HABITACIONAL
        overdue_tax_payments:
          type: array
          description: Uma lista de pagamentos de impostos atrasados para a propriedade.
          items:
            type: object
            required:
              - year
              - installment
              - due_date
              - amount_due
            properties:
              year:
                type: integer
                description: O ano para o qual o pagamento do imposto está atrasado.
                example: 2023
              installment:
                type: integer
                description: O número da parcela do pagamento de imposto em atraso.
                example: 1
              due_date:
                type: string
                format: date
                description: >-
                  A data de vencimento do pagamento de imposto em atraso, no
                  formato `YYYY-MM-DD`.
                example: '2023-04-30'
              amount_due:
                type: number
                format: float
                description: O valor devido para o pagamento de imposto em atraso.
                example: 19.864
        scheduled_tax_payments:
          type: array
          description: Uma lista de pagamentos de impostos agendados para a propriedade.
          items:
            type: object
            required:
              - year
              - installment
              - due_date
              - amount_due
            properties:
              year:
                type: integer
                description: O ano para o qual o pagamento do imposto está agendado.
                example: 2023
              installment:
                type: integer
                description: O número da parcela do pagamento de imposto programado.
                example: 1
              due_date:
                type: string
                format: date
                description: >-
                  A data de vencimento do pagamento de imposto agendado, no
                  formato `YYYY-MM-DD`.
                example: '2023-04-30'
              amount_due:
                type: number
                format: float
                description: O valor devido para o pagamento de imposto agendado.
                example: 19.864
    tax_status_sii_fiscal_office:
      type: object
      description: >-
        Detalhes sobre o escritório fiscal onde a entidade fiscal está
        registrada.
      required:
        - name
        - address
      properties:
        name:
          type: string
          description: O nome do escritório fiscal onde a entidade fiscal está registrada.
          example: VIÑA DEL MAR
        address:
          type: string
          description: >-
            O endereço do escritório fiscal onde a entidade fiscal está
            registrada.
          example: ARLEGUI 525, VIÑA DEL MAR
    tax_status_sii:
      type: object
      title: Objeto de Status Fiscal (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: Um array de endereços para a entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_address'
        emails:
          type: array
          description: Um array de endereços de e-mail para a entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_emails'
        phone_numbers:
          type: array
          description: Um array de números de telefone para a entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_phone'
        economic_activities:
          type: array
          description: Um array de atividades econômicas para a entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_economic_activity'
        legal_representative:
          type: array
          description: Um array de representantes legais para a entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_legal_representative'
        equity_holders:
          type: array
          description: Um array de detentores de ações para a entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_equity_holder'
        company_partnership_stakes:
          type: array
          description: Um array de participações societárias da entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_company_stake'
        regimes:
          type: array
          nullable: true
          description: Uma lista de regimes tributários para a entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_regime'
        authorized_tax_documents:
          type: array
          nullable: true
          description: Uma lista de documentos fiscais autorizados para a entidade fiscal.
          items:
            $ref: '#/components/schemas/tax_status_sii_authorized_tax_document'
        property_tax_liabilities:
          type: array
          nullable: true
          description: >-
            Uma lista de obrigações fiscais de uma propriedade com a qual a
            entidade está associada.
          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 Relatório de Dívida (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: O nome completo do indivíduo.
              example: 'Cabezas Pérez Martín Vicente '
            document_id_type:
              type: string
              enum:
                - RUT
              description: >-
                O tipo de ID de documento do indivíduo. Para o Chile, isso será
                sempre definido como `RUT`.
              example: RUT
            document_id_number:
              type: string
              description: >-
                O número de identificação do documento do indivíduo. Para o
                Chile, este será o número RUT.
              example: 12345678-9
        debt_data_last_update:
          type: string
          format: date
          description: >-
            A data em que os dados da dívida foram atualizados pela última vez,
            no formato `YYYY-MM-DD`.
          example: '2023-07-02'
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: A moeda das dívidas. Para o Chile, será o `CLP`.
          example: CLP
        total:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: >-
            O valor total da dívida, incluindo dívidas atuais, inadimplentes,
            gravemente inadimplentes e inadimplidas.
          example: 6506000.02
        current:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: O montante da dívida que está atualmente em aberto, mas não vencida.
          example: 5350000.02
        delinquent:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: O valor da dívida que está vencida há 30-59 dias.
          example: null
        severely_delinquent:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: O valor da dívida que está vencida há 60-89 dias.
          example: 56000.02
        defaulted:
          type: number
          format: float
          pattern: ^\d{1,15}\.\d{2,4}$
          nullable: true
          description: O valor da dívida que está vencida há 90 dias.
          example: 1100000.02
        direct_debts:
          type: array
          nullable: true
          description: Uma lista de dívidas que são diretamente atribuídas ao indivíduo.
          items:
            type: object
            properties:
              financial_institution:
                type: string
                description: O nome da instituição financeira onde a dívida está mantida.
                example: Banco Santander
              credit_type:
                type: string
                description: >-
                  O tipo de crédito emitido pela instituição financeira. Por
                  exemplo, `Vivienda`, `Comercial`, `Consumo` ou `Otro`.
                example: Vivienda
              amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                description: O valor total da dívida na instituição financeira.
                example: 5000000.02
              current:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: O valor atual pendente da dívida na instituição financeira.
                example: 5000000.02
              delinquent:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: O valor da dívida que está vencida há 30-59 dias.
                example: null
              severely_delinquent:
                type: number
                format: float
                nullable: true
                description: O valor da dívida que está vencida há 60-89 dias.
                example: null
              defaulted:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: O valor da dívida que está vencida há 90 dias.
                example: null
        indirect_debts:
          type: array
          nullable: true
          description: Lista de dívidas indiretas de instituições financeiras.
          items:
            type: object
            properties:
              financial_institution:
                type: string
                description: Nome da instituição financeira que fornece a dívida indireta.
                example: Banco BCI
              credit_type:
                type: string
                description: >-
                  O tipo de crédito emitido pela instituição financeira. Por
                  exemplo, `Vivienda`, `Comercial`, `Consumo` ou `Otro`.
                example: Consumo
              amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                description: O valor total da dívida na instituição financeira.
                example: 200000.02
              current:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: O valor atual pendente da dívida na instituição financeira.
                example: null
              delinquent:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: O valor da dívida que está vencida há 30-59 dias.
                example: null
              severely_delinquent:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: O valor da dívida que está vencida há 60-89 dias.
                example: null
              defaulted:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: O valor da dívida que está vencida há 90 dias.
                example: 200000.02
        credit_lines:
          type: array
          nullable: true
          description: >-
            Lista de linhas de crédito (como cartões de crédito) disponíveis
            para o indivíduo.
          items:
            type: object
            properties:
              financial_institution:
                type: string
                description: >-
                  O nome da instituição financeira que fornece a linha de
                  crédito.
                example: Banco BCI
              direct_amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: A quantidade de crédito direto disponível.
                example: 5000000.02
              indirect_amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: A quantidade de crédito indireto disponível.
                example: null
        other_credits:
          type: array
          nullable: true
          description: >-
            Lista de outros créditos (como notas de garantia, crédito
            estrangeiro, etc.) disponíveis para o indivíduo.
          items:
            type: object
            properties:
              financial_institution:
                type: string
                description: O nome da instituição financeira que fornece o crédito.
                example: Banco BCI
              direct_amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: A quantidade de crédito direto disponível.
                example: null
              indirect_amount:
                type: number
                format: float
                pattern: ^\d{1,15}\.\d{2,4}$
                nullable: true
                description: A quantidade de crédito indireto disponível.
                example: 250000.02
    payments_common_pagination_properties:
      type: object
      properties:
        count:
          type: integer
          format: int32
          description: O número total de resultados na sua conta Belvo.
          example: 130
        next:
          type: string
          nullable: true
          format: uri
          description: >-
            A URL para a próxima página de resultados. Cada página consiste em
            até 100 itens. Se não houver resultados suficientes para uma página
            adicional, o valor será `null`.


            Em nosso exemplo de documentação, usamos `{endpoint}` como um valor
            de espaço reservado. Em produção, esse valor será substituído pelo
            endpoint real que você está usando atualmente (por exemplo,
            `accounts` ou `owners`).
          example: >-
            https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2
        previous:
          type: string
          nullable: true
          format: uri
          description: >-
            A URL para a página anterior de resultados. Se não houver uma página
            anterior, o valor será `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 do Belvo para referenciar a instituição.
          example: bbaceead-7b96-46d8-9354-38dec9707004
        active:
          type: boolean
          description: Indica se esta instituição está disponível para uso ou não.
          example: true
        institution_type:
          type: string
          enum:
            - BUSINESS
            - INDIVIDUAL
          description: O tipo de instituição. Pode ser `BUSINESS` ou `INDIVIDUAL`.
          example: INDIVIDUAL
        name:
          type: string
          description: O nome da instituição, conforme designado pela Belvo.
          example: wakanda_national
        display_name:
          type: string
          description: O nome da instituição voltado para o cliente.
          example: Wakanda National Bank
        legal_entity_name:
          type: string
          nullable: true
          description: >-
            O nome da entidade legal da instituição, conforme registrado na
            autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil
            OFPI.
          example: Wakanda Bank, National Association
        website:
          type: string
          description: A URL do site da instituição.
          example: https://www.wakandanational.com
        logo:
          type: string
          description: A URL do logotipo da instituição.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.png
        icon_logo:
          type: string
          description: A URL do logotipo do ícone da instituição.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.png
        text_logo:
          type: string
          description: A URL do logotipo de texto da instituição.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.png
        primary_color:
          type: string
          description: A cor primária no site da instituição.
          example: '#fdbc24'
        country:
          type: string
          maxLength: 3
          description: >-
            O país onde a instituição está localizada. Para o Brasil, isso é
            sempre definido como `BRA`.
          example: BRA
        form_fields:
          type: array
          nullable: true
          description: Este campo não é aplicável para OFPI e retornará um array vazio.
          example: []
        sort_priority:
          type: integer
          format: int32
          description: >-
            Número que representa a ordem em que a instituição deve ser exibida
            em um aplicativo, com `1` sendo o mais alto.
          example: 1
        description:
          type: string
          nullable: true
          description: Uma breve descrição da instituição.
          example: >-
            Simple, transparent and secure: Wakanda Bank is the leading
            financial technology company in Latin America.
    401UnauthorizedError:
      type: object
      title: Erro Não Autorizado
      description: >-
        Esse erro ocorre quando você tenta fazer uma chamada de API usando
        credenciais incorretas da API Belvo (ou sua chave secreta ou senha
        secreta, ou ambos, estão incorretos).
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`authentication_failed`) que permite
            classificar e tratar o erro de forma programática.
          example: authentication_failed
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            Para erros `authentication_failed`, a descrição é:

              - `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: |-
        O tipo de cliente. Pode ser:

          - `INDIVIDUAL`
          - `BUSINESS` (apenas OFPI Brasil)
      example: INDIVIDUAL
    external_id__payments:
      type: string
      format: uuid
      description: >-
        Um identificador único adicional para o recurso para fins internos.


        > 👍 Altamente recomendado

        >

        > Recomendamos usar este campo para armazenar seu próprio identificador
        único para cada recurso (cliente, conta bancária, intenção de pagamento
        ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema
        e para fins de depuração.
      example: 4b8a81a0-e33c-45a6-8567-479efb105f73
    EnumPaymentsCountry:
      type: string
      nullable: true
      enum:
        - BRA
        - 'null'
      maxLength: 3
      description: |-
        O país de residência do cliente.
        - BRA (🇧🇷 Brasil)
      example: BRA
    EnumCustomerIdentifierTypeOfpi:
      type: string
      enum:
        - CPF
        - CNPJ
      description: >-
        O tipo de documento de identificação do cliente. Para o Brasil, isso
        pode ser:


        - `CPF` (quando `customer_type` é `INDIVIDUAL`)

        - `CNPJ` (quando `customer_type` é `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: O nome completo do 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: O endereço de e-mail do cliente.
          example: gustavo.veloso@musicabrazil.br
        identifier:
          type: string
          minLength: 11
          maxLength: 14
          description: >-
            O número do documento da identidade do cliente (dependendo do
            `identifier_type`).
          example: 191
        identifier_type:
          $ref: '#/components/schemas/EnumCustomerIdentifierTypeOfpi'
        address:
          type: string
          nullable: true
          minLength: 5
          maxLength: 150
          description: O endereço físico dos clientes.
          example: Rua de Gustavo Veloso 432, 70200 Brasilia
        phone:
          type: string
          nullable: true
          pattern: \+55\d{11}$
          description: O número de telefone do cliente.
          example: '+5511987654321'
    CreateCustomerOfpi:
      type: object
      description: Criar um cliente para Iniciação de Pagamento (OFPI) Brasil 🇧🇷
      required:
        - identifier
      properties:
        identifier:
          type: string
          minLength: 11
          maxLength: 14
          description: O número de CPF ou CNPJ do cliente.
          example: '10187609363'
        name:
          type: string
          minLength: 5
          maxLength: 200
          description: O nome completo do cliente que você deseja criar.
          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: O endereço de e-mail do cliente.
          example: gustavo.veloso@musicabrazil.br
        phone:
          type: string
          nullable: true
          pattern: \+55\d{11}$
          description: O número de telefone do cliente.
          example: '+5511987654321'
        address:
          type: string
          nullable: true
          description: O endereço físico do cliente.
          example: Rua de Gustavo Veloso 432, 70200 Brasilia
    400ValidationError:
      type: object
      title: Erro de Validação
      required:
        - code
        - message
        - request_id
      description: >-
        Esse erro ocorre quando os parâmetros fornecidos não correspondem aos
        campos esperados ou o item que você está tentando criar já está em nosso
        banco de dados, levando a erros de validação de campo.
      properties:
        code:
          type: string
          description: >-
            Um código de erro único (`null`, `does_not_exist`, `required`,
            `already_registered`, `invalid_choice`, `max_length`, `min_length`,
            `blank`, `null`, `cancellation_error`) que permite classificar e
            lidar com o erro de forma programática.
          example: required
        message:
          type: string
          description: |-
            Uma breve descrição do erro.

            A descrição pode ser (entre outras):

              - `Este campo é obrigatório.`
              - `Objeto com nome=narnia não existe.`
              - `Este campo não pode ser nulo.`
              - `Este campo não pode estar em branco.`
              - `Este cliente já está registrado.`
              - `Certifique-se de que este campo tenha pelo menos 2 caracteres.`
              - `Certifique-se de que este campo não tenha mais de 4 caracteres.`
              - `O valor inserido não é válido.`
              - `Você deve definir todos os campos obrigatórios: username, password, username_type.`
              - `Payment Intent não pode ser cancelado porque não está SCHEDULED.`
              - `Payment Intent não pode ser cancelado pois o horário limite (23:59:00) já passou.`
          example: This field is required.
        request_id:
          $ref: '#/components/schemas/request_id'
        field:
          type: string
          nullable: true
          description: >-
            Nome do campo onde o erro foi encontrado.


            > **Nota**: Este campo só está presente quando o erro está
            relacionado a um campo específico.
          example: institution
    EnumBankAccountPixAccountTypeOfpi:
      type: string
      enum:
        - CHECKINGS
        - SAVINGS
        - SALARY
        - PAYMENTS
      description: |-
        O tipo de conta bancária. Pode ser:

          - `CHECKINGS` (também conhecida como Conta Corrente no Brasil)
          - `SAVINGS` (também conhecida como Conta Poupança no Brasil)
          - `SALARY` (também conhecida como Conta Salário no Brasil)
          - `PAYMENTS` (também conhecida como Conta de Pagamento Instantâneo ou Conta de Pagamento no Brasil)
      example: CHECKINGS
    BankAccountDetailsOfpi:
      type: object
      title: Informações da Conta PIX (OFPI)
      description: Informações sobre a conta bancária.
      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: A agência (número da filial) da instituição onde a conta foi criada.
          example: '0444'
        number:
          type: string
          pattern: ^[0-9]{1,20}$
          minLength: 1
          maxLength: 20
          description: >-
            O número da conta bancária.


            > 📘 Caracteres válidos para número de conta

            >

            > Você pode enviar apenas números (`^[0-9]+$`) na string. Por
            exemplo, `"457220"` é um número de conta bancária válido, enquanto
            "`45722-0`" é inválido, pois contém um hífen (`-`).
          example: '457220'
    HolderInformationIndividualOfpiResponse:
      type: object
      title: INDIVIDUAL
      description: Detalhes sobre o titular da conta bancária individual.
      required:
        - first_name
        - last_name
        - identifier
        - identifier_type
      properties:
        first_name:
          type: string
          minLength: 1
          maxLength: 256
          description: O primeiro nome do titular da conta bancária.
          example: Dom
        last_name:
          type: string
          minLength: 1
          maxLength: 256
          description: O sobrenome do titular da conta bancária.
          example: Mesa
        identifier_type:
          type: string
          enum:
            - CPF
          description: >-
            O tipo de documento de identificação do cliente. Para indivíduos no
            Brasil, isso deve ser definido como `CPF`.
        identifier:
          type: string
          minLength: 11
          maxLength: 11
          pattern: ^\d{11}$
          description: O número do documento da identidade do cliente.
          example: 191
    HolderResponseOfpiIndividual:
      type: object
      title: OFPI Brasil 🇧🇷 INDIVIDUAL
      required:
        - type
        - information
      description: Detalhes sobre o titular da conta bancária individual.
      properties:
        type:
          type: string
          enum:
            - INDIVIDUAL
          description: >-
            O tipo de conta bancária. Para indivíduos, isso deve ser definido
            como `INDIVIDUAL`.
          example: INDIVIDUAL
          default: INDIVIDUAL
        information:
          $ref: '#/components/schemas/HolderInformationIndividualOfpiResponse'
    HolderInformationBusinessOfpiResponse:
      type: object
      title: NEGÓCIOS
      required:
        - name
        - identifier
        - identifier_type
      description: Detalhes sobre o titular da conta bancária individual.
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 256
          description: O primeiro nome do titular da conta bancária.
          example: Gustavo Veloso Entertainment Universe
        identifier_type:
          type: string
          enum:
            - CNPJ
          description: >-
            O tipo de documento de identificação do cliente. Para empresas no
            Brasil, isso deve ser definido como `CNPJ`.
          example: CNPJ
          default: CNPJ
        identifier:
          type: string
          minLength: 14
          maxLength: 14
          pattern: ^\d{14}$
          description: O número do documento CNPJ.
          example: 191
    HolderResponseOfpiBusiness:
      type: object
      title: OFPI Brazil 🇧🇷 NEGÓCIOS
      required:
        - type
        - information
      description: Detalhes sobre o titular da conta bancária empresarial.
      properties:
        type:
          type: string
          enum:
            - BUSINESS
          description: >-
            O tipo de conta bancária. Para empresas, isso deve ser definido como
            `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: |-
            ID único da Belvo para o cliente associado à conta bancária.

            Para contas bancárias do tipo `BUSINESS`, este campo é `null`.
          example: null
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        institution:
          type: string
          nullable: true
          format: uuid
          description: >-
            ID exclusivo do Belvo para a instituição em que a conta bancária é
            criada.


            Para contas bancárias do tipo `BUSINESS` que o Belvo cria para
            organizações, este campo é definido como `null`.
          example: null
        details:
          $ref: '#/components/schemas/BankAccountDetailsOfpi'
        holder:
          oneOf:
            - $ref: '#/components/schemas/HolderResponseOfpiIndividual'
            - $ref: '#/components/schemas/HolderResponseOfpiBusiness'
    CreateBankAccountOfpiBusiness:
      type: object
      title: OFPI Brasil 🇧🇷 Negócios
      required:
        - institution
        - holder
        - details
      properties:
        institution:
          type: string
          format: uuid
          description: >-
            ID único do Belvo para a instituição em que a conta bancária é
            criada.
          example: f512d996-583a-4a91-8b5b-eba2e103b068
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        holder:
          type: object
          title: OFPI (Oferta Pública de Financiamento de Investimento)
          required:
            - type
            - information
          description: Detalhes sobre o titular da conta bancária empresarial.
          properties:
            type:
              type: string
              enum:
                - BUSINESS
              description: >-
                O tipo de conta bancária. Para contas bancárias empresariais,
                isso deve ser definido como `BUSINESS`.
              example: BUSINESS
              default: BUSINESS
            information:
              type: object
              description: >-
                Informações adicionais sobre o titular da conta bancária são
                necessárias para criar a conta para OFPI.
              title: NEGÓCIOS
              required:
                - name
                - identifier
                - identifier_type
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 256
                  description: O nome completo da empresa
                  example: Gustavo Veloso Entertainment Universe
                identifier_type:
                  type: string
                  enum:
                    - CNPJ
                  description: >-
                    O tipo de documento de identificação do cliente. Para
                    empresas no Brasil, isso deve ser definido como `CNPJ`.
                  example: CNPJ
                  default: CNPJ
                identifier:
                  type: string
                  minLength: 14
                  maxLength: 14
                  pattern: ^\d{14}$
                  description: O número do 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: >-
            ID único do Belvo para a instituição em que a conta bancária é
            criada.
          example: f512d996-583a-4a91-8b5b-eba2e103b068
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        holder:
          type: object
          title: OFPI (Oferta Pública de Financiamento de Investimento)
          required:
            - type
            - information
          description: Detalhes sobre o titular da conta bancária individual.
          properties:
            type:
              type: string
              enum:
                - INDIVIDUAL
              description: >-
                O tipo de conta bancária. Para indivíduos, isso deve ser
                definido como `INDIVIDUAL`.
              example: INDIVIDUAL
              default: INDIVIDUAL
            information:
              type: object
              description: >-
                Informações adicionais sobre o titular da conta bancária são
                necessárias para criar a conta para OFPI.
              title: INDIVIDUAL
              required:
                - first_name
                - last_name
                - identifier
                - identifier_type
              properties:
                first_name:
                  type: string
                  minLength: 1
                  maxLength: 256
                  description: O primeiro nome do titular da conta bancária.
                  example: Gustavo
                last_name:
                  type: string
                  minLength: 1
                  maxLength: 256
                  description: O sobrenome do titular da conta bancária.
                  example: Veloso
                identifier_type:
                  type: string
                  enum:
                    - CPF
                  description: >-
                    O tipo de documento de identificação do cliente. Para
                    indivíduos no Brasil, isso deve ser definido como `CPF`.
                  example: CPF
                  default: CPF
                identifier:
                  type: string
                  minLength: 11
                  maxLength: 11
                  pattern: ^\d{11}$
                  description: O número do documento da identidade do cliente.
                  example: 191
        details:
          $ref: '#/components/schemas/BankAccountDetailsOfpi'
    PaymentLinkCallbackUrlsResponse:
      type: object
      title: URLs de Retorno de Chamada do Link de Pagamento
      description: >-
        Os URLs para os quais o usuário deve ser redirecionado.


        **Nota:** Este campo retornará um objeto vazio se sua integração gerar
        apenas links de pagamento através do <a
        href="https://dashboard.belvo.com/" target="_blank">Belvo Dashboard</a>.
      properties:
        cancel:
          type: string
          description: >-
            A URL para a qual o usuário deve ser redirecionado caso decida
            cancelar o processo de pagamento ou se ocorrer um erro.
          example: https://www.acmecorp.com/checkout/3487548/cancel
        success:
          type: string
          description: >-
            A URL para a qual o usuário deve ser redirecionado quando concluir o
            processo de pagamento com sucesso.
          example: https://www.acmecorp.com/checkout/3487548/success
    EnumPaymentLinksStatus:
      type: string
      enum:
        - ACTIVE
        - INACTIVE
      description: >-
        O status atual do link de pagamento pode ser:

          - `ACTIVE`, o que significa que o status da intenção de pagamento é `REQUIRES_PAYMENT_METHOD`, `REQUIRES_ACTION` ou `PROCESSING`.
          - `INACTIVE`, o que significa que o status da intenção de pagamento é `SUCCEEDED` ou `FAILED`.

        **Nota:** Você pode recuperar a intenção de pagamento completa usando
        nossa solicitação <a
        href="https://developers.belvo.com/reference/detailcreatepaymentlink"
        target="_blank">Obter detalhes de um link de pagamento</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: >-
            A URL para o hosted-widget que guiará seu usuário pelo processo de
            pagamentos.
          example: https://pay.belvo.io/YggaKvPbM5aJhksu1BEwDI5FKTcUc5wZqNB-wH7MFGU
        access_token:
          type: string
          description: >-
            O token de acesso gerado pelo Belvo para o link de pagamento.


            **Nota:** Você precisará do `access_token` para fazer solicitações
            de <a
            href="https://developers.belvo.com/reference/detailcreatepaymentlink"
            target="_blank">Obter detalhes de um link de pagamento</a>.
          example: YggaKvPbM5aJhksu1BEwDI5FKTcUc5wZqNB-wH7MFGU
        callback_urls:
          $ref: '#/components/schemas/PaymentLinkCallbackUrlsResponse'
        payment_intent:
          type: string
          format: uuid
          description: >-
            ID único da Belvo para a intenção de pagamento. Você pode recuperar
            a intenção de pagamento completa usando nossa solicitação <a
            href="https://developers.belvo.com/reference/detailcreatepaymentlink"
            target="_blank">Obter detalhes de um link de pagamento</a>.
          example: b7dd85b1-671e-45c7-aba6-b4b37a8fc0c2
        updated_at:
          type: string
          nullable: true
          format: date-time
          description: >-
            O carimbo de data e hora ISO-8601 de quando o link de pagamento foi
            atualizado pela última vez.
          example: '2022-02-09T08:45:50.406032Z'
        status:
          $ref: '#/components/schemas/EnumPaymentLinksStatus'
        expires_in:
          type: string
          pattern: \d+([mhd])
          description: O tempo de expiração do link de pagamento.
          example: 7d
        expires_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 de quando o link de pagamento está
            programado para expirar.
          example: '2023-02-09T08:45:50.406032Z'
    EnumPaymentLinkAllowedPaymentMethod:
      type: string
      enum:
        - open_finance
        - open_finance_biometric_pix
      description: >-
        Tipo de método de pagamento selecionado. Para OFPI do 🇧🇷 Brasil, pode
        ser:

          - `open_finance`: Para pagamentos regulares.
          - `open_finance_biometric_pix`: Para pagamentos biométricos usando a rede PIX.
      example: open_finance
    PaymentLinksPaymentMethodDetailsBodyOfpi:
      type: object
      title: >-
        I'm sorry, but "OFPB" doesn't provide enough context for translation.
        Could you please provide more information or a complete sentence?
      description: Detalhes sobre a conta bancária da organização que receberá o pagamento.
      required:
        - beneficiary_bank_account
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            ID único da Belvo usado para identificar a conta bancária do
            beneficiário.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
    PaymentMethodDetailsOfpi:
      type: object
      title: OFPI (Oferta Pública de Financiamento de Investimento)
      description: >-
        Objeto com informações exigidas pelo Open Finance Payments no Brasil
        para criar uma intenção de pagamento.
      required:
        - open_finance
      properties:
        open_finance:
          $ref: '#/components/schemas/PaymentLinksPaymentMethodDetailsBodyOfpi'
    PaymentLinkCallbackUrls:
      type: object
      title: URLs de Retorno de Chamada do Link de Pagamento
      properties:
        cancel:
          type: string
          description: >-
            A URL para a qual o usuário deve ser redirecionado caso decida
            cancelar o processo de pagamento ou se ocorrer um erro.


            **Nota:** Não é necessário se sua integração apenas gerar links de
            pagamento através do <a href="https://dashboard.belvo.com/"
            target="_blank">Belvo Dashboard</a>.
          example: https://www.acmecorp.com/checkout/3487548/cancel
        success:
          type: string
          description: >-
            A URL para a qual o usuário deve ser redirecionado quando concluir o
            processo de pagamento com sucesso.


            **Nota:** Não é necessário se sua integração apenas gerar links de
            pagamento através do <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 foi descontinuado e será removido da API no futuro.

        *O provedor usado para o link de pagamento.*
      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: cadeia de caracteres
              pattern: \d+(?:\.\d{1,2})?
              example: '1234.12'
            - type: number
              format: float
              title: float
              minimum: 0.01
              maximum: 9999999999.99
              example: 1234.12
          description: >-
            Quantia a ser paga pelo seu cliente. Para OFPI, você pode enviar
            números com até duas casas decimais, separados por um ponto (`.`).
            Por exemplo: `1234.12`


            **Nota:** Você pode enviar esse valor como uma string ou um float.
            Independentemente do tipo que você escolher para enviar o `amount`,
            a Belvo retorna uma string com duas casas decimais, separadas por um
            ponto (`.`). Por exemplo, `1234.12`.
        customer:
          type: string
          description: ID único da Belvo para referenciar o cliente.
          example: 06dc2f14-1217-4480-9b36-550a944a39d1
        description:
          type: string
          description: Uma descrição legível por humanos do pagamento.
          example: Shoe payment
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Uma descrição que aparecerá no extrato bancário do cliente
            (recomendado).


            > **Nota**: Se você não usar o parâmetro `statement_description`, o
            valor de `description` será utilizado como a descrição no extrato.
          example: Super Shoe Store - Brown Sneakers
        allowed_payment_method_types:
          type: array
          description: >-
            Uma lista de tipos de métodos de pagamento permitidos nesta intenção
            de pagamento. Para OFPI, esse valor deve ser definido como
            `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: >-
            O tempo de expiração do link de pagamento. Permite que os seguintes
            formatos sejam enviados:

              - número inteiro + `m` para x quantidade de minutos. Por exemplo: `15m` para 15 minutos.
              - número inteiro + `h` para x quantidade de horas. Por exemplo: `12h` para 12 horas.
              - número inteiro + `d` para x quantidade de dias. Por exemplo: `7d` para 7 dias.

              ℹ️ O tempo mínimo de expiração permitido para um link de pagamento é `1m` (1 minuto) e o máximo é `7d` (7 dias).
          example: 7d
        metadata:
          type: object
          description: >-
            Objeto opcional e personalizável onde você pode fornecer quaisquer
            pares de chave-valor adicionais para seus propósitos internos. Por
            exemplo, um número de referência interno para o link de pagamento.


            ⚠️ **Nota**: Você pode fornecer até 50 chaves (as chaves podem ter
            até 50 caracteres cada e cada valor pode ter até 500 caracteres).
            Não oferecemos suporte para objetos aninhados, apenas 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: O status atual da intenção de pagamento.
      example: PROCESSING
    EnumPaymentsCurrency:
      type: string
      enum:
        - BRL
      description: A moeda do valor pago, por exemplo, `BRL` (Real Brasileiro).
      example: BRL
    scheduled_single:
      type: object
      nullable: true
      title: Único
      description: Detalhes sobre o pagamento agendado (único).
      properties:
        single:
          type: object
          nullable: true
          description: Detalhes sobre o pagamento agendado (único).
          properties:
            date:
              type: string
              format: date
              description: >-
                A data em que o pagamento agendado único deve ser feito, no
                formato `YYYY-MM-DD`.
              example: '2024-10-22'
    scheduled_daily:
      type: object
      title: Diário
      description: Detalhes sobre o pagamento recorrente diário.
      properties:
        daily:
          type: object
          description: Detalhes sobre o pagamento recorrente diário.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                A data em que o pagamento diário recorrente deve começar, no
                formato `YYYY-MM-DD`.


                >**Nota**: A `start_date` deve ser pelo menos 1 dia no futuro.
              example: '2024-10-22'
            occurrences:
              type: integer
              minimum: 2
              maximum: 60
              description: >-
                O número de vezes que o pagamento deve se repetir.


                >**Nota**: Você deve agendar pelo menos `2` ocorrências e no
                máximo `60`.
              example: 10
    scheduled_weekly:
      type: object
      title: Semanalmente
      description: Detalhes sobre o pagamento recorrente semanal.
      properties:
        weekly:
          type: object
          description: Detalhes sobre o pagamento recorrente semanal.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                A data em que o pagamento semanal recorrente deve começar, no
                formato `YYYY-MM-DD`.


                >**Nota**: A `start_date` deve corresponder ao primeiro
                `day_of_week` especificado e ser pelo menos 1 dia no futuro.
              example: '2024-10-22'
            day_of_week:
              type: string
              enum:
                - MONDAY
                - TUESDAY
                - WEDNESDAY
                - THURSDAY
                - FRIDAY
                - SATURDAY
                - SUNDAY
              description: >-
                O dia da semana em que o pagamento deve ser feito. Pode ser um
                dos seguintes valores:

                  - `MONDAY`
                  - `TUESDAY`
                  - `WEDNESDAY`
                  - `THURSDAY`
                  - `FRIDAY`
                  - `SATURDAY`
                  - `SUNDAY`
              example: MONDAY
            occurrences:
              type: integer
              minimum: 2
              maximum: 60
              description: >-
                O número de vezes que o pagamento deve se repetir.


                >**Nota**: Você deve agendar pelo menos `2` ocorrências e no
                máximo `60`.
              example: 10
    scheduled_monthly:
      type: object
      title: Mensalmente
      description: Detalhes sobre o pagamento recorrente mensal.
      properties:
        monthly:
          type: object
          description: Detalhes sobre o pagamento recorrente mensal.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                A data em que o pagamento mensal recorrente deve começar, no
                formato `YYYY-MM-DD`.


                >**Nota**: O `start_date` deve corresponder ao primeiro
                `day_of_month` especificado e ser pelo menos 1 dia no futuro.
              example: '2024-10-26'
            day_of_month:
              type: integer
              minimum: 1
              maximum: 31
              description: >-
                O dia do mês em que o pagamento deve ser feito. Pode ser
                qualquer número inteiro entre `1` e `31`.
              example: 26
            occurrences:
              type: integer
              minimum: 2
              maximum: 24
              description: >-
                O número de vezes que o pagamento deve se repetir.


                >**Nota**: Você deve agendar pelo menos `2` ocorrências e no
                máximo `24`.
              example: 12
    scheduled_custom:
      type: object
      title: Personalizado
      description: Detalhes sobre o pagamento recorrente personalizado.
      properties:
        custom:
          type: object
          description: Detalhes sobre o pagamento recorrente personalizado.
          properties:
            dates:
              type: array
              minItems: 2
              maxItems: 60
              description: >-
                As datas únicas em que o pagamento recorrente deve ser feito, no
                formato `YYYY-MM-DD`.


                >**Nota**: As datas devem ser pelo menos 1 dia no futuro e não
                mais do que 720 dias no futuro.
              items:
                type: string
                format: date
                description: A data do pagamento, no formato `YYYY-MM-DD`.
                example: '2024-10-22'
              example:
                - '2024-10-22'
                - '2024-10-26'
            description:
              type: string
              maxLength: 256
              description: >-
                Uma descrição do pagamento recorrente personalizado que será
                exibida ao seu usuário quando ele for redirecionado para o banco
                para aceitar o pagamento.


                > **Nota**: Recomendamos fortemente que esta mensagem esteja em
                português brasileiro e que explique claramente o propósito e a
                natureza recorrente do pagamento.
              example: >-
                Os pagamentos ocorrerão a cada três dias até a data final
                (30.09.2024)
    schedule:
      type: object
      nullable: true
      title: Agendar um pagamento
      description: >-
        Detalhes sobre o pagamento agendado (opcional). Para mais informações
        sobre como agendar pagamentos, consulte nosso guia dedicado <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 pagamento selecionado.
      required:
        - beneficiary_bank_account
        - payer_institution
        - callback_url
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            ID único da Belvo usado para identificar a conta bancária do
            beneficiário.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer_institution:
          type: string
          format: uuid
          description: ID único do Belvo para referenciar a instituição do pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule'
        callback_url:
          type: string
          description: >-
            A URL de callback para a qual seu usuário será redirecionado após
            confirmar o pagamento em seu aplicativo bancário.
          example: https://www.acmecorp.com/checkout/3487321
        cpf:
          type: string
          nullable: true
          description: >-
            O número de CPF do cliente. Necessário apenas quando o
            `customer_type` é `BUSINESS`.


            **Nota:** Este valor é ofuscado.
          example: 23******00
    PaymentIntentPaymentMethodDetailsIndividualOfpi:
      type: object
      title: INDIVIDUAL
      description: Detalhes sobre o método de pagamento OFPI.
      required:
        - open_finance
      properties:
        open_finance:
          $ref: >-
            #/components/schemas/PaymentIntentPaymentMethodDetailsBodyIndividualOfpi
    PaymentIntentPaymentMethodDetailsBodyBusinessOfpi:
      type: object
      description: Tipo de método de pagamento selecionado.
      required:
        - beneficiary_bank_account
        - payer_institution
        - callback_url
        - cpf
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            ID único da Belvo usado para identificar a conta bancária do
            beneficiário.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer_institution:
          type: string
          format: uuid
          description: ID único do Belvo para referenciar a instituição do pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule'
        callback_url:
          type: string
          description: >-
            A URL de callback para a qual seu usuário será redirecionado após
            confirmar o pagamento em seu aplicativo bancário.
          example: https://www.acmecorp.com/checkout/3487321
        cpf:
          type: string
          nullable: true
          description: >-
            O número de CPF do cliente. Necessário apenas quando o
            `customer_type` é `BUSINESS`.


            **Nota:** Este valor é ofuscado.
          example: 23******00
    PaymentIntentPaymentMethodDetailsBusinessOfpi:
      type: object
      title: NEGÓCIOS
      description: Detalhes sobre o método de pagamento OFPI.
      required:
        - open_finance
      properties:
        open_finance:
          $ref: >-
            #/components/schemas/PaymentIntentPaymentMethodDetailsBodyBusinessOfpi
    PaymentMethodInformationBodyOfpi:
      type: object
      description: Tipo de método de pagamento selecionado.
      properties:
        provider_request_id:
          type: string
          nullable: true
          description: ID único para o pagamento, conforme enviado pelo provedor.
          example: 978c0c97ea847e78e8849634473c1f1
        redirect_url:
          type: string
          nullable: true
          description: >-
            A URL que redireciona o usuário para o site da sua instituição para
            autorizar o pagamento.
          example: https://wakandanational.com/
        end_to_end_id:
          type: string
          nullable: true
          description: Um ID único para a transação no sistema de pagamento PIX do Brasil.
          example: F203262942022211117487a213b1d140
        settlement_date:
          type: string
          format: date
          description: >-
            O campo `settlement_date` indica a data em que um pagamento agendado
            (cobrança) está planejado para ser liquidado. Este campo é relevante
            em vários estados do ciclo de vida da cobrança:

              - Cobranças Agendadas: Quando uma cobrança tem o status `SCHEDULED`, este campo representa a data planejada para liquidação.
              - Cobranças Concluídas: Quando uma cobrança tem o status `SUCCEEDED`, este campo reflete a data em que o pagamento foi realizado.
              - Cobranças Falhas ou Canceladas: Quando uma cobrança tem o status `CANCELED` ou `FAILED`, este campo ainda conterá a data de liquidação originalmente calculada, indicando quando a cobrança estava prevista para ser liquidada.

            > **Nota**: O `settlement_date` não muda com base no sucesso ou
            falha da cobrança. Ele reflete consistentemente a data de liquidação
            planejada originalmente.
          example: '2024-10-22'
    PaymentMethodInformationOfpi:
      type: object
      title: OFPI (Oferta Pública de Financiamento de Investimento)
      description: Informações sobre o método de pagamento selecionado.
      properties:
        open_finance:
          $ref: '#/components/schemas/PaymentMethodInformationBodyOfpi'
    ChargePaymentMethodDetailsOfpiContent:
      type: object
      description: Informações sobre o pagador de um pagamento OFPI.
      properties:
        schedule:
          $ref: '#/components/schemas/schedule'
        payer_institution:
          type: string
          format: uuid
          description: Identificador único para a instituição do pagador.
          example: db201c6a-e0ee-4caa-92d6-72b480d6d86f
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            ID único da Belvo usado para identificar a conta bancária do
            beneficiário.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
    ChargePaymentMethodDetailsOfpi:
      type: object
      title: OFPI (Oferta Pública de Financiamento de Investimento)
      description: Detalhes sobre o método de pagamento.
      properties:
        open_finance:
          $ref: '#/components/schemas/ChargePaymentMethodDetailsOfpiContent'
    ChargePayerInformation:
      type: object
      description: >-
        Informações sobre o ChargePayerInformation.yaml


        O arquivo `ChargePayerInformation.yaml` geralmente contém a definição de
        um esquema de dados que descreve as informações do pagador de uma
        cobrança. Este arquivo é usado em sistemas que lidam com transações
        financeiras para garantir que os dados do pagador sejam capturados e
        processados corretamente. Abaixo estão alguns elementos comuns que podem
        ser encontrados em um arquivo YAML desse tipo:


        1. **Estrutura de Dados**: O arquivo define a estrutura dos dados do
        pagador, incluindo campos obrigatórios e opcionais.


        2. **Campos Comuns**:
           - `payerName`: Nome completo do pagador.
           - `payerAddress`: Endereço do pagador, que pode incluir subcampos como `street`, `city`, `state`, e `postalCode`.
           - `payerContact`: Informações de contato, como `email` e `phoneNumber`.
           - `payerID`: Identificação única do pagador, que pode ser um número de documento ou um identificador interno.

        3. **Validações**: O arquivo pode incluir regras de validação para
        garantir que os dados inseridos estejam no formato correto, como
        expressões regulares para validar e-mails ou números de telefone.


        4. **Exemplo de YAML**:
           ```yaml
           ChargePayerInformation:
             payerName: "John Doe"
             payerAddress:
               street: "123 Main St"
               city: "Anytown"
               state: "Anystate"
               postalCode: "12345"
             payerContact:
               email: "johndoe@example.com"
               phoneNumber: "+1234567890"
             payerID: "ID123456789"
           ```

        5. **Uso em Aplicações**: Este arquivo é utilizado por desenvolvedores
        para integrar e validar informações de pagadores em sistemas de
        pagamento, garantindo que todas as transações sejam associadas aos dados
        corretos do pagador.


        Essas informações são essenciais para garantir a conformidade com
        regulamentos financeiros e para facilitar a auditoria e o suporte ao
        cliente.
      properties:
        bank_account:
          type: object
          description: Informações sobre a conta bancária do pagador.
          properties:
            code:
              type: string
              description: O código ISPB do banco do pagador.
              example: '123345'
            type:
              type: string
              description: >-
                O tipo da conta bancária do pagador. Pode ser `CHECKINGS`,
                `SAVINGS` ou `PAYMENTS`.
              example: CHECKINGS
            agency:
              type: string
              description: O número da agência da conta bancária do pagador.
              example: '1234'
            number:
              type: string
              description: O número da conta bancária do pagador.
              example: '123456789'
    EnumPaymentTransactionType:
      type: string
      enum:
        - INFLOW
        - OUTFLOW
      description: |-
        A direção da transação.

          - `INFLOW` indica dinheiro entrando na conta.
          - `OUTFLOW` indica dinheiro saindo da conta.
      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: >-
            O valor da transação.


            **Nota**: O valor exibido é sempre positivo, pois indicamos a
            direção da transação no parâmetro `transaction_type`.
          example: '1020.00'
        currency:
          $ref: '#/components/schemas/EnumPaymentsCurrency'
        description:
          type: string
          maxLength: 128
          description: A descrição do pagamento.
          example: Training shoes
        transaction_type:
          $ref: '#/components/schemas/EnumPaymentTransactionType'
        beneficiary:
          type: string
          format: uuid
          description: >-
            ID único da Belvo usado para identificar a conta bancária do
            beneficiário.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer:
          description: '**Nota**: Para OFPI, isso retornará um objeto vazio `{}`.'
        payment_intent:
          type: string
          format: uuid
          description: O ID único da intenção de pagamento associado à transação.
          example: 004a28bb-fac2-4172-884b-5b6ea15314ad
        customer:
          type: string
          format: uuid
          description: ID único da Belvo para o cliente associado a esta transação.
          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: >-
            O carimbo de data e hora ISO-8601 de quando o status da cobrança foi
            atualizado pela última vez.
          example: '2022-02-09T08:45:50.406032Z'
        created_by:
          $ref: '#/components/schemas/created_by'
        customer:
          type: string
          format: uuid
          description: ID único da Belvo para o cliente para o qual a cobrança foi criada.
          example: 531aa631-70a0-4eeb-ab97-51dea3e90c89
        payment_intent:
          type: string
          format: uuid
          description: O `payment_intent.id` associado a esta cobrança.
          example: 50c04229-7b1d-4a53-951c-8ad53e10c6ca
        status:
          type: string
          enum:
            - CANCELED
            - PENDING
            - SCHEDULED
            - SUCCEEDED
            - FAILED
            - PARTIAL
          description: |-
            O status atual da cobrança. Pode ser um dos seguintes valores:

              - `CANCELED`
              - `PENDING`
              - `SCHEDULED`
              - `SUCCEEDED`
              - `FAILED`
              - `PARTIAL`
          example: PENDING
        amount:
          type: string
          nullable: true
          description: O valor da cobrança.
          example: '100.12'
        currency:
          type: string
          enum:
            - BRL
          description: >-
            A moeda do valor pago. Para 🇧🇷 Brasil, o valor deve ser `BRL`
            (Real Brasileiro).
          example: BRL
        description:
          type: string
          description: A descrição do pagamento.
          example: Training shoes
        statement_description:
          type: string
          maxLength: 50
          description: >-
            A descrição que aparecerá no extrato bancário do cliente (se
            fornecida).
          example: Super Shoe Store - Brown Sneakers
        beneficiary:
          type: string
          format: uuid
          description: >-
            ID único do Belvo usado para identificar a conta bancária do
            beneficiário.
          example: 58524ccc-89ac-4ab6-b62b-c3da3f19a722
        provider:
          $ref: '#/components/schemas/EnumPaymentLinkProvider'
        payment_method_type:
          type: string
          enum:
            - open_finance
          description: >-
            Método de pagamento selecionado. Para OFPI do 🇧🇷 Brasil, o valor
            deve 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: Um array de objetos Transaction relacionados à cobrança.
          items:
            $ref: '#/components/schemas/paymentTransaction'
        failure_code:
          type: string
          nullable: true
          description: >-
            Código de erro que explica o motivo pelo qual um pagamento não foi
            bem-sucedido (se aplicável).
          example: null
        failure_message:
          type: string
          nullable: true
          description: Mais informações sobre o `failure_code`.
          example: null
        metadata:
          type: object
          description: >-
            Objeto opcional e personalizável onde você pode fornecer quaisquer
            pares de chave-valor adicionais para seus propósitos internos. Por
            exemplo, um número de referência interno.


            ⚠️ **Nota**: Você pode fornecer até 50 chaves (as chaves podem ter
            até 50 caracteres cada e cada valor pode ter até 500 caracteres).
            Não oferecemos suporte a objetos aninhados, apenas valores ASCII.
          example:
            internal_reference_id: GGq73487w2
    LastErrorPaymentError:
      type: object
      title: erro_de_pagamento
      description: >-
        Informações sobre o erro que você encontrou na etapa anterior da
        intenção de pagamento, se aplicável. Esse erro pode ocorrer quando algo
        inesperado acontece durante o processo da intenção de pagamento.
      required:
        - error_code
        - error_message
      properties:
        error_code:
          type: string
          description: >-
            Um código de erro único (`payment_error`) que permite classificar e
            lidar com o erro de forma programática.
          example: payment_error
        error_message:
          type: string
          description: Uma breve descrição do erro.
          example: Unexpected error to confirm the payment
    InstitutionFormField:
      type: object
      properties:
        name:
          type: string
          description: O campo de nome de usuário, senha ou tipo de nome de usuário.
          example: username
        type:
          type: string
          description: O tipo de entrada para o campo do formulário. Por exemplo, string.
          example: text
        label:
          type: string
          description: |-
            O rótulo do campo do formulário. Por exemplo:
            - Document
            - Clave
            - Token
          example: Document
        dependency:
          type: string
          nullable: true
          description: >-
            Indica se este parâmetro depende ou não de outro parâmetro ser
            fornecido. Por exemplo, se este campo `dependency` =
            `username_type`, isso significa que você também deve enviar o
            parâmetro `username_type`.
          example: username_type
        validation:
          type: string
          description: O tipo de validação de entrada usado para o campo.
          example: ^.{1,}$
        placeholder:
          type: string
          description: O texto do espaço reservado no campo do formulário.
          example: Username
        validation_message:
          type: string
          description: >-
            A mensagem exibida quando uma entrada inválida é fornecida no campo
            do formulário.
          example: Invalid client number
        values:
          type: array
          description: Array de valores adicionais de campos de formulário.
          items:
            $ref: '#/components/schemas/InstitutionsFormFieldValues'
        length:
          type: integer
          description: Número de dígitos permitidos quando o tipo é `token`.
          example: 6
        optional:
          type: boolean
          description: Indica se este campo de formulário é opcional.
          example: false
    InstitutionFormFieldUsernameType:
      type: object
      properties:
        name:
          type: string
          description: O campo de nome de usuário, senha ou tipo de nome de usuário.
          example: username
        type:
          type: string
          description: O tipo de entrada para o campo do formulário. Por exemplo, string.
          example: text
        placeholder:
          type: string
          description: O texto do espaço reservado no campo do formulário.
          example: Username
        values:
          type: array
          description: Array de valores adicionais de campos de formulário.
          items:
            $ref: '#/components/schemas/InstitutionsFormFieldValues'
        preselected:
          type: integer
          description: >-
            Indique qual opção do array `username_type`s é automaticamente
            pré-selecionada para o usuário.
          example: 6
    InstitutionFormFieldSaveCredentials:
      type: object
      properties:
        name:
          type: string
          description: >-
            Se o usuário deseja ou não salvar as credenciais para esta
            instituição para pagamentos futuros.
          example: save_credentials
        type:
          type: string
          description: >-
            O tipo de entrada para o campo do formulário. Para
            `save_credentials`, isso é definido como `checkbox`.
          example: checkbox
        label:
          type: string
          description: >-
            O rótulo do campo do formulário. Para `save_credentials`, isso é
            definido como `Recuérdame para futuros pagos``.
          example: Recuérdame para futuros pagos
        validation:
          type: string
          nullable: true
          description: >-
            O tipo de validação de entrada usado para o campo. Para
            `save_credentials`, isso é `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 se esta instituição está disponível para uso ou não.
          example: true
        name:
          type: string
          description: O nome da instituição, conforme designado pela Belvo.
          example: wakanda_national
        display_name:
          type: string
          description: O nome da instituição voltado para o cliente.
          example: Wakanda National Bank
        legal_entity_name:
          type: string
          nullable: true
          description: >-
            O nome da entidade legal da instituição, conforme registrado na
            autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil
            OFPI.
          example: Wakanda Bank, National Association
        website:
          type: string
          description: A URL do site da instituição.
          example: https://www.wakandanational.com
        logo:
          type: string
          description: A URL do logotipo da instituição.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.png
        icon_logo:
          type: string
          description: A URL do logotipo do ícone da instituição.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.png
        text_logo:
          type: string
          description: A URL do logotipo de texto da instituição.
          example: >-
            https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.png
        primary_color:
          type: string
          description: A cor primária no site da instituição.
          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 a ordem em que a instituição deve ser exibida
            em um aplicativo, com `1` sendo o mais alto.
          example: 1
        description:
          type: string
          nullable: true
          description: Uma breve descrição da instituição.
          example: >-
            Simple, transparent and secure: Wakanda Bank is the leading
            financial technology company in Latin America.
    DisplayPaymentMethodInformationContentOfpi:
      type: object
      title: Exibir informações sobre o método de pagamento do Open Finance Brasil
      description: >-
        Objeto detalhando quais informações do método de pagamento você precisa
        exibir.
      properties:
        institutions:
          type: array
          description: Um array de objetos institution.
          items:
            $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayPaymentMethodInformation:
      type: object
      title: OFPI - Exibir Informações do Método de Pagamento
      description: >-
        Objeto detalhando os próximos passos que você deve seguir para um 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: O tipo de `next_step` que você precisa 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 se a intenção de pagamento está pronta para ser
            confirmada.

              **Nota:** Quando definido como `true`, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando `confirm: true`.
          example: false
    NeedsRedirectContent:
      type: object
      description: Detalhes sobre a instituição pagadora.
      properties:
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepNeedsRedirect:
      type: object
      title: OFPI - Necessita de Redirecionamento
      description: >-
        Objeto detalhando os próximos passos que você deve seguir para um 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: O tipo de `next_step` que você precisa 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 se a intenção de pagamento está pronta para ser
            confirmada.

              **Nota:** Quando definido como `true`, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando `confirm: true`.
          example: false
    BankAccountDetailsOpenFinance:
      type: object
      title: Informações da Conta PIX (OFPI)
      required:
        - country
        - account_type
        - agency
        - number
      properties:
        country:
          $ref: '#/components/schemas/EnumPaymentsCountry'
        account_type:
          $ref: '#/components/schemas/EnumBankAccountPixAccountTypeOfpi'
        agency:
          type: string
          description: A agência (número da filial) da instituição onde a conta foi criada.
          example: '0444'
        number:
          type: string
          description: O número da conta bancária.
          example: 45722-0
    BankAccountDetailsOpenFinancePix:
      type: object
      title: OFPI (Chaves PIX)
      required:
        - country
        - pix_key
      properties:
        country:
          $ref: '#/components/schemas/EnumPaymentsCountry'
        pix_key:
          type: string
          description: O identificador da chave PIX da conta bancária.
          example: RANDOM://6c1c236c-a035-4b80-ab12-e38f88ce82ab
    EnumBankAccountHolderTypeOfpi:
      type: string
      enum:
        - INDIVIDUAL
        - BUSINESS
      description: O tipo de conta bancária. Pode ser `INDIVIDUAL` ou `BUSINESS`.
      example: BUSINESS
    HolderResponseOfpi:
      type: object
      title: OFPI (Oferta Pública de Financiamento de Investimento)
      required:
        - type
        - information
      description: Detalhes sobre o titular da conta bancária.
      properties:
        type:
          $ref: '#/components/schemas/EnumBankAccountHolderTypeOfpi'
        information:
          oneOf:
            - $ref: '#/components/schemas/HolderInformationBusinessOfpiResponse'
            - $ref: '#/components/schemas/HolderInformationIndividualOfpiResponse'
    BeneficiaryBankAccountOfpi:
      type: object
      title: Conta Bancária do Beneficiário
      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: Exibir confirmação necessária do Open Finance Brasil
      description: >-
        Objeto detalhando os próximos passos que você deve seguir para um tipo
        específico de `next_step`.
      properties:
        beneficiary_bank_account:
          $ref: '#/components/schemas/BeneficiaryBankAccountOfpi'
        payer_name:
          type: string
          description: O nome do pagador.
          example: Gustavo Veloso
        payer_identifier:
          type: string
          description: O ID do pagador.
          example: LV890273900-23
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayConfirmationRequiredOfpi:
      type: object
      title: OFPI - Exibição de Confirmação Necessária
      description: >-
        Objeto detalhando os próximos passos que você deve seguir para um 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: O tipo de `next_step` que você precisa 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 se a intenção de pagamento está pronta para ser
            confirmada.

              **Nota:** Quando definido como `true`, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando `confirm: true`.
          example: true
    DisplayPaymentProcessing:
      type: object
      description: Detalhes sobre a instituição pagadora.
      properties:
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayPaymentProcessing:
      type: object
      title: OFPI - Processamento de Pagamentos
      description: >-
        Objeto detalhando os próximos passos que você deve seguir para um 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: O tipo de `next_step` que você precisa 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 se a intenção de pagamento está pronta para ser
            confirmada.

              **Nota:** Quando definido como `true`, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando `confirm: true`.
          example: false
    DisplayPaymentSucceeded:
      type: object
      description: Detalhes sobre a instituição pagadora.
      properties:
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayPaymentSucceeded:
      type: object
      title: OFPI - Pagamento Concluído com Sucesso
      description: >-
        Objeto detalhando os próximos passos que você deve seguir para um 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: O tipo de `next_step` que você precisa 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 se a intenção de pagamento está pronta para ser
            confirmada.

              **Nota:** Quando definido como `true`, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando `confirm: true`.
          example: false
    DisplayPaymentFailed:
      type: object
      description: Detalhes sobre a instituição pagadora.
      properties:
        payer_institution:
          $ref: '#/components/schemas/paymentInstitution'
    NextStepDisplayPaymentFailed:
      type: object
      title: OFPI - Pagamento Falhou
      description: >-
        Objeto detalhando os próximos passos que você deve seguir para um 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: O tipo de `next_step` que você precisa 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 se a intenção de pagamento está pronta para ser
            confirmada.

              **Nota:** Quando definido como `true`, você precisa confirmar o pagamento fazendo uma solicitação 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 da Belvo para o cliente relacionado a esta intenção de
            pagamento.
          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: >-
            O timestamp ISO-8601 de quando a intenção de pagamento foi
            atualizada pela última vez.
          example: '2022-02-09T08:45:50.406032Z'
        status:
          $ref: '#/components/schemas/EnumPaymentIntentStatus'
        amount:
          type: string
          description: Valor a ser pago pelo seu cliente.
          example: '1234.12'
        currency:
          $ref: '#/components/schemas/EnumPaymentsCurrency'
        description:
          type: string
          description: A descrição do pagamento.
          example: Training shoes
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Uma descrição que aparecerá no extrato bancário do cliente
            (recomendado).


            > **Nota**: Se você não usar o parâmetro `statement_description`, o
            valor de `description` será utilizado como a descrição no extrato.
          example: Super Shoe Store - Brown Sneakers
        selected_payment_method_type:
          $ref: '#/components/schemas/EnumPaymentLinkAllowedPaymentMethod'
        allowed_payment_method_types:
          type: array
          description: >-
            Uma lista de tipos de métodos de pagamento permitidos nesta intenção
            de pagamento. Para OFPI, o valor será `open_finance`.
          items:
            type: string
            example: open_finance
        payment_method_details:
          description: Detalhes sobre o método de pagamento 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 erro que explica o motivo pelo qual um pagamento não foi
            bem-sucedido (se aplicável).
          example: null
        failure_message:
          type: string
          nullable: true
          description: Mais informações sobre o `failure_code`.
          example: null
        metadata:
          type: object
          description: >-
            Objeto opcional e personalizável onde você pode fornecer quaisquer
            pares de chave-valor adicionais para seus propósitos internos. Por
            exemplo, um número de referência interno.


            ⚠️ **Nota**: Você pode fornecer até 50 chaves (as chaves podem ter
            até 50 caracteres cada e cada valor pode ter até 500 caracteres).
            Não oferecemos suporte a objetos aninhados, apenas valores ASCII.
          example:
            internal_reference_id: GGq73487w2
        charges:
          type: array
          description: >-
            Um array de objetos de cobrança relacionados a esta intenção de
            pagamento. Se nenhuma cobrança estiver associada, retornamos um
            array vazio.
          items:
            $ref: '#/components/schemas/ChargeBrazil'
        provider:
          $ref: '#/components/schemas/EnumPaymentLinkProvider'
        last_error:
          deprecated: true
          description: >-
            **Nota**: Este campo foi descontinuado e será removido da API no
            futuro.


            *Informações sobre o erro que você encontrou na etapa anterior da
            intenção de pagamento, se aplicável. Este erro pode ocorrer quando
            algo inesperado acontece durante o processo de intenção de
            pagamento.*
          oneOf:
            - $ref: '#/components/schemas/LastErrorPaymentError'
        next_step:
          deprecated: true
          description: >-
            **Nota**: Este campo foi descontinuado e será removido da API no
            futuro.


            *Objeto detalhando os próximos passos que você deve seguir para um
            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: >-
            A URL para o hosted-widget que guiará seu usuário pelo processo de
            pagamentos.
          example: https://pay.belvo.io/YggaKvPbM5aJhksu1BEwDI5FKTcUc5wZqNB-wH7MFGU
        access_token:
          type: string
          description: >-
            O token de acesso gerado pelo Belvo para o link de pagamento.


            **Nota:** Você precisará do `access_token` para fazer solicitações
            de <a
            href="https://developers.belvo.com/reference/detailcreatepaymentlink"
            target="_blank">Obter detalhes de um link de pagamento</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: >-
            O carimbo de data e hora ISO-8601 de quando o link de pagamento foi
            atualizado pela última vez.
          example: '2022-02-09T08:45:50.406032Z'
        status:
          $ref: '#/components/schemas/EnumPaymentLinksStatus'
        expires_in:
          type: string
          pattern: \d+([mhd])
          description: O tempo de expiração do link de pagamento.
          example: 7d
        expires_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 de quando o link de pagamento está
            programado para expirar.
          example: '2023-02-09T08:45:50.406032Z'
    scheduled_single-2:
      type: object
      title: Único
      description: Agendar um pagamento único (pontual) para o futuro.
      properties:
        single:
          type: object
          description: Agendar um pagamento único (pontual) para o futuro.
          properties:
            date:
              type: string
              format: date
              description: >-
                A data em que o pagamento agendado único deve ser feito, no
                formato `YYYY-MM-DD`.


                >**Nota**: A data deve ser pelo menos 1 dia no futuro e não mais
                do que 720 dias no futuro.
              example: '2024-10-22'
    scheduled_daily-2:
      type: object
      title: Diário
      description: Agendar um pagamento recorrente diário.
      properties:
        daily:
          type: object
          description: Agendar um pagamento recorrente diário.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                A data em que o pagamento diário recorrente deve começar, no
                formato `YYYY-MM-DD`.


                >**Nota**: A `start_date` deve ser pelo menos 1 dia no futuro.
              example: '2024-10-22'
            occurrences:
              type: integer
              minimum: 2
              maximum: 60
              description: >-
                O número de vezes que o pagamento deve se repetir.


                >**Nota**: Você deve agendar pelo menos `2` ocorrências e no
                máximo `60`.
              example: 10
    scheduled_weekly-2:
      type: object
      title: Semanalmente
      description: Agendar um pagamento recorrente semanal.
      properties:
        weekly:
          type: object
          description: Agendar um pagamento recorrente semanal.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                A data em que o pagamento semanal recorrente deve começar, no
                formato `YYYY-MM-DD`.


                >**Nota**: A `start_date` deve corresponder ao primeiro
                `day_of_week` especificado e ser pelo menos 1 dia no futuro.
              example: '2024-10-22'
            day_of_week:
              type: string
              enum:
                - MONDAY
                - TUESDAY
                - WEDNESDAY
                - THURSDAY
                - FRIDAY
                - SATURDAY
                - SUNDAY
              description: >-
                O dia da semana em que o pagamento deve ser feito. Pode ser um
                dos seguintes valores:

                  - `MONDAY`
                  - `TUESDAY`
                  - `WEDNESDAY`
                  - `THURSDAY`
                  - `FRIDAY`
                  - `SATURDAY`
                  - `SUNDAY`
              example: MONDAY
            occurrences:
              type: integer
              minimum: 2
              maximum: 60
              description: >-
                O número de vezes que o pagamento deve se repetir.


                >**Nota**: Você deve agendar pelo menos `2` ocorrências e no
                máximo `60`.
              example: 10
    scheduled_monthly-2:
      type: object
      title: Mensalmente
      description: Agendar um pagamento recorrente mensal.
      properties:
        monthly:
          type: object
          description: Agendar um pagamento recorrente mensal.
          properties:
            start_date:
              type: string
              format: date
              description: >-
                A data em que o pagamento mensal recorrente deve começar, no
                formato `YYYY-MM-DD`.


                >**Nota**: O `start_date` deve corresponder ao primeiro
                `day_of_month` especificado e ser pelo menos 1 dia no futuro.
              example: '2024-10-26'
            day_of_month:
              type: integer
              minimum: 1
              maximum: 31
              description: >-
                O dia do mês em que o pagamento deve ser feito. Pode ser
                qualquer número inteiro entre `1` e `31`.
              example: 26
            occurrences:
              type: integer
              minimum: 2
              maximum: 24
              description: >-
                O número de vezes que o pagamento deve se repetir.


                >**Nota**: Você deve agendar pelo menos `2` ocorrências e no
                máximo `24`.
              example: 12
    scheduled_custom-2:
      type: object
      title: Personalizado
      description: Agendar um pagamento recorrente personalizado.
      required:
        - dates
        - description
      properties:
        custom:
          type: object
          description: Agendar um pagamento recorrente personalizado.
          properties:
            dates:
              type: array
              minItems: 2
              maxItems: 60
              description: >-
                As datas únicas em que o pagamento recorrente deve ser feito, no
                formato `YYYY-MM-DD`.


                >**Nota**: As datas devem ser pelo menos 1 dia no futuro e não
                mais do que 720 dias no futuro.
              items:
                type: string
                format: date
                description: A data do pagamento, no formato `YYYY-MM-DD`.
                example: '2024-10-22'
              example:
                - '2024-10-22'
                - '2024-10-26'
            description:
              type: string
              maxLength: 256
              description: >-
                Uma descrição do pagamento recorrente personalizado que será
                exibida ao seu usuário quando ele for redirecionado para o banco
                para aceitar o pagamento.


                > **Nota**: Recomendamos fortemente que esta mensagem esteja em
                português brasileiro e que explique claramente o propósito e a
                natureza recorrente do pagamento.
              example: >-
                Os pagamentos ocorrerão a cada três dias até a data final
                (30.09.2024)
    schedule-2:
      type: object
      title: Agendar um pagamento
      description: >-
        Detalhes sobre o pagamento agendado (opcional). Para mais informações
        sobre como agendar pagamentos, consulte nosso guia dedicado <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 pagamento selecionado.
      required:
        - beneficiary_bank_account
        - callback_url
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            ID único da Belvo usado para identificar a conta bancária do
            beneficiário.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer_institution:
          type: string
          format: uuid
          description: ID único do Belvo para referenciar a instituição do pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule-2'
        callback_url:
          type: string
          description: >-
            A URL de callback para a qual seu usuário será redirecionado após
            confirmar o pagamento em seu aplicativo bancário.
          example: https://www.acmecorp.com/checkout/3487321
    PaymentIntentPaymentMethodDetailsBodyBusinessRequestOfpi:
      type: object
      title: NEGÓCIOS
      description: Tipo de método de pagamento selecionado.
      required:
        - beneficiary_bank_account
        - payer_institution
        - callback_url
        - cpf
      properties:
        beneficiary_bank_account:
          type: string
          format: uuid
          description: >-
            ID único da Belvo usado para identificar a conta bancária do
            beneficiário.
          example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        payer_institution:
          type: string
          format: uuid
          description: ID único do Belvo para referenciar a instituição do pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule-2'
        callback_url:
          type: string
          description: >-
            A URL de callback para a qual seu usuário será redirecionado após
            confirmar o pagamento em seu aplicativo bancário.
          example: https://www.acmecorp.com/checkout/3487321
        cpf:
          type: string
          description: >-
            O número de CPF do cliente. Necessário apenas quando o
            `customer_type` é `BUSINESS`.
          example: 9744477770
    CreatePaymentIntentOfpi:
      type: object
      title: Intenção de Pagamento (Somente)
      description: Crie uma intenção de pagamento usando um cliente previamente criado.
      required:
        - amount
        - customer
        - description
        - allowed_payment_method_types
        - selected_payment_method_type
        - payment_method_details
        - confirm
      properties:
        amount:
          type: string
          title: cadeia de caracteres
          pattern: \d+(?:\.\d{1,2})?
          example: '1234.12'
          description: >-
            Valor a ser pago pelo seu cliente. Para OFPI, você pode enviar
            números com até duas casas decimais, separados por um ponto `.`. Por
            exemplo: `1234.12`
        customer:
          type: string
          format: uuid
          description: ID único da Belvo para referenciar seu cliente criado anteriormente.
          example: 06dc2f14-1217-4480-9b36-550a944a39d1
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        description:
          type: string
          description: Uma descrição legível por humanos do pagamento.
          example: Shoe payment
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Uma descrição que aparecerá no extrato bancário do cliente
            (recomendado).


            > **Nota**: Se você não usar o parâmetro `statement_description`, o
            valor de `description` será utilizado como a descrição no extrato.
          example: Super Shoe Store - Brown Sneakers
        allowed_payment_method_types:
          type: array
          description: >-
            Uma lista de tipos de métodos de pagamento permitidos nesta intenção
            de pagamento. Para o Brasil (OFPI), esse valor deve ser definido
            como `open_finance`.
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/EnumPaymentLinkAllowedPaymentMethod'
        payment_method_details:
          type: object
          description: Detalhes sobre o método de pagamento 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 a intenção de pagamento.


            **Nota:** Enviar este parâmetro definido como `true` confirma a
            intenção de pagamento.
          example: false
        metadata:
          type: object
          description: >-
            Objeto opcional e personalizável onde você pode fornecer quaisquer
            pares de chave-valor adicionais para seus propósitos internos. Por
            exemplo, um número de referência interno para a intenção de
            pagamento.


            ⚠️ **Nota**: Você pode fornecer até 50 chaves (as chaves podem ter
            até 50 caracteres cada e cada valor pode ter até 500 caracteres).
            Não oferecemos suporte para objetos aninhados, apenas valores ASCII.
          example:
            internal_reference_id: GGq73487w2
        provider:
          $ref: '#/components/schemas/EnumPaymentLinkProvider'
    PaymentIntentPaymentMethodDetailsBodyIndividualRequestOfpiBankAccount:
      type: object
      title: INDIVIDUAL
      description: Tipo de método de pagamento selecionado.
      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 do Belvo para referenciar a instituição do pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        callback_url:
          type: string
          description: >-
            A URL de callback para a qual seu usuário será redirecionado após
            confirmar o pagamento em seu aplicativo bancário.
          example: https://www.acmecorp.com/checkout/3487321
        schedule:
          $ref: '#/components/schemas/schedule-2'
    PaymentIntentPaymentMethodDetailsBodyBusinessRequestOfpiBankAccount:
      type: object
      title: NEGÓCIOS
      description: Tipo de método de pagamento selecionado.
      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 do Belvo para referenciar a instituição do pagador.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        schedule:
          $ref: '#/components/schemas/schedule-2'
        callback_url:
          type: string
          description: >-
            A URL de callback para a qual seu usuário será redirecionado após
            confirmar o pagamento em seu aplicativo bancário.
          example: https://www.acmecorp.com/checkout/3487321
        cpf:
          type: string
          description: >-
            O número de CPF do cliente. Necessário apenas quando o
            `customer_type` é `BUSINESS`.
          example: 9744477770
    CreatePaymentIntentAndCustomerOfpi:
      type: object
      title: Cliente, Conta Bancária e Intenção de Pagamento
      description: >-
        Criar um cliente, conta bancária e intenção de pagamento para o Brasil
        (OFPI).
      required:
        - amount
        - customer
        - description
        - allowed_payment_method_types
        - selected_payment_method_type
        - payment_method_details
        - confirm
      properties:
        amount:
          type: string
          title: cadeia de caracteres
          pattern: \d+(?:\.\d{1,2})?
          example: '1234.12'
          description: >-
            Valor a ser pago pelo seu cliente. Para OFPI, você pode enviar
            números com até duas casas decimais, separados por um ponto `.`. Por
            exemplo: `1234.12`
        customer:
          $ref: '#/components/schemas/CreateCustomerOfpi'
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        description:
          type: string
          description: Uma descrição legível por humanos do pagamento.
          example: Shoe payment
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Uma descrição que aparecerá no extrato bancário do cliente
            (recomendado).


            > **Nota**: Se você não usar o parâmetro `statement_description`, o
            valor de `description` será utilizado como a descrição no extrato.
          example: Super Shoe Store - Brown Sneakers
        allowed_payment_method_types:
          type: array
          description: >-
            Uma lista de tipos de métodos de pagamento permitidos nesta intenção
            de pagamento. Para o Brasil (OFPI), esse valor deve ser definido
            como `open_finance`.
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/EnumPaymentLinkAllowedPaymentMethod'
        payment_method_details:
          type: object
          description: Detalhes sobre o método de pagamento 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 a intenção de pagamento.


            > 📘 Forneça `payer_institution`

            >

            > Para confirmar a intenção de pagamento (`confirm: true`), você
            deve fornecer o parâmetro `payer_institution`.


            **Nota:** Enviar este parâmetro definido como `true` confirma a
            intenção de pagamento.
          example: false
        metadata:
          type: object
          description: >-
            Objeto opcional e personalizável onde você pode fornecer quaisquer
            pares de chave-valor adicionais para seus propósitos internos. Por
            exemplo, um número de referência interno para a intenção de
            pagamento.


            ⚠️ **Nota**: Você pode fornecer até 50 chaves (as chaves podem ter
            até 50 caracteres cada e cada valor pode ter até 500 caracteres).
            Não oferecemos suporte para objetos aninhados, apenas 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 contendo campos adicionais obrigatórios para o fluxo de
            intenção de pagamento.
          properties:
            open_finance:
              type: object
              properties:
                payer_institution:
                  type: string
                  format: uuid
                  description: ID único do Belvo para a instituição do pagador.
                  example: db201c6a-e0ee-4caa-92d6-72b480d6d86f
                beneficiary_bank_account:
                  type: string
                  format: uuid
                  description: ID único do Belvo para a conta bancária do beneficiário.
                  example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
        confirm:
          type: boolean
          default: false
          description: >-
            Boolean que indica se esta solicitação confirma a intenção de
            pagamento.


            **Nota:** Você precisará enviar este parâmetro definido como `true`
            quando o próximo passo da intenção de pagamento retornar
            `ready_to_confirm: true`, o que significa que a intenção de
            pagamento está pronta para ser confirmada.
          example: true
    ContractDebtor:
      type: object
      description: >-
        Detalhes sobre o "proprietário" do contrato. Esta é a pessoa ou entidade
        que está em dívida com o beneficiário (que pode ser diferente do
        pagador). Por exemplo, o contrato pode estar no nome de um dos pais
        (`contract_debtor`), embora seja um dos filhos que está realmente
        fazendo os pagamentos (`payer`).
      required:
        - identifier
        - name
      properties:
        identifier:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11,14}$
          description: >-
            O CPF ou CNPJ do devedor. Para CPF, deve ter 11 caracteres. Para
            CNPJ, deve ter 14 caracteres.
          example: '12345678901'
        name:
          type: string
          minLength: 1
          maxLength: 120
          pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]{0,120})$
          description: O nome completo do devedor.
          example: João da Silva
    PaymentConfigurationFixed:
      type: object
      title: PIX_DE_FIXO_AUTOMÁTICO
      description: >-
        Detalhes de configuração para o método de pagamento
        `PIX_OF_AUTOMATIC_FIXED`.
      properties:
        amount:
          type: string
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: |-
            {% admonition type="warning" name="Apenas para Pagamentos Fixos" %}
              Apenas para Pagamentos Fixos (`PIX_OF_AUTOMATIC_FIXED`).
            {% /admonition %}

            O valor que seu cliente será cobrado.
          example: '10000.05'
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          description: A descrição que aparecerá no extrato bancário do seu cliente.
          example: Monthly Gym - Premium Plan
        frequency:
          type: string
          enum:
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - BIANNUAL
            - YEARLY
          description: |-
            A frequência com que os pagamentos serão realizados. Pode ser:
            - `WEEKLY`
            - `MONTHLY`
            - `QUARTERLY`
            - `BIANNUAL`
            - `YEARLY`
          example: MONTHLY
        start_date:
          type: string
          format: date
          description: >-
            A data em que a autorização (e o primeiro pagamento do 'cycle')
            começará, no formato `YYYY-MM-DD`.
          example: '2025-06-01'
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data em que a autorização terminará, no formato `YYYY-MM-DD`. Se
            nenhum `end_date` for enviado, a Autorização de Pagamento será
            válida por um prazo indefinido.
          example: '2026-06-01'
        contract_id:
          type: string
          minLength: 1
          maxLength: 35
          pattern: ^[a-zA-Z0-9]{1,35}$
          description: O ID do contrato do comerciante com o cliente para o serviço.
          example: PREMIUMPLAN123456
        contract_debtor:
          $ref: '#/components/schemas/ContractDebtor'
        retries:
          type: boolean
          default: false
          description: >-
            Boolean que indica se tentativas de pagamento são permitidas. Por
            padrão, isso é definido como `false`.
          example: true
        authorization_url:
          type: string
          format: uri
          minLength: 1
          maxLength: 2048
          description: >-
            A URL para onde o usuário deve ser redirecionado para autorizar o
            pagamento.
          example: https://auth.belvo.com/authorize?token=abc123def456
        first_payment:
          type: object
          description: >-
            Detalhes sobre o primeiro pagamento imediato. (Aplicável apenas para
            `PIX_OF_AUTOMATIC_FIXED` e `PIX_OF_AUTOMATIC_VARIABLE`.)
          properties:
            date:
              type: string
              format: date
              description: >-
                A data em que o pagamento deve ser feito, no formato
                `YYYY-MM-DD`.
              example: '2025-05-15'
            amount:
              type: string
              pattern: ^-?\d{1,15}\.\d{2,4}$
              description: >-
                O valor a ser pago. O valor nunca pode exceder o `amount` (Fixo)
                ou `maximum_amount` (Variável) definido na Autorização de
                Pagamento.
              example: '3000.02'
    PaymentConfigurationVariable:
      type: object
      title: PIX_DE_VARIÁVEL_AUTOMÁTICA
      description: >-
        Detalhes de configuração para o método de pagamento
        `PIX_OF_AUTOMATIC_VARIABLE`.
      properties:
        minimum_amount:
          type: string
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: >-
            {% admonition type="warning" name="Somente para Pagamentos
            Variáveis" %}
              Somente para Pagamentos Variáveis (`PIX_OF_AUTOMATIC_VARIABLE`).
            {% /admonition %}


            O valor mínimo que seu cliente será cobrado.
          example: '10000.01'
        maximum_amount:
          type: string
          pattern: ^-?\d{1,15}\.\d{2,4}$
          description: >-
            {% admonition type="warning" name="Somente para Pagamentos
            Variáveis" %}
              Somente para Pagamentos Variáveis (`PIX_OF_AUTOMATIC_VARIABLE`).
            {% /admonition %}


            O valor máximo que seu cliente será cobrado.
          example: '50000.50'
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          description: A descrição que aparecerá no extrato bancário do seu cliente.
          example: Monthly Gym - Premium Plan
        frequency:
          type: string
          enum:
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - BIANNUAL
            - YEARLY
          description: |-
            A frequência com que os pagamentos serão realizados. Pode ser:
            - `WEEKLY`
            - `MONTHLY`
            - `QUARTERLY`
            - `BIANNUAL`
            - `YEARLY`
          example: MONTHLY
        start_date:
          type: string
          format: date
          description: >-
            A data em que a autorização (e o primeiro pagamento do 'cycle')
            começará, no formato `YYYY-MM-DD`.
          example: '2025-06-01'
        end_date:
          type: string
          format: date
          nullable: true
          description: >-
            A data em que a autorização terminará, no formato `YYYY-MM-DD`. Se
            nenhum `end_date` for enviado, a Autorização de Pagamento será
            válida por um prazo indefinido.
          example: '2026-06-01'
        contract_id:
          type: string
          minLength: 1
          maxLength: 35
          pattern: ^[a-zA-Z0-9]{1,35}$
          description: O ID do contrato do comerciante com o cliente para o serviço.
          example: PREMIUMPLAN123456
        contract_debtor:
          $ref: '#/components/schemas/ContractDebtor'
        retries:
          type: boolean
          default: false
          description: >-
            Boolean que indica se tentativas de pagamento são permitidas. Por
            padrão, isso é definido como `false`.
          example: true
        authorization_url:
          type: string
          format: uri
          minLength: 1
          maxLength: 2048
          description: >-
            A URL para onde o usuário deve ser redirecionado para autorizar o
            pagamento.
          example: https://auth.belvo.com/authorize?token=abc123def456
        first_payment:
          type: object
          description: >-
            Detalhes sobre o primeiro pagamento imediato. (Aplicável apenas para
            `PIX_OF_AUTOMATIC_FIXED` e `PIX_OF_AUTOMATIC_VARIABLE`.)
          properties:
            date:
              type: string
              format: date
              description: >-
                A data em que o pagamento deve ser feito, no formato
                `YYYY-MM-DD`.
              example: '2025-05-15'
            amount:
              type: string
              pattern: ^-?\d{1,15}\.\d{2,4}$
              description: >-
                O valor a ser pago. O valor nunca pode exceder o `amount` (Fixo)
                ou `maximum_amount` (Variável) definido na Autorização de
                Pagamento.
              example: '3000.02'
    metadata__payments:
      type: object
      description: >-
        Objeto opcional e personalizável onde você pode fornecer quaisquer pares
        de chave-valor adicionais para seus propósitos internos. Por exemplo, um
        número de referência interno para a intenção de pagamento.


        {% admonition type="info" name="Limitações de Metadata" %}
          Você pode fornecer até 50 chaves (as chaves podem ter até 50 caracteres cada e cada valor pode ter até 500 caracteres). Não suportamos objetos aninhados, apenas valores ASCII.
        {% /admonition %}
      maxProperties: 50
      additionalProperties:
        type: string
        maxLength: 500
        pattern: "^[\0-\x7F]*$"
      example:
        internal_reference_id: GGq73487w2
    PaymentAuthorization:
      type: object
      title: Autorização de Pagamento
      description: Detalhes da Autorização de Pagamento.
      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: O Belvo ID para a Autorização de Pagamento.
          example: 9fc68b84-f2d6-4142-b2ad-9d2d1ad70432
        created_at:
          type: string
          format: date-time
          description: >-
            O timestamp ISO-8601 de quando a Autorização de Pagamento foi
            criada.
          example: '2025-05-20T09:55:02Z'
        updated_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data e hora ISO-8601 de quando a Autorização de
            Pagamento foi atualizada pela última vez.
          example: '2025-05-20T09:55:02Z'
        status:
          type: string
          description: O status atual da Autorização de Pagamento.
          enum:
            - AWAITING_AUTHORIZATION
            - AUTHORIZED
            - AUTHORIZATION_FAILED
            - EXPIRED
            - CANCELLED
            - COMPLETED
          example: AWAITING_AUTHORIZATION
        status_reason_code:
          type: string
          nullable: true
          description: Um código indicando o motivo do status atual (quando aplicável).
          example: null
        status_reason_message:
          type: string
          nullable: true
          description: >-
            Uma mensagem legível por humanos explicando o motivo do status atual
            (quando aplicável).
          example: null
        status_updated_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data e hora ISO-8601 de quando o status foi atualizado
            pela última vez.
          example: '2025-05-20T09:55:02Z'
        authorized_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            O timestamp ISO-8601 de quando a Autorização de Pagamento foi
            autorizada pelo usuário.
          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: O ID interno do comerciante para a autorização.
          example: c169a8a9-e9f5-48db-9f4a-818caef9356b
        description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: ^[\w\W\s]+$
          description: Uma descrição interna usada apenas pelo comerciante.
          example: Internal description used by the merchant only
        return_url:
          type: string
          format: uri
          minLength: 1
          maxLength: 2048
          description: A URL para onde o usuário será redirecionado após a autorização.
          example: https://merchant.com/return
        payment_method:
          type: string
          enum:
            - PIX_OF_AUTOMATIC_FIXED
            - PIX_OF_AUTOMATIC_VARIABLE
          description: O método de pagamento que foi autorizado.
          example: PIX_OF_AUTOMATIC_FIXED
        payer:
          type: object
          description: Detalhes sobre o 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: O ID Belvo para o 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: O ID Belvo da instituição que o pagador usará.
              example: 770932b4-8f1f-4b0f-8470-1c605903fdb2
            representative_identifier:
              type: string
              minLength: 11
              maxLength: 14
              pattern: ^[0-9]{11,14}$
              description: >-
                No caso de o cliente ser uma empresa, o CPF do representante
                autorizado a realizar pagamentos.
              example: '12345678901122'
        beneficiary:
          type: object
          description: Detalhes sobre o beneficiário do pagamento.
          properties:
            type:
              type: string
              enum:
                - BANK_ACCOUNT
              description: O tipo de conta do beneficiário.
              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: O ID Belvo da conta bancária que receberá os fundos.
              example: b6278377-f710-4d1a-a026-7bab757256d0
        payment_method_configuration:
          type: object
          description: Detalhes de configuração para o método de pagamento.
          oneOf:
            - $ref: '#/components/schemas/PaymentConfigurationFixed'
            - $ref: '#/components/schemas/PaymentConfigurationVariable'
        charges:
          type: array
          minItems: 0
          description: Uma lista de IDs de Cobrança associados à Autorização de Pagamento.
          items:
            type: string
            format: uuid
            description: O Belvo ID da Cobrança.
            example: 7d159b21-9f25-4365-9fa2-734d20797819
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    CustomerObject:
      type: object
      title: CPF ou CNPJ
      description: >-
        Detalhes do cliente que está fazendo pagamentos ao beneficiário. Se o
        cliente existir, retornamos seu ID Belvo. Caso contrário, criamos um
        novo cliente e retornamos o ID Belvo recém-atribuído.
      required:
        - identifier
        - name
      properties:
        identifier:
          type: string
          minLength: 11
          maxLength: 14
          pattern: ^[0-9]{11,14}$
          description: >-
            O CPF ou CNPJ do cliente. Para CPF, deve ter 11 caracteres. Para
            CNPJ, deve ter 14 caracteres.
          example: '12345678901'
        name:
          type: string
          minLength: 1
          maxLength: 120
          pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]{0,120})$
          description: O nome completo do cliente.
          example: João da Silva
        external_id:
          $ref: '#/components/schemas/external_id__payments'
    CustomerId:
      type: string
      title: Belvo ID
      format: uuid
      description: >-
        O ID Belvo do cliente previamente criado que fará os pagamentos ao
        beneficiário.


        {% admonition type="warning" name="Cliente de Payments-BR.V2" %}
          O ID do cliente fornecido deve ser um que foi criado usando a versão `Payments-BR.V2` da nossa API. Por exemplo, utilizando a opção de Detalhes da Conta Bancária ao criar a Autorização de Pagamento, ou o endpoint Criar um Cliente com o cabeçalho `X-Belvo-API-Resource-Version: Payments-BR.V2`.
          Se você fornecer um ID que não seja compatível com a versão `Payments-BR.V2`, você receberá o seguinte erro: `The customer does not exist or is invalid.`.
        {% /admonition %}
      example: c169a8a9-e9f5-48db-9f4a-818caef9356b
    BankAccountObject:
      type: object
      title: Detalhes da Conta Bancária
      description: >-
        Detalhes da conta bancária a ser registrada. Se a conta bancária
        existir, retornamos o ID Belvo dela. Caso contrário, criamos uma nova
        conta bancária e retornamos o ID Belvo recém-atribuído.
      required:
        - details
        - holder
      properties:
        holder:
          type: object
          description: Detalhes do titular da conta.
          required:
            - identifier
            - name
          properties:
            identifier:
              type: string
              minLength: 11
              maxLength: 14
              pattern: ^[0-9]{11,14}$
              description: |-
                O CPF (11 dígitos) ou CNPJ (14 dígitos) do titular da conta.

                {% admonition type="info" name="Pix Automático" %}
                  No caso de Pix Automático (`payment_method` é `PIX_OF_AUTOMATICO_FIXED` ou `PIX_OF_AUTOMATICO_VARIABLE`), o `identifier` deve ser um CNPJ (14 dígitos).
                {% /admonition %}
              example: '12345678901122'
            name:
              type: string
              maxLength: 120
              pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]{0,120})$
              description: O nome completo ou razão social do titular da conta.
              example: Frangos Enlatados
        details:
          type: object
          description: Detalhes da conta bancária.
          required:
            - account_type
            - agency
            - institution
            - number
          properties:
            account_type:
              type: string
              enum:
                - CHECKINGS
                - SAVINGS
                - PAYMENTS
              description: |-
                O tipo de conta bancária. Pode ser:
                  - `CHECKINGS` (também conhecida como Conta Corrente no Brasil)
                  - `SAVINGS` (também conhecida como Conta Poupança no Brasil)
                  - `PAYMENTS` (também conhecida como Conta de Pagamento Instantâneo ou Conta de Pagamento no Brasil)
              example: CHECKINGS
            agency:
              type: string
              minLength: 1
              maxLength: 4
              pattern: ^[0-9]{1,4}$
              description: >-
                A agência (número da filial) da instituição onde a conta foi
                criada.
              example: '0444'
            institution:
              type: string
              format: uuid
              description: O ID Belvo da instituição financeira.
              example: f512d996-583a-4a91-8b5b-eba2e103b068
            number:
              type: string
              pattern: ^[0-9]{1,20}$
              minLength: 1
              maxLength: 20
              description: >-
                O número da conta bancária.


                {% admonition type="info" name="Caracteres válidos para número
                de conta" %}
                  Você pode enviar apenas números (`^[0-9]+$`) na string. Por exemplo, `"457220"` é um número de conta bancária válido, enquanto "`45722-0`" é inválido, pois contém um hífen (`-`).
                {% /admonition %}
              example: '457220'
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    BankAccountId:
      type: string
      title: ID da Conta Bancária
      format: uuid
      description: >-
        O ID Belvo da conta bancária que você registrou anteriormente e que
        receberá os fundos.


        {% admonition type="warning" name="Conta Bancária de Payments-BR.V2" %}
          O ID da conta bancária fornecido deve ser um que foi criado usando a versão `Payments-BR.V2` da nossa API. Por exemplo, utilizando a opção Detalhes da Conta Bancária ao criar a Autorização de Pagamento, ou o endpoint Registrar Conta Bancária com o cabeçalho `X-Belvo-API-Resource-Version: Payments-BR.V2`.
          Se você fornecer um ID que não seja compatível com a versão `Payments-BR.V2`, você receberá o seguinte erro: `The bank account does not exist or is invalid.`.
        {% /admonition %}
      example: b6278377-f710-4d1a-a026-7bab757256d0
    CreatePaymentAuthorizationFixed:
      type: object
      title: Fixo
      description: Criar uma Autorização de Pagamento Fixo.
      required:
        - payment_method
        - description
        - return_url
        - payer
        - beneficiary
        - payment_method_configuration
      properties:
        payment_method:
          type: string
          enum:
            - PIX_OF_AUTOMATIC_FIXED
          description: >-
            O método de pagamento a ser autorizado. Para pagamentos fixos, isso
            deve ser definido como `PIX_OF_AUTOMATIC_FIXED`.
          example: PIX_OF_AUTOMATIC_FIXED
        description:
          type: string
          description: Uma descrição interna para o comerciante.
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          example: Monthly gym subscription payment
        external_id:
          type: string
          format: uuid
          description: >-
            (Altamente Recomendado) O ID interno do comerciante para a
            autorização.
          example: c169a8a9-e9f5-48db-9f4a-818caef9356b
        return_url:
          type: string
          format: uri
          description: >-
            A URL para a qual o usuário deve ser redirecionado após autorizar o
            pagamento na instituição.
          example: https://merchant.com/return
        payer:
          type: object
          description: Detalhes sobre o pagador.
          required:
            - customer
          properties:
            customer:
              description: >-
                Detalhes do cliente que está fazendo pagamentos ao beneficiário.
                Você pode fornecer o CPF ou CNPJ do cliente, ou o ID Belvo dele.
                Se você fornecer o ID Belvo, ele deve ser um UUID de um cliente
                que já foi criado no Belvo. Se você fornecer o CPF ou CNPJ,
                verificaremos se o cliente existe no Belvo. Se o cliente
                existir, retornamos o ID Belvo dele. Caso contrário, criamos um
                novo cliente e retornamos o novo ID Belvo atribuído.
              oneOf:
                - $ref: '#/components/schemas/CustomerObject'
                - $ref: '#/components/schemas/CustomerId'
            institution:
              type: string
              description: >-
                O ID Belvo da instituição que o pagador usará para pagar pelo
                serviço do comerciante. Para obter o ID Belvo de uma
                instituição, use o [endpoint de
                Instituições](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: >-
                No caso de o cliente ser uma empresa, este é o CPF do
                representante autorizado a efetuar pagamentos pela empresa.
              example: '12345678901234'
        beneficiary:
          type: object
          description: Detalhes sobre o beneficiário do pagamento.
          required:
            - type
            - target
          properties:
            type:
              type: string
              enum:
                - BANK_ACCOUNT
              description: >-
                O tipo de conta do beneficiário. Atualmente, isso deve ser
                definido como `BANK_ACCOUNT`.
              example: BANK_ACCOUNT
            target:
              oneOf:
                - $ref: '#/components/schemas/BankAccountObject'
                - $ref: '#/components/schemas/BankAccountId'
              description: >-
                Detalhes sobre a conta bancária que receberá os fundos. Você
                pode fornecer os detalhes completos da conta bancária ou o Belvo
                ID. Se você fornecer os detalhes completos da conta bancária,
                verificaremos se a conta bancária existe no Belvo. Se a conta
                bancária existir, retornamos o Belvo ID dela. Caso contrário,
                criamos uma nova conta bancária e retornamos o Belvo ID
                recém-atribuído.
        payment_method_configuration:
          type: object
          description: Detalhes sobre o pagamento.
          required:
            - amount
            - statement_description
            - frequency
            - start_date
            - contract_id
            - contract_debtor
          properties:
            amount:
              type: number
              format: float
              description: >-
                {% admonition type="warning" name="Apenas para Pagamentos Fixos"
                %}
                  Apenas para Pagamentos Fixos (`PIX_OF_AUTOMATIC_FIXED`).
                {% /admonition %}


                O valor que seu cliente será cobrado.
              example: 10000.05
            statement_description:
              type: string
              minLength: 1
              maxLength: 140
              pattern: '[\w\W\s]{1,140}'
              description: A descrição que aparecerá no extrato bancário do seu cliente.
              example: Monthly Gym - Premium Plan
            frequency:
              type: string
              enum:
                - WEEKLY
                - MONTHLY
                - QUARTERLY
                - BIANNUAL
                - YEARLY
              description: |-
                A frequência com que os pagamentos serão realizados. Pode ser:
                - `WEEKLY`
                - `MONTHLY`
                - `QUARTERLY`
                - `BIANNUAL`
                - `YEARLY`
              example: MONTHLY
            start_date:
              type: string
              format: date
              description: >-
                A data em que a autorização (e o primeiro pagamento do 'ciclo')
                começará, no formato `YYYY-MM-DD`. Deve ser pelo menos dois dias
                a partir da data atual.
              example: '2025-06-01'
            end_date:
              type: string
              format: date
              description: >-
                {% admonition type="info" name="Envie apenas quando end_date for
                conhecida" %}
                  Se você souber a data de término da autorização, pode enviá-la. Caso contrário, pode omitir o envio deste campo. No entanto, não envie uma string vazia ou `null` como valor para este campo, pois isso causará um erro.
                {% /admonition %}


                A data em que a autorização terminará, no formato `YYYY-MM-DD`.
                Se nenhum `end_date` for enviado, a Autorização de Pagamento
                será válida por um prazo indefinido.
              example: '2026-06-01'
            contract_id:
              type: string
              minLength: 1
              maxLength: 35
              pattern: ^[a-zA-Z0-9]{1,35}$
              description: O ID do contrato do comerciante com o cliente para o serviço.
              example: PREMIUMPLAN123456
            contract_debtor:
              $ref: '#/components/schemas/ContractDebtor'
            retries:
              type: boolean
              default: false
              description: >-
                Boolean que indica se tentativas de pagamento são permitidas.
                Por padrão, isso é definido como `false`.
              example: true
            first_payment:
              type: object
              description: >-
                {% admonition type="warning" name="Em Beta" %}
                  Este recurso está atualmente em beta e disponível apenas para clientes selecionados. Se você estiver interessado em usar este recurso, entre em contato com seu representante Belvo.
                {% /admonition %}


                Detalhes sobre o primeiro pagamento imediato. (Aplicável apenas
                para `PIX_OF_AUTOMATIC_FIXED` e `PIX_OF_AUTOMATIC_VARIABLE`.)
              properties:
                date:
                  type: string
                  format: date
                  description: >-
                    A data em que o pagamento deve ser feito, no formato
                    `YYYY-MM-DD`. Pode ser definida como a data "de hoje". Se a
                    data for uma data futura, deve ser anterior à `start_date`.
                  example: '2025-05-15'
                amount:
                  type: number
                  format: float
                  description: >-
                    O valor a ser pago. O valor nunca pode exceder o `amount`
                    (Fixo) ou `maximum_amount` (Variável) definido na
                    Autorização de Pagamento.
                  example: 3000.02
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    CreatePaymentAuthorizationVariable:
      type: object
      title: Variável
      description: Criar uma Autorização de Pagamento Variável.
      required:
        - payment_method
        - description
        - return_url
        - payer
        - beneficiary
        - payment_method_configuration
      properties:
        payment_method:
          type: string
          enum:
            - PIX_OF_AUTOMATIC_VARIABLE
          description: >-
            O método de pagamento a ser autorizado. Para pagamentos variáveis,
            isso deve ser definido como `PIX_OF_AUTOMATIC_VARIABLE`.
          example: PIX_OF_AUTOMATIC_VARIABLE
        description:
          type: string
          description: Uma descrição interna para o comerciante.
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          example: Monthly gym subscription payment
        external_id:
          type: string
          format: uuid
          description: >-
            (Altamente Recomendado) O ID interno do comerciante para a
            autorização.
          example: c169a8a9-e9f5-48db-9f4a-818caef9356b
        return_url:
          type: string
          format: uri
          description: >-
            A URL para a qual o usuário deve ser redirecionado após autorizar o
            pagamento na instituição.
          example: https://merchant.com/return
        payer:
          type: object
          description: Detalhes sobre o pagador.
          required:
            - customer
          properties:
            customer:
              description: >-
                Detalhes do cliente que está realizando pagamentos ao
                beneficiário. Você pode fornecer o CPF ou CNPJ do cliente, ou o
                ID Belvo dele. Se você fornecer o CPF ou CNPJ, verificaremos se
                o cliente existe na Belvo. Se o cliente existir, retornamos o ID
                Belvo dele. Caso contrário, criamos um novo cliente e retornamos
                o ID Belvo recém-atribuído.
              oneOf:
                - $ref: '#/components/schemas/CustomerObject'
                - $ref: '#/components/schemas/CustomerId'
            institution:
              type: string
              description: >-
                O ID Belvo da instituição que o pagador usará para pagar pelo
                serviço do comerciante. Para obter o ID Belvo de uma
                instituição, use o [endpoint de
                Instituições](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: >-
                No caso de o cliente ser uma empresa, este é o CPF do
                representante autorizado a efetuar pagamentos pela empresa.
              example: '12345678901234'
        beneficiary:
          type: object
          description: Detalhes sobre o beneficiário do pagamento.
          required:
            - type
            - target
          properties:
            type:
              type: string
              enum:
                - BANK_ACCOUNT
              description: >-
                O tipo de conta do beneficiário. Atualmente, isso deve ser
                definido como `BANK_ACCOUNT`.
              example: BANK_ACCOUNT
            target:
              oneOf:
                - $ref: '#/components/schemas/BankAccountObject'
                - $ref: '#/components/schemas/BankAccountId'
              description: >-
                Detalhes sobre a conta bancária que receberá os fundos. Você
                pode fornecer os detalhes completos da conta bancária ou o Belvo
                ID. Se você fornecer os detalhes completos da conta bancária,
                verificaremos se a conta bancária existe no Belvo. Se a conta
                bancária existir, retornamos o Belvo ID dela. Caso contrário,
                criamos uma nova conta bancária e retornamos o Belvo ID
                recém-atribuído.
        payment_method_configuration:
          type: object
          description: Detalhes sobre o pagamento.
          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="Somente para Pagamentos
                Variáveis" %}
                  Somente para Pagamentos Variáveis (`PIX_OF_AUTOMATIC_VARIABLE`).
                {% /admonition %}


                O valor mínimo que seu cliente será cobrado.
              example: 10000.01
            maximum_amount:
              type: number
              format: float
              description: >-
                {% admonition type="warning" name="Somente para Pagamentos
                Variáveis" %}
                  Somente para Pagamentos Variáveis (`PIX_OF_AUTOMATIC_VARIABLE`).
                {% /admonition %}


                O valor máximo que seu cliente pode ser cobrado. Note que,
                durante o processo de concessão de consentimento, o cliente pode
                definir um valor máximo que seja inferior a este valor.
              example: 50000.5
            statement_description:
              type: string
              minLength: 1
              maxLength: 140
              pattern: '[\w\W\s]{1,140}'
              description: A descrição que aparecerá no extrato bancário do seu cliente.
              example: Monthly Gym - Premium Plan
            frequency:
              type: string
              enum:
                - WEEKLY
                - MONTHLY
                - QUARTERLY
                - BIANNUAL
                - YEARLY
              description: |-
                A frequência com que os pagamentos serão realizados. Pode ser:
                - `WEEKLY`
                - `MONTHLY`
                - `QUARTERLY`
                - `BIANNUAL`
                - `YEARLY`
              example: MONTHLY
            start_date:
              type: string
              format: date
              description: >-
                A data em que a autorização (e o primeiro pagamento do 'ciclo')
                começará, no formato `YYYY-MM-DD`. Deve ser pelo menos dois dias
                a partir da data atual.
              example: '2025-06-01'
            end_date:
              type: string
              format: date
              description: >-
                {% admonition type="info" name="Envie apenas quando end_date for
                conhecida" %}
                  Se você souber a data de término da autorização, pode enviá-la. Caso contrário, pode omitir o envio deste campo. No entanto, não envie uma string vazia ou `null` como valor para este campo, pois isso causará um erro.
                {% /admonition %}


                A data em que a autorização terminará, no formato `YYYY-MM-DD`.
                Se nenhum `end_date` for enviado, a Autorização de Pagamento
                será válida por um prazo indefinido.
              example: '2026-06-01'
            contract_id:
              type: string
              minLength: 1
              maxLength: 35
              pattern: ^[a-zA-Z0-9]{1,35}$
              description: O ID do contrato do comerciante com o cliente para o serviço.
              example: PREMIUMPLAN123456
            contract_debtor:
              $ref: '#/components/schemas/ContractDebtor'
            retries:
              type: boolean
              default: false
              description: >-
                Boolean que indica se tentativas de pagamento são permitidas.
                Por padrão, isso é definido como `false`.
              example: true
            first_payment:
              type: object
              description: >-
                {% admonition type="warning" name="Em Beta" %}
                  Este recurso está atualmente em beta e disponível apenas para clientes selecionados. Se você estiver interessado em usar este recurso, entre em contato com seu representante da Belvo.
                {% /admonition %}


                Detalhes sobre o primeiro pagamento imediato.  

                Aplicável apenas para `PIX_OF_AUTOMATIC_FIXED` e
                `PIX_OF_AUTOMATIC_VARIABLE`.
              properties:
                date:
                  type: string
                  format: date
                  description: >-
                    A data em que o pagamento deve ser feito, no formato
                    `YYYY-MM-DD`. Pode ser definida como a data "de hoje". Se a
                    data for uma data futura, deve ser anterior à `start_date`.
                  example: '2025-05-15'
                amount:
                  type: number
                  format: float
                  description: >-
                    O valor a ser pago. O valor nunca pode exceder o `amount`
                    (Fixo) ou `maximum_amount` (Variável) definido na
                    Autorização de Pagamento.
                  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: >-
            O carimbo de data e hora ISO-8601 de quando o status da Cobrança foi
            atualizado pela última vez.
          example: '2025-06-09T08:45:50.406032Z'
        status:
          type: string
          enum:
            - PENDING
            - SCHEDULED
            - SETTLED
            - CANCELED
            - FAILED
          description: |-
            O status atual da Cobrança. Pode ser um dos seguintes valores:

              - `PENDING`
              - `SCHEDULED`
              - `SETTLED`
              - `CANCELED`
              - `FAILED`
          example: PENDING
        status_reason_code:
          type: string
          nullable: true
          description: O código de motivo para o status atual da Cobrança, se aplicável.
          example: null
        status_reason_message:
          type: string
          nullable: true
          description: Mais informações sobre o `status_reason_code`.
          example: null
        amount:
          type: string
          nullable: true
          description: O valor da Charge.
          example: '100.12'
        date:
          type: string
          format: date
          nullable: true
          description: A data original da Cobrança.
          example: '2025-06-09'
        end_to_end_id:
          type: string
          nullable: true
          description: >-
            O ID de ponta a ponta da Cobrança. Este é um identificador único
            para a transação que pode ser usado para rastreá-la em diferentes
            sistemas.
          example: 1234567890abcdef
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          description: >-
            A descrição que aparecerá no extrato bancário do cliente (se
            fornecida).
          example: Super Shoe Store - Brown Sneakers
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        beneficiary:
          type: object
          description: Informações sobre o beneficiário da Cobrança.
          properties:
            bank_account:
              type: object
              description: Informações sobre a conta bancária do beneficiário.
              properties:
                id:
                  type: string
                  format: uuid
                  description: >-
                    ID único da Belvo usado para identificar a conta bancária do
                    beneficiário.
                  example: 088bc38f-1430-40c5-a5d2-80bd67189d11
                holder:
                  type: object
                  description: >-
                    Informações sobre o titular da conta bancária do
                    beneficiário.
                  properties:
                    name:
                      type: string
                      description: >-
                        O nome completo do titular da conta bancária do
                        beneficiário.
                      example: Jane Smith
                    identifier:
                      type: string
                      description: >-
                        O identificador do titular da conta bancária do
                        beneficiário. Pode ser um CPF (11 caracteres) ou CNPJ
                        (14 caracteres).
                      minLength: 11
                      maxLength: 14
                      example: '12345678901'
                details:
                  type: object
                  description: Detalhes da conta bancária do beneficiário.
                  properties:
                    institution:
                      type: string
                      format: uuid
                      description: >-
                        ID único do Belvo usado para identificar o banco do
                        beneficiário.
                      example: f47ac10b-58cc-4372-a567-0e02b2c3d479
                    agency:
                      type: string
                      description: O número da agência da conta bancária do beneficiário.
                      example: '5678'
                    number:
                      type: string
                      description: O número da conta do banco do beneficiário.
                      example: '987654321'
                    account_type:
                      type: string
                      description: >-
                        O tipo da conta bancária do beneficiário. Pode ser
                        `CHECKINGS`, `SAVINGS` ou `PAYMENTS`.
                      example: SAVINGS
                    code:
                      type: string
                      description: O código ISPB do banco do beneficiário.
                      example: '678901'
        payer:
          type: object
          description: Informações sobre o pagador da Cobrança.
          properties:
            bank_account:
              type: object
              description: Informações sobre a conta bancária do pagador.
              properties:
                holder:
                  type: object
                  description: Informações sobre o titular da conta bancária do pagador.
                  properties:
                    identifier:
                      type: string
                      description: >-
                        O identificador do titular da conta bancária do pagador.
                        Pode ser um CPF (11 caracteres) ou CNPJ (14 caracteres).
                      minLength: 11
                      maxLength: 14
                      example: '12345678902'
                details:
                  type: object
                  description: Detalhes da conta bancária do pagador.
                  properties:
                    institution:
                      type: string
                      format: uuid
                      description: >-
                        ID único do Belvo usado para identificar o banco do
                        pagador.
                    code:
                      type: string
                      description: O código ISPB do banco do pagador.
                      example: '123345'
                    account_type:
                      type: string
                      description: >-
                        O tipo da conta bancária do pagador. Pode ser
                        `CHECKINGS`, `SAVINGS` ou `PAYMENTS`.
                      example: CHECKINGS
                    agency:
                      type: string
                      description: O número da agência da conta bancária do pagador.
                      example: '1234'
                    number:
                      type: string
                      description: O número da conta bancária do pagador.
                      example: '123456789'
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    CreateChargePixAutomaticoDefaultBankAccount:
      type: object
      title: Cobrança para Conta Bancária Padrão
      description: >-
        Crie uma Cobrança para a conta bancária padrão associada à Autorização
        de Pagamento.
      required:
        - amount
        - date
        - statement_description
      properties:
        amount:
          type: number
          format: float
          minimum: 0.01
          description: >-
            O valor do pagamento.


            - Para `PIX_OF_AUTOMATIC_FIXED`, este deve ser o mesmo valor que
            você enviou na autorização.

            - Para `PIX_OF_AUTOMATIC_VARIABLE`, este deve estar entre os valores
            `minimum` e `maximum` que você enviou na autorização.
          example: 100.01
        date:
          type: string
          format: date
          description: >-
            A data em que o pagamento deve ser feito, no formato `YYYY-MM-DD`.
            Deve ser pelo menos dois dias após a data atual.
          example: '2025-05-15'
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          description: A descrição que aparecerá no extrato bancário do seu cliente.
          example: Monthly Gym - Premium Plan
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        metadata:
          $ref: '#/components/schemas/metadata__payments'
    CreateChargePixAutomaticoDifferentBankAccount:
      type: object
      title: Cobrança para Conta Bancária Diferente
      description: >-
        Crie uma Cobrança para uma conta bancária que não foi originalmente
        associada à Autorização de Pagamento.
      required:
        - amount
        - date
        - statement_description
        - beneficiary
      properties:
        amount:
          type: number
          format: float
          minimum: 0.01
          description: >-
            O valor do pagamento.


            - Para `PIX_OF_AUTOMATIC_FIXED`, este deve ser o mesmo valor que
            você enviou na autorização.

            - Para `PIX_OF_AUTOMATIC_VARIABLE`, este deve estar entre os valores
            `minimum` e `maximum` que você enviou na autorização.
          example: 100.01
        date:
          type: string
          format: date
          description: >-
            A data em que o pagamento deve ser feito, no formato `YYYY-MM-DD`.
            Deve ser pelo menos dois dias após a data atual.
          example: '2025-05-15'
        statement_description:
          type: string
          minLength: 1
          maxLength: 140
          pattern: '[\w\W\s]{1,140}'
          description: A descrição que aparecerá no extrato bancário do seu cliente.
          example: Monthly Gym - Premium Plan
        beneficiary:
          type: object
          description: Detalhes da conta bancária que receberá o pagamento.
          required:
            - target
          properties:
            target:
              type: string
              format: uuid
              description: >-
                O ID Belvo da conta bancária que você registrou anteriormente e
                que receberá os fundos. Para mais informações sobre como
                registrar uma conta bancária, consulte o [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: Detalhes sobre o registro de dispositivos para pagamentos Biometric Pix.
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único da inscrição da Belvo.
          example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        created_by:
          type: string
          format: uuid
          description: O ID Belvo do comerciante que criou a inscrição.
          example: dbdce1e9-d089-4b7d-804b-51dd07748202
        created_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data/hora ISO-8601 de quando o ponto de dados foi
            criado no banco de dados da Belvo.
          example: '2024-11-26T11:20:57.389056Z'
        updated_at:
          type: string
          format: date-time
          description: >-
            O carimbo de data e hora ISO-8601 de quando a inscrição foi
            atualizada pela última vez.
          example: '2024-11-26T11:20:57.389058Z'
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        type:
          type: string
          enum:
            - open_finance_biometric_pix
          description: |-
            O tipo de inscrição. Para o OFPI do 🇧🇷 Brasil, pode ser:

              - `open_finance_biometric_pix`: Para pagamentos biométricos usando a rede PIX.
          example: open_finance_biometric_pix
        status:
          type: string
          enum:
            - PENDING
            - SUCCEEDED
            - CANCELED
            - FAILED
          description: |-
            O status do registro do dispositivo. Pode ser:

            - `PENDING`: O registro está pendente.
            - `SUCCEEDED`: O registro foi bem-sucedido.
            - `CANCELED`: O registro foi cancelado.
            - `FAILED`: O registro falhou.
          example: PENDING
        details:
          type: object
          description: Detalhes sobre a inscrição
          properties:
            status:
              type: string
              enum:
                - AWAITING_ACCOUNT_HOLDER_VALIDATION
                - AWAITING_ENROLLMENT
                - AUTHORIZED
                - REJECTED
                - REVOKED
              description: |-
                O status do cadastro do Biometric Pix. Pode ser:

                  - `AWAITING_ACCOUNT_HOLDER_VALIDATION`: O titular da conta precisa validar o cadastro enviando seus dados biométricos.
                  - `AWAITING_ENROLLMENT`: As informações de cadastro foram enviadas para a instituição e estão sendo avaliadas.
                  - `AUTHORIZED`: O cadastro foi autorizado.
                  - `REJECTED`: A instituição rejeitou o cadastro.
                  - `REVOKED`: O usuário ou a instituição revogou o cadastro.
              example: AWAITING_ACCOUNT_HOLDER_VALIDATION
            customer:
              type: string
              format: uuid
              description: ID único da Belvo para referenciar o cliente.
              example: c860809f-e96d-4d50-9588-f40ffab77302
            institution:
              type: string
              format: uuid
              description: >-
                ID único da Belvo para referenciar a instituição na qual o
                dispositivo está registrado.
              example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
            platform:
              type: string
              enum:
                - ANDROID
                - BROWSER
                - CROSS_PLATFORM
                - IOS
              description: |-
                A plataforma do dispositivo a ser registrado. Pode 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: Um nome interno para este registro de dispositivo.
              example: 600f1b4a-Mobile
            callback_url:
              type: string
              format: uri
              description: >-
                A URL para redirecionar seu usuário após a conclusão do processo
                de inscrição.
              example: https://example.com/enrollment-in-progress
            redirect_url:
              type: string
              format: uri
              description: >-
                A URL para redirecionar o usuário para concluir sua inscrição na
                instituição.
              example: https://www.acmecorp.com/checkout/3487321
            risk_signals:
              type: string
              description: >-
                Uma string ofuscada (`******`) usada para indicar que sinais de
                risco foram fornecidos.
              example: '******'
        metadata:
          type: object
          description: >-
            Objeto opcional e personalizável onde você pode fornecer quaisquer
            pares de chave-valor adicionais para seus propósitos internos. Por
            exemplo, um número de referência interno para a inscrição.


            ⚠️ **Nota**: Você pode fornecer até 50 chaves (as chaves podem ter
            até 50 caracteres cada e cada valor pode ter até 500 caracteres).
            Não suportamos objetos aninhados, apenas valores ASCII.
          example:
            internal_reference_id: GGq73487w2
    CustomerIdPaymentWidget:
      title: ID do Cliente Belvo
      type: string
      format: uuid
      description: ID único da Belvo para referenciar o cliente.
      example: c860809f-e96d-4d50-9588-f40ffab77302
    CustomerPaymentWidget:
      title: CPF do Cliente
      type: object
      required:
        - identifier
      properties:
        identifier:
          type: string
          minLength: 11
          maxLength: 11
          description: O número de CPF do cliente.
          example: '10187609363'
        name:
          type: string
          minLength: 5
          maxLength: 200
          description: >-
            O nome completo do cliente para o qual você deseja criar ou listar
            inscrições.
          example: Gustavo Veloso
        external_id:
          $ref: '#/components/schemas/external_id__payments'
    EnrollmentBiometricPaymentWidget:
      type: object
      description: >-
        O objeto `enrollment` contém informações chave que são necessárias para
        inscrever o dispositivo do usuário na instituição deles ou para listar
        as inscrições associadas ao usuário.
      required:
        - type
        - details
        - metadata
      properties:
        type:
          type: string
          enum:
            - open_finance_biometric_pix
          description: |-
            O tipo de inscrição. Para o OFPI do 🇧🇷 Brasil, pode ser:

              - `open_finance_biometric_pix`: Para pagamentos biométricos usando a rede PIX.
          example: open_finance_biometric_pix
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        details:
          type: object
          required:
            - customer
            - platform
          description: Os detalhes da inscrição a ser criada.
          properties:
            name:
              type: string
              maxLength: 140
              description: Um nome legível para humanos para o registro do dispositivo.
              example: 600f1b4a-Mobile
            customer:
              description: >-
                O cliente para o qual você deseja criar ou listar inscrições.
                Você pode fornecer o ID Belvo ou o CPF do cliente.


                > 📘 Novos clientes

                >

                > Se você fornecer um CPF para um usuário que não existe no
                Belvo, criaremos um novo cliente com o CPF fornecido.
              oneOf:
                - $ref: '#/components/schemas/CustomerIdPaymentWidget'
                - $ref: '#/components/schemas/CustomerPaymentWidget'
            institution:
              type: string
              format: uuid
              description: >-
                **Opcional**: ID exclusivo da Belvo para referenciar a
                instituição do pagador.


                Se você fornecer o ID da instituição, o widget pulará a etapa de
                seleção da instituição.
              example: 600f1b4a-1ef9-4f89-b341-1a35f0c32cc0
        metadata:
          type: object
          description: >-
            Objeto opcional e personalizável onde você pode fornecer quaisquer
            pares de chave-valor adicionais para seus propósitos internos. Por
            exemplo, um número de referência interno.


            ⚠️ **Nota**: Você pode fornecer até 50 chaves (as chaves podem ter
            até 50 caracteres cada e cada valor pode ter até 500 caracteres).
            Não oferecemos suporte a objetos aninhados, apenas valores ASCII.
          example:
            internal_reference_id: GGq73487w2
    IndividualRequestBiometricPix:
      type: object
      title: INDIVIDUAL
      description: Detalhes sobre o método de pagamento Biometric Pix.
      required:
        - open_finance_biometric_pix
      properties:
        open_finance_biometric_pix:
          type: object
          description: >-
            Detalhes sobre o método de pagamento Biometric Pix para clientes
            individuais.
          required:
            - beneficiary_bank_account
          properties:
            beneficiary_bank_account:
              type: string
              format: uuid
              description: >-
                ID único da Belvo usado para identificar a conta bancária do
                beneficiário.
              example: a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc
            enrollment:
              type: string
              format: uuid
              description: >-
                O `enrollment.id` para a intenção de pagamento.


                > 📘 Nota

                >

                > Se você passar o `enrollment.id` na solicitação, o widget
                pulará a tela "Listar inscrições" e solicitará automaticamente a
                digitalização biométrica do usuário.
              example: 7dc245e3-5f75-4534-bafa-431fc0893593
    PaymentIntentBiometricWidget:
      type: object
      title: Intenção de Pagamento para Pix Biométrico
      description: Criar um Pagamento Pix Biométrico para o Brasil (OFPI).
      required:
        - amount
        - description
        - allowed_payment_method_types
        - selected_payment_method_type
        - payment_method_details
        - metadata
      properties:
        amount:
          type: string
          title: cadeia de caracteres
          pattern: \d+(?:\.\d{1,2})?
          example: '1234.12'
          description: >-
            Valor a ser pago pelo seu cliente. Para OFPI, você pode enviar
            números com até duas casas decimais, separados por um ponto `.`. Por
            exemplo: `1234.12`
        external_id:
          $ref: '#/components/schemas/external_id__payments'
        description:
          type: string
          description: Uma descrição legível por humanos do pagamento.
          example: Shoe payment
        statement_description:
          type: string
          maxLength: 50
          description: >-
            Uma descrição que aparecerá no extrato bancário do cliente
            (recomendado).


            > **Nota**: Se você não usar o parâmetro `statement_description`, o
            valor de `description` será utilizado como a descrição no extrato.
          example: Super Shoe Store - Brown Sneakers
        allowed_payment_method_types:
          type: array
          description: >-
            Uma lista de tipos de métodos de pagamento permitidos nesta intenção
            de pagamento. Para OFPI do 🇧🇷 Brasil, pode ser:

              - `open_finance`: Para pagamentos regulares.
              - `open_finance_biometric_pix`: Para pagamentos biométricos usando a rede PIX.
          minItems: 1
          maxItems: 1
          items:
            type: string
            enum:
              - open_finance_biometric_pix
            description: >-
              Tipo de método de pagamento selecionado. Para pagamentos com
              Biometric Pix no Brasil, isso deve ser definido como
              `open_finance_biometric_pix`.
            example: open_finance_biometric_pix
        payment_method_details:
          description: Detalhes sobre o método de pagamento Biometric Pix.
          oneOf:
            - $ref: '#/components/schemas/IndividualRequestBiometricPix'
        metadata:
          type: object
          description: >-
            Objeto opcional e personalizável onde você pode fornecer quaisquer
            pares de chave-valor adicionais para seus propósitos internos. Por
            exemplo, um número de referência interno.


            ⚠️ **Nota**: Você pode fornecer até 50 chaves (as chaves podem ter
            até 50 caracteres cada e cada valor pode ter até 500 caracteres).
            Não oferecemos suporte a objetos aninhados, apenas valores ASCII.
          example:
            internal_reference_id: GGq73487w2
    CallbackUrlsBiometricPaymentWidget:
      type: object
      description: >-
        No objeto `callback_urls`, você **deve** adicionar links para onde seu
        usuário deve ser redirecionado nos seguintes casos:


        - success (seu usuário completou com sucesso o processo de inscrição ou
        pagamento)

        - exit (seu usuário saiu do widget antes de completar o processo de
        inscrição ou pagamento)
      required:
        - success
        - exit
      properties:
        success:
          type: string
          description: >-
            A URL para a qual o usuário é redirecionado quando conclui com
            sucesso a inscrição ou o pagamento.
          example: your_deeplink_here://success
        exit:
          type: string
          description: >-
            A URL para a qual o usuário é redirecionado quando sai do processo
            antes de concluir a inscrição ou pagamento.
          example: your_deeplink_here://exit
    BrandingBiometricWidget:
      type: object
      description: Adicione elementos de marca personalizados ao widget Biometric Pix.
      required:
        - company_name
      properties:
        color_scheme:
          type: string
          enum:
            - LIGHT
            - DARK
          description: >-
            O esquema de cores do widget. Você pode escolher entre `LIGHT` e
            `DARK`. Por padrão, o widget usa o esquema de cores `LIGHT`.


            > 📘 Personalizando o esquema de cores

            >

            > Se você quiser personalizar ainda mais as cores para esses modos,
            consulte o parâmetro `theme`.
          default: LIGHT
          example: LIGHT
        company_name:
          type: string
          description: O nome da empresa que será exibido no widget.
          example: Acme Inc.
    ThemeBiometricWidget:
      type: object
      description: >-
        Use o array `theme` para adicionar mais personalização ao seu esquema de
        cores escolhido. Para detalhes sobre todas as possíveis personalizações,
        consulte nosso guia dedicado 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: Nome da variável CSS do widget.
          example: '--color-primary-base'
        value:
          type: string
          description: O código HEX para o `css_key`.
          example: '#907AD6'
    BiometricPaymentWidgetRequest:
      type: object
      title: Widget de Pagamento (Pix Biométrico) Access Token
      required:
        - use_case
        - widget
      properties:
        use_cases:
          type: array
          minItems: 1
          maxItems: 2
          description: >-
            O caso de uso do widget Biometric Pix. Você pode escolher:

              - `ENROLLMENT`: Use esta opção se você deseja cadastrar o dispositivo do usuário no serviço Biometric Pix.
              - `PAYMENT_INTENT`: Use esta opção se você deseja criar um pagamento para uma transação Biometric Pix.

            > 📘 Usando o widget para ambos os casos de uso: cadastro e
            pagamentos.

            >

            > Se você passar ambos os casos de uso `ENROLLMENT` e
            `PAYMENT_INTENT`, o widget primeiro irá cadastrar o usuário e, em
            seguida, criar uma intenção de pagamento.
          items:
            type: string
            enum:
              - ENROLLMENT
              - PAYMENT_INTENT
          example:
            - ENROLLMENT
            - PAYMENT_INTENT
        widget:
          type: object
          required:
            - callback_urls
            - branding
          description: >-
            O objeto `widget` contém informações adicionais sobre como
            configurar o widget, incluindo detalhes de inscrição\*, informações
            de pagamento\* e URLs de callback.


            > 📘 Objetos condicionalmente obrigatórios

            >

            > Os objetos `enrollment` e `payment_intent` são obrigatórios de
            forma condicional, com base nos `use_cases` que você fornecer. Para
            simplificar sua integração, recomendamos que você sempre passe ambos
            os casos de uso (`ENROLLMENT` e `PAYMENT_INTENT`), e então forneça
            tanto os objetos `enrollment` quanto `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'
            theme:
              type: array
              description: >-
                Use o array `theme` para adicionar mais personalização ao seu
                esquema de cores escolhido. Para detalhes sobre todas as
                possíveis personalizações, consulte nosso guia dedicado 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: Não 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: Acesso à API Belvo negado
      content:
        application/json:
          schema:
            type: array
            description: >-
              Esse erro ocorre quando você tenta acessar o recurso da Belvo sem
              as permissões corretas.
            items:
              $ref: '#/components/schemas/AccessToResourceDenied'
    404_not_found_error:
      description: Erro Não Encontrado
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/404NotFoundError'
    408_request_timeout_error:
      description: Tempo de Solicitação Esgotado
      content:
        application/json:
          schema:
            type: array
            title: Tempo de Solicitação Esgotado
            description: >-
              A Belvo tem um limite em relação ao tempo necessário para fazer
              login, recuperar dados da conta e fazer logout. Um timeout ocorre
              quando há uma quantidade muito grande de dados e não foi possível
              obter tudo dentro do tempo estipulado.
            items:
              $ref: '#/components/schemas/RequestTimeoutError'
    500_unexpected_error:
      description: Erro Inesperado
      content:
        application/json:
          schema:
            type: array
            title: Erro Inesperado
            description: >-
              Esse erro ocorre quando nós (Belvo) encontramos um erro interno do
              sistema (desculpe por isso) ou devido a uma resposta não suportada
              da instituição.
            items:
              $ref: '#/components/schemas/UnexpectedError'
    400_bad_request_error:
      description: Erro de solicitação inválida
      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: Token MFA Necessário
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/TokenRequiredResponse'
    202_accepted_response:
      description: Solicitação Aceita (quando `X-Belvo-Request-Mode` é `async`)
      content:
        application/json:
          schema:
            type: object
            properties:
              request_id:
                type: string
                description: >-
                  O ID único para esta solicitação. Recomendamos que você
                  armazene este valor para identificar posteriormente qual
                  evento de webhook está relacionado a uma solicitação
                  assíncrona.
                example: b5d0106ac9cc43d5b36199fe831f6bbe
    401_payments_unauthorized_error:
      description: Erro de Autenticação
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/401UnauthorizedError'
  examples:
    AccountsOfdaChecking:
      summary: Verificando OFDA Brazil
      description: Exemplo de uma conta corrente (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: Cartão de Crédito OFDA Brasil
      description: Exemplo de uma conta de cartão 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: Empréstimo OFDA Brasil
      description: Exemplo de uma conta de empréstimo (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: Verificando OFDA Brazil
      description: Exemplo de uma conta corrente (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: Cartão de Crédito OFDA Brasil
      description: Exemplo de uma conta de cartão 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: Empréstimo OFDA Brasil
      description: Exemplo de uma conta de empréstimo (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: Exemplo de um indivíduo (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: Negócios OFDA Brasil
      description: Exemplo de um negócio (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: Exemplo de um indivíduo (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: Negócios OFDA Brasil
      description: Exemplo de um negócio (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: Exemplo de um indivíduo (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: Negócios OFDA Brasil
      description: Exemplo de um negócio (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: Exemplo IMSS
      description: Exemplo de uma resposta paginada do 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: Exemplo ISSSTE
      description: Exemplo de uma resposta paginada do 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: Exemplo IMSS
      description: Exemplo de uma resposta 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: Exemplo ISSSTE
      description: Exemplo de uma resposta do 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: Exemplo IMSS
      description: Exemplo de uma resposta 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: Exemplo ISSSTE
      description: Exemplo de uma resposta do 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: Fatura Ingreso
      description: Exemplo de uma fatura do tipo *Igreso*.
      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: Serviços de mensageria.
                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: Fatura Pago
      description: Exemplo de uma fatura do 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: Paid
                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: Fatura Nomina
      description: Exemplo de uma fatura do 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: Pagamento de folha de pagamento
                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: Fatura Egreso
      description: Exemplo de uma nota fiscal do 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: Reembolso do serviço
                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: Fatura de Traslado
      description: Exemplo de uma nota fiscal do 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: FRETE
                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: Fatura Ingreso
      description: Exemplo de uma fatura do tipo *Igreso*.
      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: Serviços de mensageria.
              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: Fatura Pago
      description: Exemplo de uma fatura do 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: Paid
              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: Fatura Nomina
      description: Exemplo de uma fatura do 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: Pagamento de folha de pagamento
              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: Fatura Egreso
      description: Exemplo de uma nota fiscal do 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: Reembolso do serviço
              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: Fatura de Traslado
      description: Exemplo de uma nota fiscal do 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: FRETE
              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: Fatura Ingreso
      description: Exemplo de uma fatura do tipo *Igreso*.
      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: Serviços de mensageria.
            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: Fatura Pago
      description: Exemplo de uma fatura do 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: Paid
            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: Fatura Nomina
      description: Exemplo de uma fatura do 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: Pagamento de folha de pagamento
            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: Fatura Egreso
      description: Exemplo de uma nota fiscal do 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: Reembolso do serviço
            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: Fatura de Traslado
      description: Exemplo de uma nota fiscal do 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: FRETE
            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: Declaração de Imposto de Renda Pessoa Física
      description: Exemplo de uma lista de declarações de imposto de renda pessoal
      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: Declaração de Imposto de Renda Pessoal Mensal (PFAe)
      description: >-
        Exemplo de uma lista de declarações de imposto pessoal mensais do 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: Declaração de Imposto de Renda Pessoal Mensal (PFAI)
      description: >-
        Exemplo de uma lista de declarações de imposto de renda pessoal mensais
        do 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: Declaração de Imposto de Renda Empresarial
      description: Exemplo de uma lista de declarações de impostos empresariais
      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: Declaração de Imposto de Renda Empresarial Mensal
      description: Exemplo de uma lista de declarações fiscais mensais de empresas
      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 Pessoal
      description: Exemplo de uma lista de declarações de imposto de renda pessoal
      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: Mensalidade Pessoal (PFAE)
      description: Exemplo de declaração de imposto pessoal mensal do 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: Mensal Pessoal (PFAI)
      description: >-
        Exemplo de uma declaração de imposto de renda pessoal mensal do 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: Ano Comercial
      description: Exemplo de uma lista de declarações de impostos empresariais
      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: Business Monthly
      description: Exemplo de uma declaração de imposto empresarial mensal
      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: Declaração de Imposto de Renda Pessoa Física
      description: Exemplo de uma lista de declarações de imposto de renda pessoal
      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: Declaração de Imposto de Renda Mensal Pessoal (PFAE)
      description: Exemplo de declaração de imposto pessoal mensal do 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: Declaração de Imposto de Renda Pessoal Mensal (PFAI)
      description: >-
        Exemplo de uma declaração de imposto de renda pessoal mensal do 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: Declaração de Imposto de Renda Empresarial
      description: Exemplo de uma lista de declarações de impostos empresariais
      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: Declaração de Imposto de Renda Empresarial Mensal
      description: Exemplo de uma declaração de imposto empresarial mensal
      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: Status Fiscal Pessoal
      description: Exemplo de uma lista de status fiscal pessoal
      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: Status Fiscal da Empresa
      description: Exemplo de uma lista de status fiscal empresarial
      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: Status Fiscal Pessoal
      description: Exemplo de uma lista de status fiscal pessoal
      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: Status Fiscal da Empresa
      description: Exemplo de uma lista de status fiscal empresarial
      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 faturas
      description: Exemplo de uma lista de todas as faturas possíveis.
      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: Fatura de Compra
      description: Exemplo de uma fatura 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: Detalhes do Resumo da Fatura
      description: Exemplo de um tipo de fatura *Resumo dos Detalhes da Fatura*.
      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: Nota Fiscal de Venda
      description: Exemplo de uma fatura de venda.
      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: Fatura de Compra
      description: Exemplo de uma fatura 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: Detalhes do Resumo da Fatura
      description: Exemplo de um tipo de fatura *Resumo dos Detalhes da Fatura*.
      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: Nota Fiscal de Venda
      description: Exemplo de uma fatura de venda.
      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: OFPI Individual
      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: Negócios 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: OFPI Individual
      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: Negócios 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: Conta bancária 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: Conta bancária 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: Conta bancária 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: Conta bancária 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: Conta bancária 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: Conta bancária 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
  - 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
