Inclusão de Desconto no Pagamento
Documentação Técnica PagamentoInclusaoDeDesconto Esta rotina, dentro do módulo Financeiro, na área de Pagamento, é responsável por processar o desconto concedido sobre um ou mais títulos a pagar no momento da liquidação (pagamento) desses títulos. 01. VISÃO GERAL DA ROTINA Visão Geral da Rotina Esta rotina, dentro do módulo Financeiro, na área de Pagamento, é responsável por processar o desconto concedido sobre um ou mais títulos a pagar no momento da liquidação (pagamento) desses títulos. Ao concluir a operação, o sistema grava a movimentação financeira e os lançamentos contábeis correspondentes ao valor do desconto, e disponibiliza também a impressão do comprovante da operação. 02. VÍDEO TUTORIAL Vídeo Tutorial Ainda não há vídeo tutorial disponível para esta função. Assim que estiver publicado, o link será incluído aqui. 03. PRÉ-REQUISITOS E CONTEXTO DE ACESSO Pré-requisitos e Contexto de Acesso Para lançar o desconto sobre títulos a pagar, o operador precisa ter acesso à tela “Desconto” — uma das telas de alteração de títulos a pagar, agrupadas dentro do menu Financeiro, na área de “Pagamento”. “Pagamento” é apenas um item de agrupamento no menu e não concede, por si só, acesso a nenhuma das telas que reúne: o acesso à tela “Desconto” é concedido de forma independente das demais telas de alteração de títulos (forma de pagamento, vencimento, decréscimo, juros, multa, remessa de arquivo). 04. DESCRIÇÃO DE CADA CAMPO DA TELA Descrição de Cada Campo da Tela Ao processar o desconto, os seguintes dados são informados: Lista de títulos a pagar selecionados para receber o desconto. É obrigatório selecionar ao menos um título; se nenhum for selecionado, a operação não é executada. Valor do desconto em moeda nacional, para cada título selecionado. Valor do desconto em moeda estrangeira, para cada título selecionado, quando aplicável. Quando este valor é informado (maior que zero), ele tem prioridade sobre o valor em moeda nacional: o sistema converte esse valor para moeda nacional usando a cotação informada. Cotação da moeda estrangeira, usada para converter o valor de desconto em moeda estrangeira para o valor equivalente em moeda nacional. Necessária quando algum título tem desconto informado em moeda estrangeira. Indicação de que a liquidação envolve moeda estrangeira. Quando marcada, o sistema também registra a variação cambial do título, além do desconto. Indicação de que cada título deve gerar um lançamento contábil independente, ou se todos os títulos selecionados compartilham o mesmo lançamento. 05. UTILIZAÇÃO E CONSULTA DE REGISTROS Utilização e Consulta de Registros Ao confirmar a operação, o sistema processa o desconto de cada título selecionado: verifica se o título está bloqueado, calcula o valor do desconto (em moeda nacional ou convertido a partir da moeda estrangeira), grava a movimentação financeira correspondente e gera os lançamentos contábeis decorrentes, exibindo-os em seguida. O sistema também prepara automaticamente o comprovante da operação, deixando-o disponível para impressão. 06. REGRAS DE NEGÓCIO E RESTRIÇÕES Regras de Negócio e Restrições Título bloqueado impede o desconto: antes de processar cada título selecionado, o sistema verifica se ele está bloqueado. Se estiver, a operação é interrompida para aquele título e a seguinte mensagem é exibida: “O desconto não pode ser concluído pois os títulos não podem estar bloqueados. O título [identificador do título] está bloqueado.” É necessário selecionar ao menos um título: se nenhum título for selecionado, a operação não executa nenhum processamento e a seguinte mensagem é exibida: “Não foi possível Salvar. Nenhum título foi informado. Verifique e informe título válido para operação” Lançamentos independentes não podem ser combinados com moeda estrangeira: se a opção de gerar lançamentos independentes por título estiver marcada ao mesmo tempo em que a operação envolve moeda estrangeira, a operação é bloqueada e a seguinte mensagem é exibida: “Não foi possível Processar Títulos. Geração de lançamentos independentes não permitido quando há moeda estrangeira. Mude o parâmetro ‘Gerar lançamentos independentes’ para ‘N – Não’ e tente novamente.” Cálculo do valor do desconto: para cada título, se houver valor de desconto em moeda estrangeira informado, o valor lançado em moeda nacional é o resultado da conversão desse valor pela cotação informada (arredondado em duas casas decimais); caso contrário, é usado diretamente o valor de desconto informado em moeda nacional. Variação cambial: quando a operação é identificada como liquidação em moeda estrangeira, o sistema também registra, antes do lançamento do desconto, uma movimentação de variação cambial referente ao título. A operação é tudo ou nada: o processamento de todos os títulos selecionados ocorre em conjunto — se algo falhar durante o processamento de qualquer um deles, nenhuma parte da operação é salva, nem mesmo para os títulos que já haviam sido processados com sucesso naquela execução. 07. SOLUÇÃO DE PROBLEMAS Solução de Problemas T-01 — A mensagem “O desconto não pode ser concluído pois os títulos não podem estar bloqueados” é exibida. O título indicado na mensagem está bloqueado e não pode receber desconto enquanto essa condição não for revertida. Verifique o motivo do bloqueio do título ou selecione outro título para continuar a operação. T-02 — A mensagem “Não foi possível Salvar. Nenhum título foi informado” é exibida. Nenhum título foi selecionado antes de confirmar a operação. Verifique e informe título válido para operação. T-03 — A mensagem “Não foi possível Processar Títulos. Geração de lançamentos independentes não permitido quando há moeda estrangeira” é exibida. A operação foi configurada, ao mesmo tempo, para gerar lançamentos independentes por título e para liquidação em moeda estrangeira — essa combinação não é permitida. Mude o parâmetro “Gerar lançamentos independentes” para “N – Não” e tente novamente.
Pagamento
Receitas
Documentação Técnica Receitas A rotina Receitas pertence ao módulo Financeiro, dentro da funcionalidade de Caixa. 01. VISÃO GERAL Visão Geral A rotina Receitas pertence ao módulo Financeiro, dentro da funcionalidade de Caixa. Ela permite lançar o recebimento de um título (uma receita) diretamente no caixa/carteira do usuário, gerando a movimentação financeira e o respectivo lançamento contábil (débito na carteira/caixa e crédito na conta de resultado associada ao histórico padrão informado). A rotina também oferece uma ação auxiliar de impressão de comprovante e uma consulta de configuração usada para pré-carregar a tela. 02. ENDPOINTS Endpoints POST /Receitas/Salvar Processa e persiste o recebimento (a receita) de um título selecionado pelo usuário, gerando a movimentação financeira e a contabilização correspondente. Permissão: “Receitas/Salvar” (ID 1856) Parâmetros: Nome Tipo Obrigatório Descrição dto DTOCabecalhoDeOperacoes Sim Cabeçalho da operação. Campos relevantes usados por esta ação: `TitulosAProcessar` (lista com o título a processar — apenas o primeiro item da lista é efetivamente processado), `VariacaoDoFatoContabil` (string no formato “algo|N”, onde N é o identificador numérico da variação de rotina contábil), `IdHistoricoPadrao`, `Documento`, `IdCentroDeCusto`, `Observacao` dto.TitulosAProcessar[0] DTODeTituloAProcessar Sim Dados do título a receber: `IDDaCarteiraDePagamento` (carteira/caixa de destino do recebimento), `Valor`, `ValorMoeda`, `DataEmissao`, entre outros Exemplo de request: “` POST /Receitas/Salvar Content-Type: application/json { “TitulosAProcessar”: [ { “IDDaCarteiraDePagamento”: 12, “Valor”: 150.00, “DataEmissao”: “2026-09-10” } ], “VariacaoDoFatoContabil”: “Padrao|1”, “IdHistoricoPadrao”: 45, “Documento”: “NF-1234”, “IdCentroDeCusto”: “10”, “Observacao”: “Recebimento em espécie” } “` Exemplo de response: “`json { “success”: true, “listaDeOperacoesFinanceiras”: [ /* movimentações financeiras geradas para a operação */ ], “listaDeOperacoesContabeis”: [ /* lançamentos contábeis gerados a partir da chave da operação */ ] } “` POST /Receitas/Imprimir Garante que o modelo (template) do relatório “Comprovante de Movimentação Financeira” exista na pasta específica do cliente, copiando-o da pasta padrão quando necessário, e sinaliza sucesso para o front-end iniciar a impressão do comprovante. Permissão: “Receitas/Imprimir” (ID 1857) Parâmetros: nenhum. Exemplo de request: “` POST /Receitas/Imprimir “` Exemplo de response: “`json { “success”: true } “` GET /Receitas/ObterCentroDeCustoDefault Retorna o centro de custo padrão configurado no sistema, e informa se a carteira padrão do usuário é uma carteira em moeda estrangeira (para exibir o símbolo da moeda e a cotação na tela). Permissão: ação de leitura sem entrada própria — está marcada com `[PermiteAcessoAnonimo]` no código, mas isso não dispensa o acesso à rotina em si: a tela só é alcançada por quem já tem a permissão de acesso “EditViewDeReceitas” (ID 1590). Parâmetros: nenhum (usa a carteira padrão do usuário logado, lida da configuração de filtros do Financeiro). Exemplo de request: “` GET /Receitas/ObterCentroDeCustoDefault “` Exemplo de response: “`json { “success”: true, “centroDeCustoDefault”: “10”, “ehMoedaEstrangeira”: false, “simboloMoeda”: “”, “cotacao”: 0 } “` 03. MODELOS DE DADOS Modelos de Dados DTOCabecalhoDeOperacoes (campos usados por esta rotina) Campo Tipo Descrição TitulosAProcessar Lista de DTODeTituloAProcessar Título(s) selecionado(s) para receber — apenas o primeiro item da lista é processado por “Salvar” VariacaoDoFatoContabil string Identifica a variação da regra contábil aplicada ao lançamento; formato “texto|id”, onde o id é extraído após o caractere “|” IdHistoricoPadrao int Histórico contábil padrão a ser usado no lançamento, caso diferente do histórico já associado ao fato contábil Documento string Número/identificação do documento associado à operação (ex: nota fiscal, comprovante) IdCentroDeCusto string Centro de custo a ser rateado no lançamento contábil gerado Observacao string Observação livre registrada junto à movimentação DTODeTituloAProcessar (campos relevantes usados por esta rotina) Campo Tipo Descrição IDDaCarteiraDePagamento int Carteira/caixa em que o recebimento será lançado (destino do dinheiro) Valor decimal Valor do título recebido ValorMoeda decimal Valor do título em moeda estrangeira, quando aplicável DataEmissao DateTime Data de emissão do título 04. REGRAS DE NEGÓCIO Regras de Negócio Título obrigatório para salvar. A ação “Salvar” só processa a operação se `TitulosAProcessar` contiver ao menos um item; caso contrário, a operação é rejeitada. Mensagem exibida: “Não foi possível Salvar. Os dados informados podem estar incorretos. Verifique se os dados informados estão corretos.” Apenas o primeiro título da lista é processado. Mesmo que `TitulosAProcessar` contenha mais de um item, somente o primeiro (`TitulosAProcessar[0]`) é efetivamente recebido nesta chamada. Lançamento contábil automático. Ao salvar, o sistema gera automaticamente a movimentação financeira (débito na carteira/caixa de destino) e o lançamento contábil correspondente (crédito na conta de resultado vinculada ao histórico), integrando a receita à contabilidade sem intervenção manual adicional. Recebimento entre filiais diferentes (operação de mútuo). Se a filial do usuário logado (origem) for diferente da filial vinculada à carteira de destino do recebimento, o sistema classifica a operação como “mútuo entre filiais” e gera lançamentos adicionais específicos para representar essa transferência entre filiais, além do lançamento normal da receita. Essa operação de mútuo exige que ambas as filiais envolvidas (a do título e a do pagamento) tenham uma “Carteira para Lançamento Mútuo” configurada em seu cadastro. Se a filial do pagamento não tiver essa configuração: Mensagem exibida: “Não foi possível validar Dados. Não é possível executar uma operação financeira mútua sem a carteira mútua. Por favor, realizar parametrização no cadastro da filial, em Dados Relacionados=>Conta Lancto Mútuo.” Se for a filial do título que não tiver a configuração, a mensagem exibida é equivalente: “Não foi possível validar Dados. Não é possível executar uma operação financeira mutua sem a carteira mutua. Por favor configure a carteira mutua para a filial da operação.” Histórico padrão do lançamento. Se o `IdHistoricoPadrao` informado for diferente do histórico já vinculado ao primeiro lançamento do fato contábil da rotina, o sistema busca e usa o histórico informado; caso contrário, mantém o histórico já associado ao fato contábil. Falha inesperada durante o processamento. Qualquer erro não previsto durante a gravação (ex: falha de banco de dados) interrompe a transação e nenhum dado é persistido. Mensagem exibida: “[mensagem técnica do erro]. Falha na operação. Verifique os dados e tente novamente.” Comprovante de impressão. Antes de imprimir o comprovante da operação, o sistema garante que exista, na pasta do cliente, uma cópia do modelo padrão do relatório “ComprovanteMovtoFin.rpt” — copiando-a automaticamente da pasta padrão na primeira vez que for necessária. Moeda estrangeira na tela. Ao carregar a tela, o sistema verifica se a
Como cadastrar Período Apuração Tributos
MÓDULO: Escrita Fiscal – Apurações Como abrir o período de apuração de tributos Aprenda a abrir o período de apuração de tributos no ERP, individualmente mês a mês ou gerando todos os períodos do ano de uma só vez. Visão geral Definir o período de apuração dos tributos estabelece a competência em que os impostos serão calculados e apurados, garantindo que os valores sejam considerados corretamente conforme as regras fiscais e o período correspondente. Pré-requisitos Acesso ao livro Escrita Fiscal e ao módulo Apurações no ERP. Perfil de analista fiscal ou de usuário responsável pela parametrização. Passo a passo Abrindo o período individualmente 1 Acesse o sistema pelo Erp v1 e abra o livro “Escrita Fiscal” Acesse o sistema pelo Erp v1 e clique no livro chamado “Escrita Fiscal”. 2 Verifique o módulo “Apurações” Dentro do livro “Escrita Fiscal”, verifique o módulo “Apurações”. 3 Clique em “Apuração de tributos” Clique em “Apuração de tributos” dentro do módulo Apurações. 4 Clique em “Novo” Na tela de Apuração de Tributos, clique em “Novo”. 5 Selecione a filial do cadastro Selecione a filial do cadastro para o qual o período de apuração será aberto. 6 Selecione o tributo Selecione o tributo para o qual será aberto o período de apuração. 7 Selecione a data de início e a data de fim Selecione a data de início e a data de fim do período de apuração. 8 Clique em “Salvar” Clique em “Salvar” para confirmar o cadastro do período. 9 Confirme a abertura do período Após salvar, o período foi aberto com sucesso. ⚠ Importante O período mensal pode ser aberto individualmente, mês a mês, ou todos os meses de uma única vez. Gerando todos os meses do período de uma só vez 1 Clique em “Gerar Períodos” Para gerar todos os meses do período do imposto de uma vez, clique em “Gerar Períodos”. 2 Selecione a filial Selecione a filial para a qual os períodos serão gerados. 3 Selecione o imposto Selecione o imposto para o qual os períodos serão gerados. 4 Informe o ano de vigência do período Informe o ano de vigência do período que será gerado. 5 Clique em “Gerar” Clique em “Gerar” para concluir a geração dos períodos. 6 Confirme a geração dos períodos Os períodos foram gerados com sucesso. Os períodos de todos os meses vigentes estarão abertos para o imposto selecionado. ⚠ Atenção — Aviso de Escopo As causas e soluções acima são baseadas exclusivamente nos atendimentos analisados. Situações não listadas devem ser abertas como novo chamado em: atak.movidesk.com
Como cadastrar código de ajuste da tabela 5.1.1
MÓDULO: Escrita Fiscal Cadastro, Importação e Validação da Tabela 5.1.1 – Códigos de Ajustes da Apuração do ICMS Aprenda a cadastrar, importar e validar a Tabela 5.1.1 de Ajustes da Apuração do ICMS no ERP Atak, conforme as regras da SEFAZ e da EFD. Visão geral Neste manual você acompanha o processo de criação da Tabela 5.1.1 -Tabela de Códigos de Ajustes da Apuração do ICMS, onde é utilizada na escrituração fiscal para identificar os ajustes que devem ser aplicado ao resultado da apuração do ICMS, como débitos, créditos, estornos, deduções e outros ajustes, conforme as regras da SEFAZ de cada estado. O que você vai aprender Como acessar a tabela de Ajuste de apuração do ICMS Como reconhecer um novo código Como identificar e preencher a descrição Como validar as informações antes da gravação Contexto e pré-requisitos Este manual define o procedimento para utilização da Tabela 5.1.1 – Informações Adicionais da Apuração – Valores Declaratórios no ERP Atak, orientando o preenchimento e a conferência das informações utilizados na apuração fiscal e na geração das obrigações fiscais. Os códigos são definidos pelas Secretarias de Fazenda de cada UF e seguem uma estrutura padronizada de 8 caracteres. O Manual de Orientação da EFD determina que o código identifique a UF, o tipo de apuração, a utilização do ajuste e a sequência específica da ocorrência. Ela está diretamente relacionada aos registros E111/E113 de ajustes da EFD. ⚠ Importante Os códigos da Tabela 5.1.1 não devem ser cadastrados ou utilizados de forma arbitrária. Antes de realizar o procedimento, confirme o código, descrição, vigência e orientação estabelecidos pela SEFAZ da UF correspondente. Consulte os códigos oficiais em: Portal do Sped Tabelas Passo a passo 1 Como Cadastrar e Utilizar a Tabela 5.1.1 – Tabela de Códigos de Ajustes da Apuração do ICMS no Atak Com o ERP aberto, acesse: Módulo Escrita Fiscal > Tabela 5.1-1 – Tabela de Códigos de Ajustes da Apuração do ICMS 2 Cadastro novo Clique no botão Novo para iniciar a abertura de um novo código. 3 Reconhecendo o Código e descrição No campo Código, informar exatamente o número correspondente ao código disponível da Receita respeitando a numeração e caracteres como exemplo na imagem ao lado da regra de preenchimento do código. No campo Descrição informe o nome do código no portal da Receita conforme o código utilizado. Em seguida após o preenchimento e conferência clicar em Salvar e para concluir a operação clicar em Salvar e fechar. 4 Importação das tabelas Também é possível a importação da tabela disponibilizada no site da Receita, conforme estado, selecionando a tabela 5.1.1 e em seguida baixando o arquivo para importação no sistema Atak. 5 Selecionar e importar o arquivo Baixado o arquivo, em Tabela 5.1.1 – Tabela de Códigos de Ajustes da Apuração do ICMS clicar no botão Importar Tabelas assim ao abrir a tela de importação selecionar em Arquivo, o arquivo baixado da tabela conforme site da receita em seguida clicar no botão importar. 6 Concluir a importação Clique em OK para concluir a importação realizada. 7 Editar ou excluir registros importados Com a importação realizada se necessário alteração, é possível clicando no botão Edição ou Excluir. E para concluir a operação clicar no botão Fechar Aba. Validação Reconhecido as tabelas, está pronto para vinculação em Módulo Escrita Fiscal > Movimentação apuração de tributos e assim levar para apuração do ICMS mensal e informações no bloco E111 do sped Fiscal. ⚠ Atenção — Aviso de Escopo As causas e soluções acima são baseadas exclusivamente nos atendimentos analisados. Situações não listadas devem ser abertas como novo chamado em: atak.movidesk.com
Alteração Forma de Cobrança
Documentação Técnica CobrancaAlteracaoDeFormaDeCobranca Esta rotina do módulo Financeiro permite alterar, em lote, a forma de cobrança (para títulos a receber) ou a forma de pagamento (para títulos a pagar) de um conjunto de títulos já lançados no sistema, registrando o movimento contábil/financeiro decorrente dessa alteração e mantendo o histórico da forma anterior. 01. VISÃO GERAL Visão Geral Esta rotina do módulo Financeiro permite alterar, em lote, a forma de cobrança (para títulos a receber) ou a forma de pagamento (para títulos a pagar) de um conjunto de títulos já lançados no sistema, registrando o movimento contábil/financeiro decorrente dessa alteração e mantendo o histórico da forma anterior. Ela corresponde à tela de menu “Alteração forma cobrança”, dentro do agrupamento “Cobrança”. 02. ENDPOINTS Endpoints [POST] /CobrancaAlteracaoDeFormaDeCobranca/Salvar Recebe uma lista de títulos e uma forma de cobrança/pagamento de destino, e aplica a alteração a cada título informado. Para cada título, o sistema identifica automaticamente se ele é um título a receber ou a pagar, atualiza a forma de cobrança/pagamento, preserva a forma anterior em um campo de histórico e gera o lançamento financeiro correspondente. Ao final, retorna a lista das movimentações financeiras geradas pela operação (dados usados para emissão do comprovante). Permissão: “CobrancaAlteracaoDeFormaDeCobranca/Salvar” (ID 1789) Parâmetros (corpo da requisição): Nome Tipo Obrigatório Descrição TitulosAProcessar Lista de títulos Sim Lista dos títulos a terem a forma de cobrança/pagamento alterada. Cada item precisa ao menos do identificador (campo “ID”) do título. IDDaFormaDeCobranca Número Sim Identificador da forma de cobrança (ou forma de pagamento, no caso de título a pagar) para a qual os títulos selecionados serão alterados. GeraLanctosIndependentes Texto (“Sim”/”Não”) Não Define se cada título deve gerar um lançamento financeiro próprio e independente, em vez de agrupar todos os títulos processados em um único lançamento. EhLiquidacaoMoedaExtrangeira Verdadeiro/Falso Não Indica se a operação envolve liquidação em moeda estrangeira. Observação: o campo “IDDoFatoContabil” também existe no modelo de dados da requisição, mas é preenchido automaticamente pelo próprio sistema antes do processamento — não precisa (e não deve) ser informado pelo usuário/tela. Exemplo de request: “` POST /CobrancaAlteracaoDeFormaDeCobranca/Salvar { “TitulosAProcessar”: [ { “ID”: “12345” }, { “ID”: “12346” } ], “IDDaFormaDeCobranca”: 3, “GeraLanctosIndependentes”: “Não”, “EhLiquidacaoMoedaExtrangeira”: false } “` Exemplo de response: “`json { “success”: true, “listaDeOperacoesFinanceiras”: [] } “` [POST] /CobrancaAlteracaoDeFormaDeCobranca/Imprimir Ação de apoio à emissão do comprovante de alteração. Antes de gerar o comprovante, o sistema garante que a pasta de documentos do cliente exista e que o modelo de relatório (arquivo “ComprovanteAlteracaoInfoFin.rpt”) esteja disponível nessa pasta, copiando-o do modelo padrão quando necessário. Não realiza nenhuma alteração de dados de negócio — é apenas preparação de arquivo para a impressão do comprovante. Permissão: “CobrancaAlteracaoDeFormaDeCobranca/Imprimir” (ID 1790) Parâmetros: nenhum. Exemplo de request: “` POST /CobrancaAlteracaoDeFormaDeCobranca/Imprimir “` Exemplo de response: “`json { “success”: true } “` 03. MODELOS DE DADOS Modelos de Dados Item de “TitulosAProcessar” (título a alterar) — campos relevantes para esta rotina: Campo Tipo Descrição ID Texto Identificador (chave de fato) do título a receber ou a pagar que terá a forma de cobrança/pagamento alterada. Este item pertence a um modelo de dados de título mais amplo, compartilhado por outras rotinas financeiras; apenas o campo “ID” é utilizado por esta operação de alteração de forma de cobrança. Cabeçalho da operação — campos relevantes para esta rotina: Campo Tipo Descrição TitulosAProcessar Lista de títulos Títulos selecionados para alteração. IDDaFormaDeCobranca Número Forma de cobrança/pagamento de destino. GeraLanctosIndependentes Texto (“Sim”/”Não”) Se cada título gera lançamento financeiro próprio. EhLiquidacaoMoedaExtrangeira Verdadeiro/Falso Se a operação envolve moeda estrangeira. IDDoFatoContabil Número Preenchido automaticamente pelo sistema (fato contábil da operação); não é um campo de entrada do usuário. Este cabeçalho também é um modelo de dados compartilhado por várias telas financeiras (pagamentos, transferências, remessas etc.); apenas os campos acima são utilizados por esta rotina. 04. REGRAS DE NEGÓCIO Regras de Negócio Regra 1 — Identificação automática do tipo de título. Para cada título informado, o sistema primeiro tenta localizá-lo entre os títulos a receber. Se encontrado, trata-o como lançamento a débito e usa a operação financeira de alteração de forma de cobrança (recebimento). Se não for encontrado entre os títulos a receber, o sistema busca entre os títulos a pagar e, se encontrado, trata-o como lançamento a crédito, usando a operação financeira de alteração de forma de pagamento. Regra 2 — Preservação do histórico da forma anterior. Antes de sobrescrever a forma de cobrança (ou de pagamento) do título, o sistema registra a forma anterior em um campo de histórico, no formato “Código – Nome” (ex: “3 – Boleto”), permitindo rastrear qual era a forma antes da alteração. Regra 3 — Restrição para lançamentos independentes em moeda estrangeira. Não é permitido gerar lançamentos financeiros independentes (um lançamento por título) quando a operação envolve liquidação em moeda estrangeira. Se o usuário solicitar “GeraLanctosIndependentes” = “Sim” junto com “EhLiquidacaoMoedaExtrangeira” = verdadeiro, a operação é bloqueada. Mensagem exibida: “Não foi possível Processar Títulos” — “Geração de lançamentos independentes não permitido quando há moeda estrangeira.” — “Mude o parâmetro ‘Gerar lançamentos independentes’ para ‘N – Não’ e tente novamente.” Regra 4 — Obrigatoriedade de ao menos um título. A operação de salvar não pode ser executada sem nenhum título selecionado. Mensagem exibida: “Não foi possível Salvar” — “Nenhum título foi informado.” — “Verifique e informe título válido para operação” Regra 5 — Falha durante o processamento de um título. Se ocorrer qualquer erro ao processar um dos títulos da lista (por exemplo, dado inconsistente do título), toda a operação de alteração é interrompida e desfeita, e o sistema exibe a mensagem de erro abaixo, substituindo “{0}” pelo detalhe técnico do problema ocorrido. Mensagem exibida: “Não foi possível alterar forma de pagamento” — “{0}” — “Verifique e corrija a operação” Regra 6 — Persistência transacional. A alteração de todos os títulos da lista ocorre dentro de uma única transação de banco de dados: só é confirmada (efetivada) se todos os títulos forem processados com sucesso; qualquer falha no meio do processo desfaz as alterações já feitas na operação. Regra 7 — Geração de lançamento financeiro. Para cada título
Cobranca
Transmissão de NFS-e
Documentação Técnica Transmissão de NFS-e (ERPV2) A tela “NFS-e – Transmissão” (Documentos Fiscais Eletrônicos > NFS-e > Transmissão) é onde o usuário efetivamente envia para a Prefeitura/SEFAZ as notas fiscais de serviço eletrônicas geradas a partir de um documento de origem (o “RPS” — Recibo Provisório de Serviço). 01. VISÃO GERAL Visão Geral A tela “NFS-e – Transmissão” (Documentos Fiscais Eletrônicos > NFS-e > Transmissão) é onde o usuário efetivamente envia para a Prefeitura/SEFAZ as notas fiscais de serviço eletrônicas geradas a partir de um documento de origem (o “RPS” — Recibo Provisório de Serviço). Nela também são feitas as ações posteriores à transmissão: cancelamento, reenvio por e-mail, geração de DANFSE, exportação dos XML e uma “consulta administrativa” que confere e corrige eventuais divergências entre o que está registrado no ERP e o que consta oficialmente no governo. 02. AUTORIZAÇÃO Autorização Ação Permissão necessária Acessar a tela / listar documentos Visualizar (DFeNFSeTransmissaoMenu) Transmitir NFS-e Transmitir NFS-e Cancelar NFS-e Cancelar NFS-e Exportar XML Exportar XML Enviar por E-mail Enviar por E-mail Gerar DANFE Gerar DANFE Exibir histórico (operações/eventos) Exibir Histórico Compor lote e usar as ações em lote Ações em Lote Consulta Administrativa Consulta Administrativa 03. INTERFACE E COMPORTAMENTOS DA TELA Interface e Comportamentos da Tela Indicadores no topo (cartões) Três cartões resumem a situação do período filtrado — “À Enviar”, “Autorizadas” e “Canceladas”. Clicar em um cartão filtra automaticamente a listagem pelos status correspondentes; clicar novamente no mesmo cartão remove o filtro. Filtros Status NFS-e (múltiplo) Filial (múltiplo) Tipo de Data (obrigatório): Data Movimento, Data Emissão ou Data Saída — enquanto nenhum tipo é escolhido, os campos de data ficam bloqueados Data Inicial / Data Final (obrigatórios quando um Tipo de Data é escolhido) — intervalo máximo de 31 dias TMV RPS (múltiplo) Número RPS ou NFS-e Chave Fato RPS ou NFS-e Participante (múltiplo) Listagem Cada linha mostra, lado a lado, os dados do documento de origem (RPS) e os dados da NFS-e gerada a partir dele (quando já existir): status do documento, se está contabilmente atualizado, status do evento de transmissão, status junto à Prefeitura/SEFAZ, código de retorno (cStat), chave, identificação do documento (filial-tipo-série-número), data, Tipo de Movimento, participante e valor. Seleção e barra de lote Marcar uma ou mais linhas faz aparecer, na parte inferior da tela, uma barra com a quantidade de documentos selecionados e um botão “Ações em lote”, que leva para uma segunda tela onde as ações abaixo podem ser aplicadas a todo o lote de uma vez. A seleção é lembrada mesmo ao trocar de página da listagem ou sair e voltar à tela. Ações disponíveis por linha (menu de contexto) Cada linha tem um menu com as seguintes ações, cada uma disponível apenas quando a situação do documento permite: Transmitir RPS — disponível quando o RPS ainda não foi enviado ou está em lote aguardando envio. Exibir Histórico — sempre disponível; mostra as operações e eventos já ocorridos com o documento. DANFSE — disponível quando a NFS-e já está Autorizada ou Cancelada. Exportar XML — mesma condição do DANFSE. Enviar por E-mail — mesma condição do DANFSE. Consulta administrativa — disponível quando o RPS já está contabilmente atualizado. Cancelar NFS-e — disponível apenas quando a NFS-e está Autorizada. Dar duplo clique em uma linha também abre o histórico de operações/eventos daquele documento. 04. CAMPOS DA TELA Campos da Tela Campo (como aparece na tela) Obrigatório Descrição Status NFS-e Não Filtro pela situação atual da nota (Não enviada, Autorizada, Cancelada, Denegada, Inutilizada, Rejeitada, etc.) Filial Não Filtro por uma ou mais filiais Tipo de Data Sim Define qual data (Movimento, Emissão ou Saída) será usada no filtro de período Data Inicial / Data Final Sim (quando Tipo de Data preenchido) Período de consulta; limite de 31 dias TMV RPS Não Filtro por Tipo de Movimento do documento de origem Número RPS ou NFS-e Não Localiza pelo número do documento Chave Fato RPS ou NFS-e Não Localiza por um identificador interno específico Participante Não Filtro por um ou mais participantes (clientes/tomadores) RPS — Status Documento / Atualizado? / Status Evento / Status Sefaz / cStat / Chave / Documento / Data Emissão / TMV / Participante / Valor Não (somente leitura) Dados do documento de origem, exibidos na listagem NFS-e — Status Documento / Atualizado? / Status Sefaz / Chave / Documento / Valor Não (somente leitura) Dados da NFS-e gerada a partir do RPS, quando já existir 05. REGRAS DE NEGÓCIO Regras de Negócio Transmitir NFS-e Cada documento selecionado é processado individualmente — uma falha em um documento não impede que os demais sejam transmitidos. Para cada documento, o sistema registra um evento de acompanhamento de transmissão (ou reaproveita um já existente, se houver um pendente de processamento) e envia a Declaração de Prestação de Serviço (DPS) ao ambiente da NFS-e Nacional. Se o retorno não for um status de autorização, o evento de acompanhamento é marcado com erro e o motivo é reportado; caso contrário, é marcado como concluído. Após a transmissão bem-sucedida, o sistema tenta enviar a nota por e-mail automaticamente. Se todos os documentos forem transmitidos com sucesso: Mensagem exibida: “O envio da(s) Nota(s) para a Sefaz foi realizado com sucesso.” Se algum documento falhar: Mensagem exibida: “Falha ao enviar documento(s) para a SEFAZ.” (acompanhada da lista dos documentos que falharam e o motivo de cada um) Cancelar NFS-e O cancelamento pode ser feito informando diretamente a chave da NFS-e, ou informando a chave do RPS de origem (nesse caso o sistema localiza automaticamente a NFS-e gerada a partir dele). Um motivo de cancelamento é sempre obrigatório. Mensagem exibida quando o motivo não é informado: “Motivo do cancelamento não informado. O código do motivo de cancelamento é obrigatório para realizar a operação em lote. Selecione um motivo de cancelamento válido e tente novamente.” Mensagem exibida quando o cancelamento é feito via chave do RPS e nenhuma NFS-e correspondente é encontrada: “NFS-e não encontrada. Não foi localizada uma NFS-e vinculada ao RPS {0}. Verifique se o RPS foi transmitido e convertido
Reapresentação de Cheque Próprio
Documentação Técnica ReapresentacaoDeChequeProprio Esta rotina do módulo Financeiro (submenu “Caixa”) permite reapresentar cheques próprios que foram devolvidos pelo banco. 01. VISÃO GERAL Visão Geral Esta rotina do módulo Financeiro (submenu “Caixa”) permite reapresentar cheques próprios que foram devolvidos pelo banco. O usuário localiza os lançamentos financeiros de devolução de cheque próprio ainda não conciliados e gera uma nova movimentação de reapresentação, vinculada ao lançamento original de devolução. 02. ENDPOINTS Endpoints [GET] /ReapresentacaoDeChequeProprio/Listar Lista as movimentações financeiras de devolução de cheque próprio da filial logada, elegíveis para reapresentação (partida Crédito, operação financeira “BCODEV1CHP”, ainda não conciliadas). Permissão: coberta pela permissão de acesso à rotina “EditViewDeReapresentacaoDeChequeProprio” (ID 1597) Parâmetros: Nome Tipo Obrigatório Descrição extGrid ConfiguracaoDeGrid Sim Configuração de paginação/ordenação da grid valorDeConsulta string Não Filtro textual de busca (padrão: vazio) Exemplo de request: “` GET /ReapresentacaoDeChequeProprio/Listar?valorDeConsulta=123 “` Exemplo de response: “`json { “total”: 0, “rows”: [] } “` [POST] /ReapresentacaoDeChequeProprio/Salvar Recebe a lista de movimentações financeiras de devolução de cheque próprio selecionadas pelo usuário e efetiva a reapresentação: para cada movimentação, valida o lançamento de devolução original, marca esse lançamento como conciliado e gera duas novas movimentações financeiras (débito e crédito) vinculadas à operação de reapresentação (“BCOREAPCHP”). Ao final, dispara a integração contábil correspondente, quando aplicável. Permissão: “ReapresentacaoDeChequeProprio/Salvar” (ID 3037) Parâmetros: Nome Tipo Obrigatório Descrição dto DTOCabecalhoDeOperacoes Sim Cabeçalho da operação; o campo relevante para esta rotina é “MovimentacoesFinanceiras” dto.MovimentacoesFinanceiras IList[DTODeMovimentacaoFinanceira] Sim (não pode ser vazia) Lista das movimentações financeiras de devolução de cheque próprio selecionadas para reapresentação Exemplo de request: “` POST /ReapresentacaoDeChequeProprio/Salvar { “MovimentacoesFinanceiras”: [ { “IdDaFilial”: “001”, “ChaveDeFato”: “000000001”, “NumeroDoLancamento”: 1 } ] } “` Exemplo de response: “`json { “success”: true, “CodigoDaOperacao”: 0, “listaDeMovimentacaoFinanceira”: [], “listaDeOperacoesContabeis”: [] } “` [POST] /ReapresentacaoDeChequeProprio/Imprimir Prepara o relatório de comprovante (“ComprovanteCaixa.rpt”) para impressão, copiando o modelo padrão do relatório para a pasta específica do cliente caso ainda não exista. Permissão: “ReapresentacaoDeChequeProprio/Imprimir” (ID 3038) Parâmetros: Nenhum parâmetro de entrada. Exemplo de request: “` POST /ReapresentacaoDeChequeProprio/Imprimir “` Exemplo de response: “`json { “success”: true } “` 03. MODELOS DE DADOS Modelos de Dados DTOCabecalhoDeOperacoes (campos relevantes para esta rotina) Campo Tipo Descrição MovimentacoesFinanceiras IList[DTODeMovimentacaoFinanceira] Lista das movimentações de devolução de cheque próprio a reapresentar [informação não disponível na análise de código — validar com analista/vídeo do sistema]: os demais campos de “DTOCabecalhoDeOperacoes” pertencem a outras rotinas de operações financeiras (títulos, remessas, pagamentos) e não são utilizados por esta rotina. DTODeMovimentacaoFinanceira (campos relevantes para esta rotina) Campo Coluna (BD) Tipo Descrição IdDaFilial Cod_filial string (char 3) Filial da movimentação financeira ChaveDeFato Chave_fato string (char 9) Chave do fato contábil/financeiro da movimentação de devolução NumeroDoLancamento Num_lancto short Número do lançamento dentro do fato AtualizarModulo Atualizar_modulo string (char 1) Módulo de origem da movimentação — deve ser o módulo bancário IDDoTipoPartida Tipo_partida string (char 1) Tipo de partida do lançamento — deve ser “Crédito” StatusConciliado Status_conciliado string (char 1) Indica se a movimentação de devolução já está conciliada — deve estar não conciliada para permitir reapresentação OperacaoFinanceira operfin string Código da operação financeira — deve ser “BCODEV1CHP” (devolução de cheque próprio) 04. REGRAS DE NEGÓCIO Regras de Negócio Regra 1 — Lista de reapresentação restrita a devoluções não conciliadas. A ação “Listar” traz apenas movimentações da filial logada com operação financeira “BCODEV1CHP”, partida Crédito e ainda não conciliadas — movimentações já conciliadas ou de outra operação não aparecem para reapresentação. Regra 2 — Lista de movimentações não pode ser vazia ao salvar. Se o usuário tentar salvar sem selecionar nenhuma movimentação financeira, o sistema bloqueia a operação. Mensagem exibida: “Não foi possível Salvar. Os dados informados podem estar incorretos. Verifique se os dados informados estão corretos.” Regra 3 — Fato contábil obrigatório para a configuração de operação. Ao processar a reapresentação, o sistema exige que exista um fato contábil configurado para a operação e variação utilizadas. Mensagem exibida: “Não foi possível Reapresentar. É obrigatório informar um fato contábil para a seguinte configuração: Operação: {0} Variação: {1}. REAPRESENTAÇÃO CHEQUE PRÓPRIO, Informe um fato contábil para operação” Regra 4 — Movimentação de devolução deve existir. O sistema busca a movimentação financeira de devolução original vinculada à movimentação selecionada; se não encontrar, bloqueia a operação. Mensagem exibida: “Não foi possível obter Movimentação de devolução. Movimentação financeira de devolução do cheque próprio não encontrada. Filial: {0} Chave de fato: {1} Num. Lançamento: {2}. Informe Movimentação financeira de devolução do cheque próprio validos para operação” Regra 5 — Movimentação de devolução deve pertencer ao módulo bancário. Se a movimentação de devolução encontrada não pertencer ao módulo bancário, o sistema bloqueia a operação. Mensagem exibida: “Não foi possível obter Movimentação de devolução. Movimentação financeira de devolução do cheque próprio informada não faz parte do módulo bancário. Filial: {0} Chave de fato: {1} Num. Lançamento: {2}. Informe Movimentação Financeira que faça parte do módulo bancário” Regra 6 — Movimentação de devolução deve ser de partida Crédito. Se a movimentação de devolução não for de partida Crédito, o sistema bloqueia a operação. Mensagem exibida: “Não foi possível obter Movimentação de devolução. Movimentação financeira de devolução do cheque próprio informada não é da partida Crédito. Filial: {0} Chave de fato: {1} Num. Lançamento: {2}. Informe Movimentação de Devolução de partida de Crédito” Regra 7 — Movimentação de devolução não pode já estar conciliada. Se a movimentação de devolução já estiver conciliada, o sistema bloqueia a operação. Mensagem exibida: “Não foi possível obter Movimentação de devolução. Movimentação financeira de devolução do cheque próprio informada já está conciliado. Filial: {0} Chave de fato: {1} Num. Lançamento: {2}. Informe movimentação financeira que não esteja conciliado, ou desconcelie para realizar operação” Regra 8 — Movimentação de devolução deve ser da operação correta. Se a movimentação de devolução não for da operação “BCODEV1CHP” (devolução de cheque próprio), o sistema bloqueia a operação. Mensagem exibida: “Não foi possível obter Movimentação de devolução. Movimentação financeira de devolução do cheque próprio informada não é uma operação BCODEV1CHP. Filial: {0} Chave de fato: {1} Num. Lançamento: {2}. Movimentação de devolução deve ser uma operação BCODEV1CHP” Regra 9 — Falha inesperada na reapresentação. Se ocorrer
Reapresentação de Cheque de Terceiro
Documentação Técnica ReapresentacaoDeChequeDeTerceiro Rotina do módulo Financeiro > Caixa que permite reapresentar (levar novamente à cobrança/depósito) um cheque de terceiro que havia sido devolvido pelo banco. 01. VISÃO GERAL Visão Geral Rotina do módulo Financeiro > Caixa que permite reapresentar (levar novamente à cobrança/depósito) um cheque de terceiro que havia sido devolvido pelo banco. A operação reverte contabilmente a devolução registrada anteriormente, gerando uma nova movimentação financeira (débito e crédito) que representa o cheque voltando ao fluxo de caixa/banco. 02. ENDPOINTS Endpoints GET /ReapresentacaoDeChequeDeTerceiro/Listar Lista, em grid, as movimentações financeiras de cheques de terceiros devolvidos que estão disponíveis para reapresentação na filial logada do usuário. Permissão: ação marcada como acesso anônimo no código ([PermiteAcessoAnonimo]) — não exige permissão granular própria; o acesso à tela como um todo é controlado pela permissão de acesso à rotina “EditViewDeReapresentacaoDeChequeDeTerceiro” (ID 1594). Parâmetros: Nome Tipo Obrigatório Descrição extGrid ConfiguracaoDeGrid Sim Configuração de paginação/ordenação do grid valorDeConsulta string Não Texto livre de filtro de busca (padrão vazio) Exemplo de request: “` GET /ReapresentacaoDeChequeDeTerceiro/Listar?valorDeConsulta=12345 “` Exemplo de response: “`json { “total”: 2, “rows”: [ { “…”: “dados da movimentação financeira de devolução do cheque” } ] } “` Internamente, a busca é restrita à filial logada do usuário (`FilialLogada`), à operação financeira “Devolução de Cheque de Terceiro” (código BCODEV1CHT) e à partida de Débito. POST /ReapresentacaoDeChequeDeTerceiro/Salvar Executa a reapresentação de um ou mais cheques de terceiros devolvidos selecionados pelo usuário, gerando uma nova movimentação financeira e, quando aplicável, o lançamento contábil correspondente. Permissão: “ReapresentacaoDeChequeDeTerceiro/Salvar” (ID 3035) Parâmetros: Nome Tipo Obrigatório Descrição dto DTOCabecalhoDeOperacoes Sim Cabeçalho da operação; deve conter a lista `MovimentacoesFinanceiras` (uma ou mais movimentações de devolução de cheque a reapresentar) Exemplo de request: “` POST /ReapresentacaoDeChequeDeTerceiro/Salvar { “MovimentacoesFinanceiras”: [ { “IdDaFilial”: 1, “ChaveDeFato”: 12345, “NumeroDoLancamento”: 1, “DataDeLancamento”: “2026-09-10” } ] } “` Exemplo de response: “`json { “success”: true, “CodigoDaOperacao”: 987654, “listaDeMovimentacaoFinanceira”: [ “…” ], “listaDeOperacoesContabeis”: [ “…” ] } “` Se a lista `MovimentacoesFinanceiras` vier vazia ou nula, a operação é interrompida com a mensagem “Não foi possível Salvar” (ver Regras de Negócio). POST /ReapresentacaoDeChequeDeTerceiro/Imprimir Prepara o arquivo de modelo do comprovante de caixa (“ComprovanteCaixa.rpt”) para impressão, copiando-o do modelo padrão para a pasta do cliente caso ainda não exista. Não executa nenhuma regra de negócio sobre os dados da reapresentação — apenas garante que o arquivo de layout do relatório esteja disponível. Permissão: “ReapresentacaoDeChequeDeTerceiro/Imprimir” (ID 3036) Parâmetros: nenhum. Exemplo de request: “` POST /ReapresentacaoDeChequeDeTerceiro/Imprimir “` Exemplo de response: “`json { “success”: true } “` 03. MODELOS DE DADOS Modelos de Dados DTOCabecalhoDeOperacoes (ATAK.DTO.Financeiro.OperacoesFinanceiras) Campo Tipo Descrição MovimentacoesFinanceiras Lista de DTODeMovimentacaoFinanceira Movimentações de devolução de cheque de terceiro selecionadas para reapresentação DTODeMovimentacaoFinanceira (ATAK.DTO.MovimentacaoDeEntradaESaida.MovimentacoesFinanceiras — reflete a tabela TBMOVTOFIN) Campo Tipo Descrição IdDaFilial Inteiro Filial à qual pertence a movimentação financeira de devolução ChaveDeFato Inteiro Chave do fato contábil/financeiro que identifica a movimentação de devolução original NumeroDoLancamento Inteiro Número do lançamento financeiro da devolução DataDeLancamento Data Data do lançamento financeiro (A movimentação financeira possui ainda dezenas de outros campos padrão do módulo financeiro — valor, cliente/cadastro, tipo de partida, operação financeira — não exclusivos desta rotina.) 04. REGRAS DE NEGÓCIO Regras de Negócio Escopo da listagem restrito à filial e ao tipo de devolução. A ação Listar só traz movimentações da filial logada do usuário, da operação financeira “Devolução de Cheque de Terceiro” (BCODEV1CHT) e da partida Débito — ou seja, apenas cheques de terceiros que já foram devolvidos e ainda não foram reapresentados. A reapresentação só ocorre se houver movimentações selecionadas. Se o usuário tentar salvar sem selecionar nenhuma movimentação, a operação é bloqueada. Mensagem exibida: “Não foi possível Salvar. Os dados informados podem estar incorretos. Verifique se os dados informados estão corretos.” É necessário existir configuração de fato contábil para a operação de reapresentação. A reapresentação gera lançamentos sob a operação “Reapresentação de Cheque de Terceiro” (BCOREAPCHT); se não houver fato contábil configurado para essa operação/variação, a reapresentação é bloqueada. Mensagem exibida: “Não foi possível Reapresentar. É obrigatório informar um fato contábil para a seguinte configuração: Operação: {operação} Variação: {variação}. Informe um fato contábil para operação” A movimentação de devolução original precisa existir e ser válida. Para cada movimentação informada, o sistema localiza a movimentação de devolução original pela filial, chave de fato e número do lançamento. Se ela não for encontrada, o sistema impede a reapresentação: Mensagem exibida: “Não foi possível obter Movimentação de Devolução. Movimentação financeira de devolução do cheque de terceiros não encontrada. Filial: {filial} Chave de fato: {chave de fato} Num. Lançamento: {número do lançamento}. Informe Movimentação financeira de devolução do cheque de terceiros validos para operação” A movimentação de devolução precisa pertencer ao módulo bancário. Caso contrário: Mensagem exibida: “Não foi possível obter Movimentação de Devolução. Movimentação financeira de devolução do cheque de terceiros informada não faz parte do módulo bancário. Filial: {filial} Chave de fato: {chave de fato} Num. Lançamento: {número do lançamento}. Informe Movimentação Financeira que faça parte do módulo bancário” A movimentação de devolução precisa ser da partida Débito. Caso contrário: Mensagem exibida: “Não foi possível obter Movimentação de Devolução. Movimentação financeira de devolução do cheque de terceiros informada não é da partida Débito. Filial: {filial} Chave de fato: {chave de fato} Num. Lançamento: {número do lançamento}. Informe Movimentação de Devolução de partida de débito” A movimentação de devolução precisa ser da operação “Devolução de Cheque de Terceiro” (BCODEV1CHT). Caso contrário: Mensagem exibida: “Não foi possível obter Movimentação de Devolução. Movimentação financeira de devolução do cheque de terceiros informada não é uma operação BCODEV1CHT. Filial: {filial} Chave de fato: {chave de fato} Num. Lançamento: {número do lançamento}. Movimentação de devolução deve ser uma operação BCODEV1CHT” Efeito da reapresentação bem-sucedida. Para cada movimentação validada, o sistema marca a movimentação de devolução original como conciliada e cria uma nova movimentação de débito e outra de crédito sob a operação “Reapresentação de Cheque de Terceiro” (BCOREAPCHT), persistindo cada uma com confirmação de transação (commit) própria. Se todas as movimentações da operação tiverem uma operação financeira definida, o sistema aciona a integração contábil, gerando automaticamente os lançamentos