# Empresa
# Versão 1
# DESCRIÇÃO
A documentação da aplicação Empresa tem como objetivo fornecer instruções detalhadas para que o usuário possa realizar operações de visualização, cadastro – preenchimento dos campos, edição e exclusão de empresas no sistema.
# FINALIDADE
Nesta funcionalidade devemos realizar as seguintes ações:
Visualização: Consulte os detalhes das empresas cadastradas.
Cadastro: Adicione novas empresas ao sistema.
Edição: Modifique as informações das empresas existentes conforme necessário.
Exclusão: Remova empresas da lista cadastrada.
Abaixo podemos acompanhar o caminho de acesso e o fluxo de cada validação feita pelo sistema ou definição feita pelo usuário.
# PRINCIPAIS CAMINHOS
Login ou acesso ao sistema > Página Inicial > Workspace Enterprise > Dashboard > Segmentação lógica > Empresa.
# FUNCIONALIDADES
Ao acessar o item "Empresa" no menu do workspace de Enterprise, você visualizará a tela de Empresa, que apresenta as seguintes estruturas e ações:
# Lista de Empresas
# Sem Resultados
Caso nenhuma empresa seja encontrada, o sistema exibirá a mensagem: "Nenhuma empresa disponível para exibição." Isso indica que não há empresas cadastradas. Para iniciar o processo, clique no botão "Novo" para acessar a tela de cadastro de empresa.
# Com Resultados
Ao clicar em "Empresa", será exibida a tela com a lista de empresas cadastradas, apresentando os seguintes dados de visualização: código, sigla, nome da empresa, CNPJ, situação, meios de pagamento, data/hora inclusão, usuário inclusão, data/hora alteração e usuário alteração. 
# Visualizar os Meios de Pagamento
Na lista de empresas, na linha correspondente à empresa desejada, localize a coluna Meios de Pagamento e clique em "Visualizar".
Será aberta uma janela contendo as informações dos meios de pagamento cadastrados, divididos em:
Depósito Bancário: Exibindo os campos de Código do Banco, Nome do Banco, Agência e Conta.
Chaves Pix: Incluindo chaves de CNPJ, Telefone e Email

Após visualizar os dados necessários, clique em "Fechar" para retornar à lista de empresas.
Essas informações permitem consultar os métodos de pagamento registrados para cada empresa.
# Filtro
Para localizar uma empresa específica, clique no botão "Adicionar Filtro" na tabela. Isso abrirá uma janela com as opções de filtros disponíveis, permitindo que você refine a busca de acordo com os critérios desejados.

Após a abertura da janela, selecione os filtros desejados. Os resultados serão atualizados na lista conforme os filtros aplicados.

# Novo – Cadastro de Empresa
- Ao clicar no botão “Novo” na tela de "Lista de Empresas", será exibida uma janela de formulário de cadastro para adicionar uma nova Empresa ao sistema.
Este formulário é composto pela seguinte estrutura e campos:
# Dados da Empresa
Código: Preencha o código da empresa. O limite máximo de caracteres de 0 – 10.
Sigla: Preencha a sigla da empresa. O limite máximo de caracteres de 0 – 10.
Nome da Empresa: Preencha o nome da empresa a cadastrar. O limite máximo de caracteres de 0 – 255.
CNPJ: Preencha o CNPJ da empresa. O limite máximo de caracteres de 0 – 19 e aceita apenas números.
Cadastro ativo: permite que você defina se a situação do cadastro da empresa está ativo no sistema. Para alterar o status, selecione a opção desejada (SIM ou NÃO).
# SIM: Indica que o cadastro está ativo e pode ser utilizado normalmente.
# NÃO: Indica que o cadastro está inativo.
# Meios de Pagamento
Depósito
Código do Banco: Preencha o código do banco. O limite máximo de caracteres de 0 – 15.
Nome do Banco: Preencha o nome da instituição bancária que deseja cadastrar. O limite máximo de caracteres de 0 – 70.
Agência: Preencha o número da agência bancária. O limite máximo de caracteres de 0 – 15.
Conta: Preencha o número da conta bancária. O limite máximo de caracteres de 0 – 50.
Chaves Pix
Para cadastrar chaves Pix, você pode optar por incluir uma ou mais das seguintes chaves:
CNPJ: Preencha o número de CNPJ como chave pix.
Telefone: Preencha o telefone como chave pix.
Email: Preencha o endereço de email como chave pix.
Cada tipo de chave Pix deve ser preenchido conforme seu formato específico para garantir que as transações sejam processadas corretamente.
Caso algum campo obrigatório não seja preenchido no momento de salvar os dados do cadastro, será exibido um aviso de "Erros de Validação" com a lista das obrigatoriedades não atendidas nos campos correspondentes.
Se o CNPJ e o código digitado já estiverem cadastrado no sistema, será exibido “Erro de validação no campo” dado já existente. Verifique o número informado e, caso necessário, corrija-o antes de tentar novamente, visto que é um número de identificador único para cada empresa.
Após preencher todos os campos, clique no botão “Salvar”. Em seguida, o sistema exibirá uma caixa de diálogo de confirmação do cadastro com as opções "Cancelar" e "Confirmar".

Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhum cadastro será efetuado.
Confirmar: Se optar por "Confirmar", o sistema concluirá o cadastro.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro realizado com sucesso!".

- Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de empresa já com a empresa cadastrada na lista.
# Ações - Empresa
# Editar
Selecione a Empresa na tabela: Basta marcar a caixa de seleção disponível na tabela;
Acesse as Ações: Clique no botão "Ações".
Escolha Editar: Selecione a opção "Editar" na lista de valores exibida após clicar em ações.

- Empresa: Após clicar em editar será exibida a tela de formulário do cadastro em modo edição contendo as opções “Cancelar” e “Salvar”. Nesta tela, os dados da Empresa selecionada já estarão preenchidos, permitindo que você altere as informações conforme necessárias.

- Ao inserir novas alterações, clique em "Salvar" para efetivar as mudanças. Em seguida, o sistema exibirá uma caixa de diálogo de confirmação do cadastro com as opções "Cancelar" e "Confirmar".

Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhuma alteração será efetuada.
Confirmar: Se optar por "Confirmar", o sistema concluirá a alteração cadastral.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro realizado com sucesso!".
Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de empresa, já com a empresa editada na lista.
# Excluir
Selecione a Empresa na tabela: Basta marcar a caixa de seleção disponível na tabela;
Acesse as Ações: Clique no botão "Ações".
Escolha Excluir: Selecione a opção "Excluir" na lista de valores exibida após clicar em ações.
Caixa de dialógo: Uma caixa de diálogo será exibida para confirmar a exclusão, informando que os dados não poderão ser recuperados após a exclusão. A caixa de diálogo conterá as opções "Cancelar" e "Confirmar".

Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhuma exclusão será efetuada.
Confirmar: Se optar por "Confirmar", o sistema concluirá a exclusão da Empresa do sistema.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro excluído com sucesso!".

- Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de empresa, já com a empresa excluída da lista.

# ESPECIFICIDADES
Descreva os itens abaixo referente as validações.
| FUNÇÃO | PARÂMETROS | STATUS/COMPORTAMENTO |
|---|---|---|
# PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES
Botão Novo: Botão de ação para incluir uma nova empresa no sistema.

Botão Ações: Botão de ação que permite a edição e exclusão da empresa selecionada.

Adicionar Filtro: Localizado na tabela, o botão "Adicionar Filtro" permite inserir critérios específicos para refinar a busca na tabela de lista de empresas. Ao ser clicado, ele abre uma janela com opções de filtros disponíveis.

Caixa de Seleção: Ao marcar a caixa de seleção na tabela, o usuário ativa o botão de ações, permitindo a execução de operações relacionadas à linha selecionada.

Navegação Tabela: Localizado no rodapé da tabela, o usuário pode selecionar o número de linhas a serem exibidas por página e navegar entre as páginas.

Botão Fechar: Ao clicar no botão 'Fechar', o usuário será redirecionado para a tela/caminho anterior.
# REQUISITOS DE USUÁRIOS
Principais ações que poderão ser executadas na tela de Empresa do sistema SOMUS.
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Enterprise | Poderá incluir uma nova empresa no sistema |
| Poderá visualizar as empresas já cadastradas | |
| Poderá aplicar filtros específicos e refinar a lista de empresas exibida. | |
| Poderá editar empresas já cadastradas | |
| Poderá excluir empresas da lista | |
| Poderá ativar ou inativar o cadastro. | |
| Poderá consultar os meios de pagamento cadastrados para empresa. | |
| Poderá cadastrar meios de pagamento em formato de depósito ou chaves pix. |
# TECLAS DE ATALHO
# [Mapeamento das teclas de atalhos utilizados na funcionalidade]
| AÇÃO/FUNÇÃO | PORTUGÊS | INGLÊS | ESPANHOL |
|---|---|---|---|
# RELATÓRIO DE INCIDÊNCIAS
Seção destinada a resolução de problemas e erros que podem ocorrer e como pode ser solucionado.
| PROBLEMA | CAUSA | SOLUÇÃO |
|---|---|---|
# DOCUMENTOS RELACIONADOS
| TÍTULO | VERSÃO | LINK |
|---|---|---|
| Empresa | 1º | - |
# CONTATOS
Fale com a gente e tire suas dúvidas!
Email: <Variáveis parametrizáveis a serem definidas> Telefone: <Variáveis parametrizáveis a serem definidas> Área Responsável: <Variáveis parametrizáveis a serem definidas>