| Totvs custom tabs box items |
|---|
| default | yes |
|---|
| referencia | cad_usuario |
|---|
| ÍNDICE
01. VISÃO GERALEsse programa é responsável por efetuar o cadastro dos usuários, que irão utilizar o módulo do Calendário Fiscal, e somente os usuários cadastrados poderão ter acesso as funcionalidades do calendário. É possível apenas cadastrar os usuários que já existam no cadastro de usuários do ERP. 02. UTILIZAÇÃOO primeiro usuário cadastro receberá automaticamente privilégios de administrador, mesmo que não tenha solicitado a própria inclusão. Somente os usuários administradores e ativos poderão incluir, alterar ou excluir os usuários cadastrados. É permitida a inclusão de mais de um usuário por vez, podendo conceder ou retirar privilégios de administrador aos usuários, assim como inativa-los, retirando sua permissão de acesso ao calendário. Não é permitido remover o próprio usuário, apenas retirar o status de administrador, mas será necessário um outro administrador para concede-lo novamente. Deve sempre existir ao menos um usuário com status de administrador. Caso haja apenas um, não será possível remover ou retirar a permissão de administrador deste usuário até que exista outro administrador. Outras Ações / Ações relacionadas Ação | Descrição |
|---|
| Adicionar usuário | Adicionar usuários, que estão no cadastro de usuários do ERP, ao cadastro de usuários do Calendário Fiscal. | | Remover | Exclui usuários inseridos ao cadastro de usuários do Calendário Fiscal. | | Busca Avançada | Abre a tela para o preenchimento de campos adicionais para o refinamento da busca. Os parâmetros listados na tela da busca avançada são: - Usuário: é possível filtrar pelo usuário cadastrado;
- Ativo: é possível filtrar pelo Status com valor igual a "Sim" ou "Não";
- Administrador: é possível filtrar pela permissão de Administrador com valor igual a "Sim" ou "Não";
|
04. APIS UTILIZADAS
|
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | cad_alerta |
|---|
| ÍNDICE
01. VISÃO GERALEsse é um cadastro geral de alertas para que se possa configurar a forma de como os alertas irão se comportar, quando serão emitidos, com que frequência e de que forma os compromissos serão notificados para os usuários. 02. UTILIZAÇÃOSomente usuários administradores terão permissão para incluir ou editar as configurações de alerta geral. É obrigatório selecionado ao menos um Tipo de Alerta, caso contrário nenhuma notificação será enviada por e-mail. Outras Ações / Ações relacionadas Ação | Descrição |
|---|
| Adicionar Alerta | Esse botão será apresentado somente na primeira utilização do cadastro de alertas, ou seja, ao inserir o primeiro registro ele será trocado pelo botão Editar Alerta. |
|---|
| Editar Alerta | Efetua a edição de um alerta já incluído no cadastro. |
|---|
| Salvar | Salva o registro que se está Incluindo ou Editando no cadastro. |
|---|
| Cancelar | Cancela a operação que se está realizando. |
|---|
Principais Campos e Parâmetros
Campo | Descrição |
|---|
| Dias Antes do Prazo | Nesse campo é informado a quantidade de dias antes da data da entrega que o alerta começa a ser disparado. |
|---|
| Horário do Inicio do Alerta | Hora na qual os disparos de alertas dentro do dia começa a ser disparado. |
|---|
| Repetir a Cada X Horas | Intervalo de horas que são disparados os alertas dentro daquela dia. |
|---|
| Tipos de Alertas | A seleção de uma das opções apresentadas abaixo determina como o usuário receberá este alerta. |
|---|
| Servidor RPW | Serviço de agendamento que será responsável pelo disparo e controle dos alertas. |
|---|
05. API UTILIZADA |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | config_anexo |
|---|
| ÍNDICE
01. VISÃO GERALA configuração de anexos do calendário fiscal tem por objetivo centralizar a parametrização necessária para que os anexos das entregas dos compromissos sejam armazenados para posterior consulta pelos utilizadores do calendário fiscal. 02. UTILIZAÇÃO03. TELA html.fiscalCalendar - CONFIGURAÇÕES - ANEXOSPrincipais Campos e Parâmetros
Campo | Descrição |
|---|
| Diretório de rede | Informe o diretório de rede onde os anexos serão armazenados. O diretório deve estar na mesma rede que o Sistema e é necessário que ele tenha permissão de leitura e escrita para que os arquivos sejam salvos corretamente. |
|
| Totvs custom tabs box items |
|---|
| default | yesno |
|---|
| referencia | cad_compromissos |
|---|
| ÍNDICE
01. VISÃO GERALEssa tela, tem como objetivo principal, efetuar o cadastro dos compromissos de entrega das Obrigações Fiscais 02. UTILIZAÇÃOOs usuários administradores tem acesso aos compromissos cadastrados para todos os usuários, mas os usuários comuns terão acesso somente aos compromissos que forem de sua responsabilidade. O compromisso terá somente um responsável, caso seja necessário alertar mais de uma pessoa o compromisso deverá ser duplicado. 03. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - AÇÕESOutras Ações / Ações relacionadas Ação | Descrição |
|---|
| Novo Compromisso | Adiciona um novo compromisso ao calendário fiscal. |
|---|
| Importar | Efetua a importação de compromissos pré-formatados conforme modelo anexo a tela de importação. |
|---|
| Busca Avançada | Abre uma modal para o preenchimento de campos adicionais para o refinamento da busca. Os parâmetros listados na tela da busca avançada são: - Estabelecimento: é possível selecionar o estabelecimento na qual o compromisso está cadastrado;
- Responsável: é possível selecionar o usuário na qual o compromisso está cadastrado;
- Periodicidade: é possível definir a periodicidade que a obrigação fiscal deve ser entregue.
|
|---|
04. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - AÇÕES DA GRIDOutras Ações / Ações relacionadas Ação | Descrição |
|---|
| Editar Compromisso | Efetua a edição do registro escolhido, levando os dados para a tela de edição. |
|---|
| Copiar Compromisso | Efetua a cópia do registros com os mesmos dados, precisando somente informar um novo código para o cadastro. |
|---|
05. TELA html.fiscalCalendar - COMPROMISSOS - LISTAGEM - PARÂMETROSPrincipais Campos e Parâmetros
Campo | Descrição |
|---|
| Buscar | Efetua a busca de cadastros por meio da descrição do compromisso informado no campo. |
|---|
06. TELA html.fiscalCalendar - COMPROMISSOS - INCLUSÃO E EDIÇÃO DE COMPROMISSOSA inclusão e edição de compromissos são divididas em duas partes, representadas por duas abas na tela, Geral e Alerta. Primeiramente, são informados os dados do compromisso que serão apresentados no calendário. Em seguida, caso seja necessário, é possível parametrizar alertas exclusivamente para o compromisso selecionado. Se nenhum dado for informado nos alertas, o Sistema assumirá a frequência de alertas padrão cadastrada. Caso alguma informação seja editada nos compromissos, as alterações realizadas serão refletidas somente nas entregas cuja data seja posterior à data de alteração do compromisso. Caso não haja nenhuma entrega futura, as alterações serão refletidas na última entrega disponível. Principais Campos e Parâmetros - Aba Geral
Campo | Descrição |
|---|
| Código do Compromisso | Identificador único do compromisso. |
|---|
| Descrição | Descrição do compromisso que será apresentada no calendário. |
|---|
| Esfera | Determina a abrangência do compromisso. Pode ter os valores Federal, Estadual ou Municipal. |
|---|
| Estado | Caso a esfera do compromisso seja Estadual ou Municipal, é necessário selecionar a UF a qual ele pertence. |
|---|
| Município | Para os compromissos municipais, é necessário informar também o nome do município. O conteúdo do campo é automaticamente filtrado pela UF selecionada. |
|---|
| Data de Início de Vigência | Data de início de vigência do compromisso. Ela serve como data base para o cálculo das datas de entrega do compromisso de acordo com a periodicidade determinada. O indicado é que essa data seja preenchida com o primeiro dia do mês da primeira entrega do compromisso. |
|---|
| Data Final de Vigência | Data final da vigência do compromisso. Após essa data, não serão geradas novas entregas e o compromisso não será mais apresentado no calendário. O indicado é que essa data seja preenchida com o último dia do mês da última entrega do compromisso. |
|---|
| Periodicidade | Periodicidade do compromisso. Pode assumir os valores Quinzenal, Mensal, Semestral ou Anual. |
|---|
| Dia da Entrega | Dia da primeira entrega do compromisso no período. Para as frequências semanal e quinzenal as próximas datas dentro do período são calculadas automaticamente. Por exemplo, para compromissos que devem ser entregues mensalmente no dia 10, o valor a ser informado é 10. |
|---|
| Vencimento dia Não Útil | Caso a data de entrega do compromisso caia no final de semana, determina se a entrega deve ser antecipada ou postergada. |
|---|
| Anexar comprovante | Determina se, ao marcar um compromisso como entregue no calendário, será necessário anexar um comprovante de entrega para completar a ação. Pode ter os valores Obrigatório ou Opcional. |
|---|
| Responsável | Indica o responsável pela entrega do compromisso. Para poder ser responsável pela entrega, o usuário deve estar relacionado como usuário do calendário fiscal nas configurações. Só é permitido um responsável por compromisso. |
|---|
| Estabelecimentos | Seleciona os estabelecimentos relacionados ao compromisso, |
|---|
| Observações | Espaço para informações adicionais acerca do compromisso. |
|---|
Principais Campos e Parâmetros - Aba Alertas
Campo | Descrição |
|---|
| Utilizar alertas padrão do sistema | Este campo vem marcado por padrão. Ao desmarcar, os campos de cadastro de alerta são habilitados e se torna possível cadastrar um alerta exclusivo para o compromisso. |
|---|
| Emissão do alerta | Informa quantos dias antes da entrega do compromissos as notificações de alerta começarão a serem emitidas, a partir de que hora do dia e qual intervalo de horas que devem se repetir. |
|---|
| Tipo de Alerta | Informa por qual meio a notificação de alerta será enviada. Se nenhuma opção for selecionada, nenhum alerta será enviado. |
|---|
| Servidor de RPW | As notificações de alertas são enviadas a partir de execuções agendadas de acordo com os parâmetros no servidor RPW informado. |
|---|
07. TELA html.fiscalCalendar - COMPROMISSOS - IMPORTAR COMPROMISSOSPrincipais Campos e Parâmetros
Campo | Descrição |
|---|
| Selecionar Arquivo | Permite a seleção de arquivo com extensão *.csv para a importação de compromissos. |
|---|
| Baixe nosso modelo .csv para importação | Permite o download do modelo .csv para ser utilizado como referência na criação do arquivo de importação de compromissos. |
|---|
| Cancelar | Cancela a operação e fecha a tela Importar Compromissos. |
|---|
| Importar | Inicia a importação do arquivo .csv selecionado. |
|---|
08. API UTILIZADAS |
| Totvs custom tabs box items |
|---|
| default | no |
|---|
| referencia | calendario |
|---|
| ÍNDICE
01. VISÃO GERALApós o cadastro dos compromissos no calendário, as entregas poderão ser visualizadas no calendário fiscal. Há duas possibilidades de agrupamento de entregas, por data de entrega na forma de calendário, ou por estabelecimento na forma de lista. Em ambos os casos, as entregas serão visualizadas mês a mês. Cada entrega possui uma situação que pode ser atualizada, e permite que sejam anexados diversos comprovantes ou arquivos complementares. 02. UTILIZAÇÃONa visão Calendário, os compromissos são agrupados pela data de entrega Quando há mais de um compromisso por dia, é exibido o texto Ver mais no topo da célula correspondente. Ao clicar no texto, será aberto um quadro na lateral direita do calendário, com todos os compromissos do dia. Na visão Lista o agrupamento é feito por estabelecimento. Cada estabelecimento possui a sua lista retrátil de compromissos. Detalhamento da entrega para alteração de situação e relacionamento de anexos As diferentes situações no status são apresentadas com diferentes cores: - Vermelho = pendente e atrasado;
- Laranja = pendente e em dia;
- Azul claro = entregue;
- Azul = em retificação;
- Verde = retificado.
03. TELA html.fiscalCalendar - CALENDÁRIO/LISTA - PARÂMETROS E AÇÕESPrincipais Campos e Parâmetros
Campo | Descrição |
|---|
| Buscar | Filtra os compromissos pela descrição. | | Status do Compromisso | Filtra os compromissos de acordo com a situação selecionada. Quando não há nenhuma opção selecionada, todas as opções são consideradas. | | Esfera | Filtra os compromissos de acordo com a esfera selecionada. Quando não há nenhuma opção selecionada, todas as opções são consideradas. | | Responsável | Filtra os compromissos de acordo com o responsável selecionado. Quando não há nenhuma opção selecionada, todas as opções são consideradas. Para o administrador, todos os responsáveis que possuem algum compromisso são apresentados, já para o usuário comum, apenas os seus compromissos são apresentados. | | Estabelecimento | Filtra os compromissos de acordo com o estabelecimento selecionado. Quando não há nenhuma opção selecionada, todas as opções são consideradas. Para o administrador, todos os estabelecimentos que possuem algum compromisso são apresentados, já para o usuário comum, apenas os estabelecimentos relacionados aos seus compromissos são apresentados. |
Outras Ações / Ações relacionadas Ação | Descrição |
|---|
| Novo Compromisso | Redireciona para o cadastro de compromissos. | | Calendário | Alterna a visualização para o modo calendário. | | Lista | Alterna a visualização para o modo lista. | | Hoje | Navega para o período atual. | | Anterior ( < ) | Navega para o período anterior ao apresentado. | | Próximo ( > ) | Navega para o período posterior ao apresentado. | | Aplicar | Aplica os filtros selecionados. | | Ver mais | Essa ação é exclusiva do modo calendário. É apresentada quando há mais de uma entrega para o dia em questão. Abre um painel lateral com a lista completa de entregas. | | Alterar Status | Essa ação é exclusiva do modo lista. Abre o detalhe do compromisso para alteração de status e relacionamento de anexos. No modo calendário, essa ação é executada clicando sobre o compromisso, tanto no próprio calendário quanto no painel lateral. |
04. TELA html.fiscalCalendar - DETALHAMENTO DA ENTREGA - COMPROMISSO SELECIONADO
Principais Campos e Parâmetros
Campo | Descrição |
|---|
| Descrição | Descrição do compromisso detalhado | | Status | Status atual do compromisso | | Data de Entrega | Data de entrega do compromisso. | | Estabelecimento | Estabelecimento correspondente do compromisso na estrutura código - nome. | | Novo Status | Campo editável para alteração de status do compromisso. | | Lista de anexos | Todos os anexos relacionados à entrega do compromisso detalhada são listados abaixo do botão Selecionar arquivos. |
Outras Ações / Ações relacionadas Ação | Descrição |
|---|
| Selecionar arquivos | Abre a janela para selecionar um ou mais arquivos para serem anexados ao compromisso. | | Eliminar anexo | Solicita a eliminação do anexo correspondente. Essa ação será efetivada somente se for clicado no botão Salvar. | | Salvar | Salva a alteração de status do compromisso e os anexos relacionados. | | Cancelar | Fecha a tela de detalhamento sem efetivar nenhuma das alterações solicitadas. |
05. APIS UTILIZADAS |
|
