> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerenciando instituições

> Cadastre no módulo Reporter do Lerian Console as instituições pelas quais seu tenant declara: CNPJ, escopo de dados por Fonte de Dados e propostas lidas do Midaz.

Uma **instituição** é um declarante regulatório do seu tenant. Cada instituição declara com o próprio CNPJ e lê apenas as linhas que o escopo dela indica. Gerencie as instituições na página **Instituições** do Reporter no [Lerian Console](/pt/platform/console/about-lerian-console).

Os relatórios, os prazos regulatórios e os envios regulatórios usam as instituições que você cadastra aqui. Veja [Onde as instituições se aplicam](#where-institutions-apply).

## Acessando a página Instituições

***

Para abrir a página **Instituições**, clique em **Instituições** no menu à esquerda da página do **Reporter**.

A página lista as instituições em uma tabela com estas colunas: **Nome**, **CNPJ**, **Fontes de Dados**, **Última Modificação** e **Ações**. A coluna **Fontes de Dados** indica cada Fonte de Dados no escopo da instituição. Ela mostra **Nenhuma** quando o escopo está vazio.

O menu (<Icon icon="ellipsis-vertical" />) de cada linha tem **Editar** e **Excluir**.

Cada ação na tela Instituições precisa da permissão `institutions` correspondente: `get` para ver e propor instituições, `post` para criar e confirmar, `put` para editar e `delete` para excluir.

## Adicionar uma instituição

***

<Steps>
  <Step title="Abrir o formulário">
    Na página **Instituições**, clique em **Nova instituição**.
  </Step>

  <Step title="Identificar a instituição">
    Informe a **Razão social** e o **CNPJ**. O CNPJ pode ser numérico ou alfanumérico, com ou sem pontuação.
  </Step>

  <Step title="Definir o escopo">
    Clique em **Adicionar fonte de dados** e selecione uma Fonte de Dados. Depois indique ao Reporter quais linhas dela pertencem à instituição. Veja [Regras de escopo](#scope-rules).
  </Step>

  <Step title="Salvar">
    Clique em **Salvar**. Se o Reporter recusar a instituição, o formulário mostra o motivo e mantém o que você digitou.
  </Step>
</Steps>

<h3 id="scope-rules">
  Regras de escopo
</h3>

O escopo indica as linhas de cada Fonte de Dados que pertencem à instituição. Uma instituição sem nenhuma Fonte de Dados no escopo não lê nada.

Para cada Fonte de Dados, escolha uma destas opções:

* **A fonte de dados inteira pertence a esta instituição**: a instituição lê todas as tabelas da Fonte de Dados.
* **Tabelas**: clique em **Adicionar tabela** e informe o nome da tabela. Para cada tabela, escolha uma destas opções:
  * **Compartilhada: todas as instituições leem esta tabela inteira**: use-a para dados de referência de que todas as instituições precisam.
  * **Condições**: clique em **Adicionar condição**, digite o **Campo**, selecione um **Operador** e digite os **Valores**, separados por vírgula. Uma tabela com condições precisa de pelo menos uma condição com o operador **Igual** ou **Em**. Esses dois operadores atribuem as linhas à instituição.

### Guia de campos

| Campo | O que informar | Exemplo |
| - | - | - |
| **Razão social** | Obrigatório. O nome do declarante, com até 255 caracteres. | `Banco Exemplo S.A.` |
| **CNPJ** | Obrigatório. O formulário verifica os dígitos verificadores. | `12.345.678/0001-95` |
| **Fonte de dados** | Uma Fonte de Dados cadastrada na página **Fontes de Dados**. Uma Fonte de Dados aparece uma vez em um escopo. | `midaz-postgres` |
| **Tabela** | Uma tabela da Fonte de Dados. Uma tabela aparece uma vez em uma Fonte de Dados. | `account` |
| **Campo** | A coluna que identifica as linhas da instituição. | `organization_id` |
| **Operador** | **Igual**, **Em**, **Não em**, **Maior que**, **Maior ou igual**, **Menor que**, **Menor ou igual** ou **Entre**. | **Igual** |
| **Valores** | Um ou mais valores, separados por vírgula. | `00000000-0000-0000-0000-000000000000` |

## Propor instituições a partir do Midaz

***

O Reporter pode ler a tabela de organizações do Midaz e propor uma instituição para cada organização que ainda não está cadastrada.

<Steps>
  <Step title="Abrir o painel de propostas">
    Na página **Instituições**, clique em **Propor a partir do Midaz**.
  </Step>

  <Step title="Selecionar as Fontes de Dados">
    Em **Fontes de dados a ler**, selecione as Fontes de Dados PostgreSQL que leem o Midaz. O painel lista as Fontes de Dados PostgreSQL que você cadastrou. Ele não lista Fontes de Dados fornecidas pela plataforma.
  </Step>

  <Step title="Buscar as propostas">
    Clique em **Buscar propostas**. Cada proposta mostra o nome, o CNPJ e o escopo proposto em cada Fonte de Dados.
  </Step>

  <Step title="Confirmar uma proposta">
    Clique em **Confirmar** em uma proposta. O formulário **Nova instituição** abre com a proposta preenchida. Revise o formulário e depois clique em **Salvar**. Quando você fecha o formulário, o painel de propostas abre de novo.
  </Step>
</Steps>

<Warning>
  O Midaz não verifica os dígitos verificadores do CNPJ. Uma proposta com um CNPJ incorreto mostra um aviso. Corrija o CNPJ no formulário antes de salvar.
</Warning>

## Editar uma instituição

***

Clique no nome da instituição ou selecione **Editar** no menu da linha. Altere os campos e depois clique em **Salvar**.

## Excluir uma instituição

***

Selecione **Excluir** no menu da linha e confirme. Depois da exclusão, você pode cadastrar o mesmo CNPJ de novo na mesma hora.

<h2 id="where-institutions-apply">
  Onde as instituições se aplicam
</h2>

***

| Onde | O que o Console pede |
| - | - |
| **Relatórios** > **Novo Relatório** | Com uma instituição, o assistente usa essa instituição. Com várias, escolha uma instituição ou **Todas as instituições**. Sem nenhuma, o assistente não pergunta. |
| **Visão Geral** > **Adicionar Lembrete**, tipo **Regulatório** | A mesma regra de um relatório. |
| **Envio Regulatório** > **Ativar documento** | Com uma instituição, o diálogo usa essa instituição. Com várias, escolha a instituição que entrega o documento. Um envio nunca oferece **Todas as instituições**. Cadastre pelo menos uma instituição antes de ativar um documento. |

Quando o tenant tem várias instituições, o **Envio Regulatório** também mostra estes itens:

* Cada inscrição mostra a instituição pela qual ela entrega, ou **Nenhuma instituição definida**. Defina a instituição antes de gerar um rascunho.
* **Ativar para outra instituição** aparece em um documento ativado quando uma instituição ainda não o entrega.
* **Definir instituição** no menu de uma inscrição muda a instituição dos próximos envios. Os relatórios já gerados mantêm a instituição deles.

Para se inscrever em um documento e gerar, corrigir ou adotar os envios dele, é preciso ter `regulatory:post`. Para mapear os campos dele e definir a instituição dele, é preciso ter `regulatory:put`. Para desativar uma inscrição, é preciso ter `regulatory:delete`. Para aprovar um rascunho, é preciso ter `regulatory-approval:post`.

## Próximos passos

***

* Use [Gerar um Relatório](/pt/products/reporter/console/generating-a-report) para gerar um Relatório para uma instituição.
* Use [Gerenciando Fontes de Dados](/pt/products/reporter/console/managing-data-sources) para cadastrar as Fontes de Dados que um escopo indica.

<Card title="Equivalente na API" type="tip" horizontal>
  [Endpoint de criação de instituição](/pt/reference/products/reporter/create-institution) e [Endpoint de proposta de instituições](/pt/reference/products/reporter/propose-institutions)
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.