Fórmulas
Nessa documentação serão disponibilizadas conteúdos técnicos referentes as fórmulas existentes no Módulo Fiscal.
A documentação referente a funcionalidade de Fórmulas foi desenvolvida com o objetivo de explicar detalhadamente todos os tipos de fórmulas disponíveis no sistema, seu objetivo, processos no sistema que fazem uso dela, como também a relação de campos (variáveis) que estão disponíveis para criar as configurações de acordo com o que o município deseja.
As fórmulas estão subdivididas em tipos, de acordo com o objetivo para qual ela será utilizada, sendo eles: Acréscimos, Benefícios fiscais, Validação da substituição de notas, Validação da emissão da nota fiscal, Validação da solicitação de acesso, Validação do cancelamento de notas e Créditos tributários.
Console para configuração da fórmula
O sistema disponibiliza para todos os tipos de fórmula, um console onde é desenvolvido o script da fórmula, que é a lógica contendo as condições e regras necessárias para aplicação da mesma.
Por meio do botão Salvar, é gravado no banco de dados o script da fórmula configurada, e a cada vez que for salvo uma determinada alteração na fórmula, é gerado um histórico das versões do script, que podem ser visualizadas pelo campo Versão, exibindo qual o script vigente mediante item Script Atual, e também as versões dos scripts anteriores, sendo identificados pelos itens contendo a data e hora do histórico.
Ao selecionar uma versão do script diferente do atual, é apresentado o botão Retornar para essa versão, onde uma vez acionado, tornará como script atual o da versão selecionada. É importante ressaltar que ao retornar o script de uma versão anterior tornando-o como atual, o sistema vai exibir no console, mas não irá gravar automaticamente, necessitando para isso clicar no botão Salvar para efetivar o retorno.
Nota: Na tela do console, é apresentado para possibilidade de visualização e de recuperação, o histórico contendo as 10 últimas versões que foram salvas do script.
Também é disponibilizado a opção de Ativar ou Desativar a execução da fórmula, e ao lado dessa opção, a data, hora e o usuário que realizou a última alteração no script da fórmula.
Através do botão Executar, é possível realizar testes de compilação do script atual que está desenvolvido, para que assim, sejam realizadas as validações estruturais e de sintaxe das variáveis utilizadas, de modo que o sistema possa indicar ao usuário que está configurando, se existe algum erro ou não de compilação.
Uma vez que o script é compilado, havendo algum retorno positivo, ou seja, sem erros, o sistema exibe esse retorno na guia LOGS.
Havendo algum erro, é apresentado na guia Erros, a causa e a posição no script onde está a sintaxe incorreta.
Já na guia Variáveis, é onde ficam disponíveis de acordo com o tipo de fórmula, a relação de campos que retornam informações do banco de dados do sistema e-Nota e que podem ser utilizados para criar as condições e regras que devem ser aplicadas pela fórmula.
É importante salientar que fórmulas com problemas de sintaxe o sistema não irá permitir salvar o script, exibindo assim a seguinte mensagem:
Quando a fórmula não possuir nenhum problema, a mesma poderá ser salva e o sistema vai apresentar a seguinte mensagem:
Tipos de fórmulas e suas variáveis
Para cada tipo de fórmula o sistema disponibiliza uma relação de variáveis que são de uso exclusivo do sistema e-Nota, pois retornam informações gravadas no banco de dados do sistema. Porém, para uso em conjunto com o e-Nota, o usuário tem a sua disposição uma relação de outras variáveis e funções que são de uso comum entre os sistemas da suíte Betha, também denominado BFC-Script, e servem para criar as condições lógicas, operações matemáticas, formatação de dados, laços de repetição dentre outras funções. Recomendamos fortemente a leitura da documentação de uso geral do BFC-Script, para ter acesso ao manual clique aqui.
Nota: Na tela do console do script, para adicionar variáveis e/ou funções pressione Ctrl + espaço e selecione uma opção na lista apresentada.
Fórmula de Acréscimos
Nessa fórmula são configurados os cálculos que o sistema deve fazer para gerar os valores dos acréscimos pelo atraso do pagamento da parcela, sendo a correção, o juro e a multa. Essa fórmula será executada em emissões de boletos e consultas do sistema que exibam os acréscimos da guia. Na guia Variáveis do console do script da fórmula estarão disponíveis as seguintes variáveis:
Nome da variável | Descrição de retorno | Tipo de dado |
---|---|---|
situacao | retorna a situação da guia de pagamento com possibilidade de emissão de boleto. Situações possíveis: A - Aberta / U - Abaixo do limite | Caractere |
cpfCnpjPrestador | retorna o CPF/CNPJ do prestador relacionado a guia de pagamento | Caractere |
tipo | Retorna o tipo da guia de pagamento gerada Tipos possíveis: P - Serviços Prestados / T - Serviços Tomados | Caractere |
sistemaOrigem | retorna o sistema que originou a guia de pagamento Sistemas possíveis: NOTA | Caractere |
dhGeracao | retorna a data de geração da guia de pagamento | Data |
dataAtual | retorna a data atual | Data |
dataVencimento | retorna a data de vencimento da guia | Data |
dataVencimentoUnificadora | retorna a data de vencimento da guia principal, quando junto a ela existem guias abaixo do limite unificadas | Data |
parcela | retorna como número da parcela, o mês da data inicial da competência da guia | Numérico |
numeroGuia | retorna o código de identificação da guia no banco de dados | Numérico |
vlSaldoUtilizado | retorna o valor de saldo que foi utilizado na guia gerada | Numérico |
valorGuia | retorna o valor total da guia ((valor do imposto + valor da taxa de expediente) - valor do saldo utilizado). Para guias unificadas, será retornado os valores de forma individualizada entre a guia principal e abaixo do limite. | Numérico |
valorImposto | retorna o valor do ISS calculado na guia. Para guias unificadas, será retornado os valores de forma individualizada entre a guia principal e abaixo do limite. | Numérico |
valorTaxaExpediente | retorna o valor da taxa de expediente calculado na guia. Para guias unificadas, será retornado os valores de forma individualizada entre a guia principal e abaixo do limite. | Numérico |
competencia | retorna informações do cadastro de competências | Objeto |
competencia.descricao | retorna a descrição da competência relacionada a guia | Caractere |
competencia.exercicio | retorna o ano da competência relacionada a guia | Caractere |
competencia.dtInicial | retorna a data inicial da competência relacionada a guia | Data |
competencia.dtFinal | retorna a data final da competência relacionada a guia | Data |
competencia.dtVcto | retorna a data de vencimento da competência relacionada a guia | Data |
IndexadoresUtil.corrente(Sigla) | retorna se o indexador é uma moeda corrente no país conforme a sigla indicada no parâmetro | Função |
IndexadoresUtil.somaIndexador(Sigla, Data inicial, Data final) | retorna a soma de todos os valores relacionados ao indexador conforme sigla, a data inicial e final indicada no parâmetro | Função |
IndexadoresUtil.valorIndexador(Sigla, Data) | retorna o valor do indexador conforme a sigla e a data indicada no parâmetro, ou se não existir valor na data, retorna o valor em data anterior mais próxima a passada no parâmetro | Função |
IndexadoresUtil.valorIndexadorNaData(Sigla, Data) | retorna o valor do indexador conforme a sigla e a data indicada no parâmetro | Função |
IndexadoresUtil.relacaoIndexadores(Sigla, Data inicial, Data final) | retorna uma lista de valores do indexador conforme a sigla e o período indicado no parâmetro | Função |
IndexadoresUtil.relacaoIndexadores(Sigla) | retorna uma lista de valores do indexador conforme a sigla indicada no parâmetro | Função |
DataUtil.ehDiaUtil(Data) | retorna se a data indicada no parâmetro é um dia útil | Função |
DataUtil.isDomingo(Data) | retorna se a data indicada no parâmetro é um domingo | Função |
DataUtil.isSabado(Data) | retorna se a data indicada no parâmetro é um sábado | Função |
DataUtil.ultimoDiaUtil(Data) | retorna o dia útil anterior à data indicada no parâmetro | Função |
DataUtil.proximoDiaUtil(Data) | retorna o próximo dia útil à data indicada no parâmetro | Função |
Feriados.ehFeriado(Data) | retorna se a data indicada no parâmetro, de acordo com o cadastro de feriados do sistema, é feriado | Função |
DataUtil.isFeriado(Data) | retorna se a data indicada no parâmetro, de acordo com o calendário, é feriado | Função |
Nota: Nessa fórmula deve conter obrigatoriamente configurado as seguintes variáveis padrão, para poder ser armazenado e retornado o valor final de cada acréscimo:
retornar: função interna responsável por fazer o retorno dos valores dos acréscimos para as funcionalidades do sistema; valorCorrecao: função integrar responsável por armazenar o valor total de correção; valorJuro: função integrar responsável por armazenar o valor total de juros; valorMulta: função integrar responsável por armazenar o valor total de multa.
Exemplo de aplicabilidade da fórmula:
//Inicio
vlCorrecao= 0.00;
// Dados comuns ao cálculo de Correção, Juro e Multa
dataVcto = dataVencimento;
//Guias Unificadas
se (situacao.equivalente ('U') && situacao.equivalente == 'A'){
dataVcto = dataVencimentoUnificadora
}
// Verifica se é dia útil
percorrer(enquanto:{Feriados.ehFeriado(dataVcto) != 'N'})
{
dataVcto = Datas.adicionaDias(dataVcto, 1)
}
//==============================================
// Fórmula de cálculo da Correção
//==============================================
idxVcto = IndexadoresUtil.valorIndexador("INPC", dataVcto);
idxPgto = IndexadoresUtil.valorIndexador("INPC", dataAtual);
se((situacao.equivalente('A') || situacao.equivalente('T') || situacao.equivalente('U')) && dataVcto < dataAtual && idxVcto != 0)
{
vlCorrecao = Numeros.arredonda(((valorGuia / idxVcto) * idxPgto) - valorGuia, 2);
}
valorAtualizado = valorGuia + vlCorrecao;
//==============================================
// Fórmula de cálculo do Juro
//==============================================
qtdMeses = 0;
vlJuro = 0.00;
w_data_fixa = Datas.data(2019,04,01);
p_vlMulta = 0.00;
qtdMeses = Numeros.teto(Datas.diferencaDias(dataVcto, dataAtual)/30.4375);
se (dataVcto < w_data_fixa) {
se (dataAtual > dataVcto){
vlJuro = Numeros.arredonda(((valorGuia + vlCorrecao) * qtdMeses *0.01) ,2);
}
} senao {
se (dataAtual > dataVcto){
w_data_corr = dataVcto - 1.mes;
w_selic = IndexadoresUtil.somaIndexador("Selic", w_data_corr, dataAtual-1);
se (w_selic > 0) {
w_selic = w_selic + 1;
}
se ((qtdMeses * 0.02) >= 0.2){
p_vlMulta = valorGuia * 0.2;
}
vlJuro = Numeros.arredonda(((valorGuia + p_vlMulta) * (w_selic/100)) ,2);
}
}
//==============================================
// Fórmula de cálculo da Multa
//==============================================
vlMulta = 0.00;
se (dataVcto < w_data_fixa) {
se (dataAtual > dataVcto){
se (qtdMeses >= 5){
percentual = 0.10
}senao{
percentual = 0.02 * qtdMeses;
}
vlMulta = Numeros.arredonda(((valorGuia + vlCorrecao)* percentual),2);
}
} senao {
se ((qtdMeses * 0.02) >= 0.2){
vlMulta = Numeros.arredonda(((valorGuia) * 0.2),2);
} senao {
vlMulta = Numeros.arredonda((valorGuia * (qtdMeses * 0.02)),2);
}
}
//==============================================
retornar valorCorrecao:vlCorrecao, valorJuro:vlJuro, valorMulta:vlMulta;
Fórmula de Benefícios fiscais
Nessa fórmula são configuradas as lógicas que permitem gerar valores de benefícios a serem concedidos para a nota fiscal.
É possível criar script para a concessão de Incentivo Fiscal, a ser aplicado na Alíquota do serviço e na Base de cálculo da nota fiscal, como também no script para Isenção, que é aplicado no valor calculado de ISS da nota fiscal.
O sistema permite registrar diferentes fórmulas de benefício fiscal, porém, cada script poderá conter apenas um tipo de retorno de aplicabilidade, ou seja, se for criado por exemplo um script de incentivo fiscal, este poderá retornar aplicação apenas na alíquota ou apenas na base de cálculo.
Logo, se existir uma lei com possibilidade de aplicação do incentivo fiscal na alíquota e na base de cálculo, será necessário criar duas fórmulas, cada uma com seu respectivo retorno.
Ao criar a fórmula do benefício, é necessário informar uma descrição e também para qual tipo de benefício será criado o script, Incentivo fiscal ou Isenção.
Essa fórmula será relacionada posteriormente ao cadastro de Benefício fiscal quando o mesmo utilizar o script, e é executada em emissões de notas fiscais feitas via tela do sistema, como também pelo processo de conversão de RPS, seja por importação de xml ou pelos envios feitos por webservice. Na guia Variáveis do console do script da fórmula estarão disponíveis as seguintes variáveis:
Variáveis para o script do tipo Incentivo fiscal
Nome da variável | Descrição de retorno | Tipo de dado |
---|---|---|
cnae | retorna o código da CNAE da nota fiscal | Caractere |
nroDocumentoEstrangeiro | retorna o número de identificação do tomador estrangeiro relacionado a nota fiscal | Caractere |
tipoTomador | retorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / E - Estrangeiro | Caractere |
enquadramento | retorna a modalidade do ISS atual do prestador da nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo / H - Homologado / E- Estimado | Caractere |
optanteSimples | retorna o status do prestador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - Não | Caractere |
tipoPessoa | retorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - Jurídica | Caractere |
municipioPrestador | retorna o código IBGE do município no endereço do prestador | Caractere |
municipioTomador | retorna o código IBGE do município no endereço do tomador | Caractere |
itemListaServico | retorna o código do item da lista de serviço da nota fiscal | Caractere |
situacaoTributaria | retorna a situação tributária do ISS da nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributária | Caractere |
servicoPrestadoForaPais | retorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: S - Sim / N - Não | Caractere |
tomadorOptanteSimples | retorna o status do tomador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - Não | Caractere |
inscricaoPrestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
inscricaoTomador | retorna o número do documento de identificação do tomador da nota fiscal (CPF/CNPJ para brasileiros e o número do documento para estrangeiros) | Caractere |
localPrestacaoServico | retorna o código do IBGE do município onde o serviço da nota fiscal foi prestado | Caractere |
servicoDescontadoPrefeitura | retorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: S - Sim / N - Não | Caractere |
dataValidadeFinalBeneficio | retorna a data final da validade registrada para o benefício fiscal | Data |
dataFatoGerador | retorna a data do fato gerador da nota fiscal | Data |
dataValidadeInicialBeneficio | retorna a data inicial da validade registrada para o benefício fiscal | Data |
dataEmissaoRps | retorna a data de emissão do RPS relacionado a nota fiscal | Data |
dataEmissao | retorna a data de emissão da nota fiscal | Data |
incentivoFiscal | retorna o código de cadastro do incentivo fiscal | Numérico |
baseCalculo | retorna a base de cálculo da nota fiscal | Numérico |
naturezaOperacao | retorna a natureza de operação registrada na nota fiscal. Naturezas possíveis: 1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Numérico |
porteEmpresa | retorna o porte da empresa atual do prestador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Numérico |
valorOriginalIssServico | retorna o valor original do ISS calculado no serviço da nota fiscal | Numérico |
codigoNaturezaJuridica | retorna o código da natureza jurídica do tomador da nota fiscal | Numérico |
porteEmpresaTomador | retorna o porte da empresa atual do tomador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Numérico |
aliquota | retorna a alíquota original do serviço da nota fiscal | Numérico |
naturezaJuridica | retorna o código da natureza jurídica do prestador da nota fiscal | Numérico |
Nota: Nessa fórmula, para poder armazenar e retornar o valor do incentivo fiscal calculado para nota fiscal, deve conter configurado as seguintes variáveis padrão do sistema:
retornar: função interna de uso obrigatório, responsável por fazer o retorno do valor do incentivo para as funcionalidades do sistema.
aliquota: função interna de uso obrigatório quando a aplicação do incentivo fiscal for na alíquota, sendo responsável por armazenar e retornar o valor final da alíquota a ser aplicada no serviço da nota.
baseCalculo: função interna de uso obrigatório quando a aplicação do incentivo fiscal for na base de cálculo, sendo responsável por armazenar e retornar o valor final da base de cálculo a ser aplicada no serviço da nota.
Exemplo de aplicabilidade da fórmula:
Na alíquota:
aliq = aliquota
se(cnae == '6311900'){
aliq = aliquota * 0.9;
}
retornar aliquota: aliq;
Na base de cálculo:
base = baseCalculo;
se(naturezaOperacao == 1 && situacaoTributaria == 'N'){
base = baseCalculo * 0.9;
}
retornar baseCalculo: base;
Variáveis para o script do tipo Isenção:
Nome da variável | Descrição de retorno | Tipo de dado |
---|---|---|
cnae | retorna o código da CNAE de cada serviço da nota fiscal | Caractere |
nroDocumentoEstrangeiro | retorna o número de identificação do tomador estrangeiro relacionado a nota fiscal | Caractere |
tipoTomador | retorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / E - Estrangeiro | Caractere |
enquadramento | retorna a modalidade do ISS atual do prestador da nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo H / - HomologadoE- Estimado | Caractere |
optanteSimples | retorna o status do prestador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - Não | Caractere |
tipoPessoa | retorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - Jurídica | Caractere |
municipioPrestador | retorna o código IBGE do município no endereço do prestador | Caractere |
municipioTomador | retorna o código IBGE do município no endereço do tomador | Caractere |
itemListaServico | retorna o código do item da lista de serviço da nota fiscal | Caractere |
situacaoTributaria | retorna a situação tributária do ISS da nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributária / Caractere | |
servicoPrestadoForaPais | retorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: S - Sim / N - Não | Caractere |
tomadorOptanteSimples | retorna o status do tomador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - Não | Caractere |
inscricaoPrestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
inscricaoTomador | retorna o número do documento de identificação do tomador da nota fiscal (CPF/CNPJ para brasileiros e o número do documento para estrangeiros) | Caractere |
localPrestacaoServico | retorna o código do IBGE do município onde o serviço da nota fiscal foi prestado | Caractere |
servicoDescontadoPrefeitura | retorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: S - Sim / N - Não | Caractere |
dataValidadeFinalBeneficio | retorna a data final da validade registrada para o benefício fiscal | Data |
dataFatoGerador | retorna a data do fato gerador da nota fiscal | Data |
dataValidadeInicialBeneficio | retorna a data inicial da validade registrada para o benefício fiscal | Data |
dataEmissaoRps | retorna a data de emissão do RPS relacionado a nota fiscal | Data |
dataEmissao | retorna a data de emissão da nota fiscal | Data |
incentivoFiscal | retorna o código de cadastro do incentivo fiscal | Numérico |
baseCalculo | retorna a base de cálculo da nota fiscal | Numérico |
naturezaOperacao | retorna a natureza de operação registrada na nota fiscal. Naturezas possíveis: 1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Numérico |
porteEmpresa | retorna o porte da empresa atual do prestador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Numérico |
valorOriginalIssServico | retorna o valor original do ISS calculado no serviço da nota fiscal | Numérico |
codigoNaturezaJuridica | retorna o código da natureza jurídica do tomador da nota fiscal | Numérico |
porteEmpresaTomador | retorna o porte da empresa atual do tomador da nota fiscal Portes possíveis: 0 - Não classificada 1 - Microempresa (ME) 2 - Empresa de Pequeno Porte (EPP) 3 - Empresa de Médio Porte (EMP) 4 - Empresa de Grande Porte (EGP) 5 - Microempreendedor Individual (MEI) 6 - EIRELI 7 - Demais | Numérico |
aliquota | retorna a alíquota original do serviço da nota fiscal | Numérico |
naturezaJuridica | retorna o código da natureza jurídica do prestador da nota fiscal | Numérico |
Nota: Nessa fórmula para poder armazenar e retornar o valor da isenção calculada para nota fiscal, deve conter configurado a seguinte variável padrão do sistema:
retornar: função interna de uso obrigatório, responsável por fazer o retorno do valor da isenção para as funcionalidades do sistema.
valorIsencao: função interna de uso obrigatório sendo responsável por armazenar e retornar o valor final da isenção a ser aplicada no ISS do serviço da nota.
Exemplo de aplicabilidade da fórmula:
se(naturezaOperacao == 1 && situacaoTributaria == 'N'){
isencao = valorOriginalIssServico * 0.95;
}
retornar valorIsencao: isencao ;
Exemplo de aplicabilidade da fórmula:
Fórmula da Validação da substituição de notas
Nessa fórmula é configurado as lógicas de validação que permitem bloquear a substituição da nota fiscal. Essa fórmula será executada em funcionalidades realizadas pelo contribuinte, sendo substituições de notas fiscais feitas via tela do sistema, como também pelo processo de conversão de RPS, seja por importação de xml ou pelos envios feitos por webservice. Na guia Variáveis do console do script da fórmula estarão disponíveis as seguintes variáveis:
Nome da variável | Descrição de retorno | Tipo de dado |
---|---|---|
notaFiscalSubstituta | retorna informações das notas fiscais substitutas | Objeto |
notaFiscalSubstituta.iNotas | retornar o número da nota fiscal | Numérico |
notaFiscalSubstituta.optanteSimples | retorna o status em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituta.optanteSimplesTomador | retorna o status do tomador em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituta.porteEmpresaPrestador | retorna o porte da empresa do prestador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituta.porteEmpresaTomador | retorna o porte da empresa do tomador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituta.modalidadeIss | retorna a modalidade do ISS registrada na nota fiscal. Modalidades possíveis: NAO_ENQUADRADO / FIXO / HOMOLOGADO / ESTIMADO | Caractere |
notaFiscalSubstituta.naturezaOperacao | retorna a natureza de operação registrada na nota fiscal. Naturezas possíveis: 1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Caractere |
notaFiscalSubstituta.situacaoTributaria | retorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributária | Caractere |
notaFiscalSubstituta.cpfCnpjPrestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
notaFiscalSubstituta.cpfCnpjTomador | retorna o CPF/CNPJ do tomador da nota fiscal | Caractere |
notaFiscalSubstituta.cpfCnpjIntermediario | retorna o CPF/CNPJ do intermediário da nota fiscal | Caractere |
notaFiscalSubstituta.vlLiquido | retorna o valor líquido calculado na nota fiscal | Numérico |
notaFiscalSubstituta.vlBaseCalculo | retorna o valor total da base de cálculo da nota fiscal | Numérico |
notaFiscalSubstituta.vlTotalIssExibido | retorna o valor total de iss exibido na nota fiscal | Numérico |
notaFiscalSubstituta.vlTotalIssNaoExibido | retorna o valor total de iss não exibido na nota fiscal | Numérico |
notaFiscalSubstituta.rps | retorna o número do RPS da nota fiscal | Numérico |
notaFiscalSubstituta.dhEmissaoRps | retorna a data e hora de emissão do RPS da nota fiscal | Data |
notaFiscalSubstituta.serieRps | retorna a sigla da série de rps da nota fiscal | Caractere |
notaFiscalSubstituta.numeroLoteRps | retorna o número do lote do RPS da nota fiscal | Numérico |
notaFiscalSubstituta.servicoForaDoPais | retorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: true / false | Boolean |
notaFiscalSubstituta.tipoPessoa | retorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: FISICA / JURIDICA | Caractere |
notaFiscalSubstituta.assinada | retorna se a nota fiscal está assinada digitalmente Opções possíveis: true / false | Boolean |
notaFiscalSubstituta.dhEmissao | retorna a data e hora de emissão da nota fiscal | Data |
notaFiscalSubstituta.dhFatoGerador | retorna a data e hora do fato gerador da nota fiscal | Data |
notaFiscalSubstituta.optanteSimplesPrestadorDtFatoGerador | retorna o status em relação a opção do simples nacional do prestador na data do fato gerador da nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituta.porteEmpresaPrestadorDtFatoGerador | retorna o porte da empresa do prestador na data do fato gerador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituta.optanteSimplesAtualTomador | retorna o status atual em relação a opção do simples nacional do tomador da nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituta.porteEmpresaAtualTomador | retorna o porte da empresa atual do tomador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituta.vlTotalServicos | retorna o valor total dos serviços da nota fiscal | Numérico |
notaFiscalSubstituta.competencia.descricao | retorna a descrição da competência da nota fiscal | Caractere |
notaFiscalSubstituta.competencia.exercicio | retorna o ano da competência da nota fiscal | Numérico |
notaFiscalSubstituta.competencia.dtInicial | retorna a data inicial da competência da nota fiscal | Data |
notaFiscalSubstituta.competencia.dtFinal | retorna a data final da competência da nota fiscal | Data |
notaFiscalSubstituta.competencia.dtVcto | retorna a data de vencimento da competência da nota fiscal | |
notaFiscalSubstituta.servicos.aliquota | retorna a alíquota de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituta.servicos.descricao | retorna a descrição do item da lista de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituta.servicos.iCnaes | retorna o código da CNAE de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituta.servicos.iListaServicos | retorna o código do item da lista de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituta.servicos.vlIss | retorna o valor do ISS calculado e exibido de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituta.servicos.vlIssNaoExibido | retorna o valor do ISS calculado e não exibido de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituta.servicos.vlServico | retorna o valor do serviço de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituida | retorna informações das notas fiscais substituídas | Objeto |
notaFiscalSubstituida.iNotas | retornar o número da nota fiscal | Numérico |
notaFiscalSubstituida.optanteSimples | retorna o status em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.optanteSimplesTomador | retorna o status do tomador em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.porteEmpresaPrestador | retorna o porte da empresa do prestador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituida.porteEmpresaTomador | retorna o porte da empresa do tomador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituida.modalidadeIss | retorna a modalidade do ISS registrada na nota fiscal. Modalidades possíveis: NAO_ENQUADRADO / FIXO / HOMOLOGADO / ESTIMADO | Caractere |
notaFiscalSubstituida.naturezaOperacao | retorna a natureza de operação registrada na nota fiscal. Naturezas possíveis: 1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Caractere |
notaFiscalSubstituida.situacaoTributaria | retorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributária | Caractere |
notaFiscalSubstituida.cpfCnpjPrestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
notaFiscalSubstituida.cpfCnpjTomador | retorna o CPF/CNPJ do tomador da nota fiscal | Caractere |
notaFiscalSubstituida.cpfCnpjIntermediario | retorna o CPF/CNPJ do intermediário da nota fiscal | Caractere |
notaFiscalSubstituida.vlLiquido | retorna o valor líquido calculado na nota fiscal | Numérico |
notaFiscalSubstituida.vlBaseCalculo | retorna o valor total da base de cálculo da nota fiscal | Numérico |
notaFiscalSubstituida.vlTotalIssExibido | retorna o valor total de iss exibido na nota fiscal | Numérico |
notaFiscalSubstituida.vlTotalIssNaoExibido | notaFiscalSubstituida.vlTotalIssNaoExibido | Numérico |
notaFiscalSubstituida.rps | retorna o número do RPS da nota fiscal | Numérico |
notaFiscalSubstituida.dhEmissaoRps | retorna a data e hora de emissão do RPS da nota fiscal | Data |
notaFiscalSubstituida.serieRps | retorna a sigla da série de rps da nota fiscal | Caractere |
notaFiscalSubstituida.numeroLoteRps | retorna o número do lote do RPS da nota fiscal | Numérico |
notaFiscalSubstituida.servicoForaDoPais | retorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.tipoPessoa | retorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: FISICA / JURIDICA | Caractere |
notaFiscalSubstituida.assinada | retorna se a nota fiscal está assinada digitalmente Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.dhEmissao | retorna a data e hora de emissão da nota fiscal | Data |
notaFiscalSubstituida.dhFatoGerador | retorna a data e hora do fato gerador da nota fiscal | Data |
notaFiscalSubstituida.optanteSimplesPrestadorDtFatoGerador | retorna o status em relação a opção do simples nacional do prestador na data do fato gerador da nota fiscal Opções possíveis: true false | Boolean |
notaFiscalSubstituida.porteEmpresaPrestadorDtFatoGerador | retorna o porte da empresa do prestador na data do fato gerador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituida.optanteSimplesAtualTomador | retorna o status atual em relação a opção do simples nacional do tomador da nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.porteEmpresaAtualTomador | retorna o porte da empresa atual do tomador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituida.vlTotalServicos | retorna o valor total dos serviços da nota fiscal | Numérico |
notaFiscalSubstituida.competencia.descricao | retorna a descrição da competência da nota fiscal | Caractere |
notaFiscalSubstituida.competencia.exercicio | retorna o ano da competência da nota fiscal | Numérico |
notaFiscalSubstituida.competencia.dtInicial | notaFiscalSubstituida.competencia.dtInicial | Data |
notaFiscalSubstituida.competencia.dtFinal | retorna a data final da competência da nota fiscal | Data |
notaFiscalSubstituida.competencia.dtVcto | retorna a data de vencimento da competência da nota fiscal | |
notaFiscalSubstituta.servicos.aliquota | notaFiscalSubstituta.servicos.aliquota | Numérico |
notaFiscalSubstituta.servicos.descricao | retorna a descrição do item da lista de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituta.servicos.iCnaes | retorna o código da CNAE de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituta.servicos.iListaServicos | retorna o código do item da lista de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituta.servicos.vlIss | retorna o valor do ISS calculado e exibido de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituta.servicos.vlIssNaoExibido | retorna o valor do ISS calculado e não exibido de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituta.servicos.vlServico | retorna o valor do serviço de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituida | retorna informações das notas fiscais substituídas | Objeto |
notaFiscalSubstituida.iNotas | retornar o número da nota fiscal | Numérico |
notaFiscalSubstituida.optanteSimples | retorna o status em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.optanteSimplesTomador | retorna o status do tomador em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.porteEmpresaPrestador | retorna o porte da empresa do prestador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituida.porteEmpresaTomador | retorna o porte da empresa do tomador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituida.modalidadeIss | retorna a modalidade do ISS registrada na nota fiscal. Modalidades possíveis: NAO_ENQUADRADO / FIXO / HOMOLOGADO / ESTIMADO | Caractere |
notaFiscalSubstituida.naturezaOperacao | retorna a natureza de operação registrada na nota fiscal. Naturezas possíveis: 1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Caractere |
notaFiscalSubstituida.situacaoTributaria | retorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributária | Caractere |
notaFiscalSubstituida.cpfCnpjPrestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
notaFiscalSubstituida.cpfCnpjTomador | retorna o CPF/CNPJ do tomador da nota fiscal | Caractere |
notaFiscalSubstituida.cpfCnpjIntermediario | retorna o CPF/CNPJ do intermediário da nota fiscal | Caractere |
notaFiscalSubstituida.vlLiquido | retorna o valor líquido calculado na nota fiscal | Numérico |
notaFiscalSubstituida.vlBaseCalculo | retorna o valor total da base de cálculo da nota fiscal | Numérico |
notaFiscalSubstituida.vlTotalIssExibido | retorna o valor total de iss exibido na nota fiscal | Numérico |
notaFiscalSubstituida.vlTotalIssNaoExibido | retorna o valor total de iss não exibido na nota fiscal | Numérico |
notaFiscalSubstituida.rps | retorna o número do RPS da nota fiscal | Numérico |
notaFiscalSubstituida.dhEmissaoRps | retorna a data e hora de emissão do RPS da nota fiscal | Data |
notaFiscalSubstituida.serieRps | retorna a sigla da série de rps da nota fiscal | Caractere |
notaFiscalSubstituida.numeroLoteRps | retorna o número do lote do RPS da nota fiscal | Numérico |
notaFiscalSubstituida.servicoForaDoPais | retorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.tipoPessoa | retorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: FISICA / JURIDICA | Caractere |
notaFiscalSubstituida.assinada | retorna se a nota fiscal está assinada digitalmente Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.dhEmissao | retorna a data e hora de emissão da nota fiscal | Data |
notaFiscalSubstituida.dhFatoGerador | retorna a data e hora do fato gerador da nota fiscal | Data |
notaFiscalSubstituida.optanteSimplesPrestadorDtFatoGerador | retorna o status em relação a opção do simples nacional do prestador na data do fato gerador da nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.porteEmpresaPrestadorDtFatoGerador | retorna o porte da empresa do prestador na data do fato gerador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituida.optanteSimplesAtualTomador | retorna o status atual em relação a opção do simples nacional do tomador da nota fiscal Opções possíveis: true / false | Boolean |
notaFiscalSubstituida.porteEmpresaAtualTomador | retorna o porte da empresa atual do tomador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalSubstituida.vlTotalServicos | retorna o valor total dos serviços da nota fiscal | Numérico |
notaFiscalSubstituida.competencia.descricao | retorna a descrição da competência da nota fiscal | Caractere |
notaFiscalSubstituida.competencia.exercicio | retorna o ano da competência da nota fiscal | Numérico |
notaFiscalSubstituida.competencia.dtInicial | retorna a data inicial da competência da nota fiscal | Data |
notaFiscalSubstituida.competencia.dtFinal | retorna a data final da competência da nota fiscal | Data |
notaFiscalSubstituida.competencia.dtVcto | retorna a data de vencimento da competência da nota fiscal | |
notaFiscalSubstituida.servicos.aliquota | retorna a alíquota de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituida.servicos.descricao | retorna a descrição do item da lista de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituida.servicos.iCnaes | retorna o código da CNAE de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituida.servicos.iListaServicos | retorna o código do item da lista de cada serviço da nota fiscal | Caractere |
notaFiscalSubstituida.servicos.vlIss | retorna o valor do ISS calculado e exibido de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituida.servicos.vlIssNaoExibido | retorna o valor do ISS calculado e não exibido de cada serviço da nota fiscal | Numérico |
notaFiscalSubstituida.servicos.vlServico | retorna o valor do serviço de cada serviço da nota fiscal | Numérico |
Nota: Nessa fórmula para poder bloquear o processo de substituição, deve ser utilizado a variável interna suspender no retorno final da fórmula.
Exemplo de aplicabilidade da fórmula:
se(notaFiscalSubstituta.cpfCnpjTomador != notaFiscalSubstituida.cpfCnpjTomador){
suspender 'Não poderá ser substituída notas fiscais com tomadores diferentes!'
}
Fórmula da Validação da emissão da nota fiscal
Nessa fórmula são configuradas as lógicas de validação que permitem bloquear a emissão da nota fiscal. Essa fórmula será executada em emissões de notas fiscais feitas via tela do sistema, como também pelo processo de conversão de RPS, seja por importação de xml ou pelos envios feitos por webservice. Na guia Variáveis do console do script da fórmula estarão disponíveis as seguintes variáveis:
Nome da variável | Descrição de retorno | Tipo de dado |
---|---|---|
tomadorForaMunicipio | retorna se o tomador da nota fiscal é domiciliado em município diferente ao do emissor da nota fiscal Opções possíveis: true / false | Boolean |
serieRPS | retorna a sigla da série de rps da nota fiscal | Caractere |
art | retorna o número da ART informado na nota fiscal | Caractere |
cepTomador | retorna o CEP do endereço do tomador da nota fiscal | Caractere |
nomeFantasiaTomador | retorna o nome fantasia do tomador da nota fiscal | Caractere |
discriminacaoServico | retorna a discriminação do serviço da nota fiscal. OBS: Não usar essa variável quando puder informar mais de um serviço na nota | Caractere |
nomeUsuario | retorna o nome do usuário da Central de Usuários Betha que foi o emissor da nota fiscal | Caractere |
logradouro | retorna o nome do logradouro no endereço do tomador da nota fiscal | Caractere |
inscricaoIntermediario | retorna o CPF/CNPJ do intermediário da nota fiscal | Caractere |
utilizaAliqMunicipal | retorna se o prestador da nota fiscal vai tributar utilizando alíquota municipal Opções possíveis: S - Sim / N - Não | Caractere |
imune | retorna se o prestador da nota fiscal está configurado em seu cadastro como imune Opções possíveis: S - Sim / N - Não | Caractere |
enquadPrestador | retorna a modalidade do ISS atual do prestador da nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo / H - Homologado / E- Estimado | Caractere |
RPSAutorizado | retorna se o número do RPS informado na nota fiscal está autorizado para emissão de nota Opções possíveis: S - Sim / N - Não | Caractere |
descontadoPrefeitura | retorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: S - Sim / N - Não | Caractere |
nomeIntermediario | retorna o nome do intermediário da nota fiscal | Caractere |
municipioPrestador | retorna o código do IBGE do município onde o prestador da nota fiscal está domiciliado | Caractere |
situacaoTributaria | retorna a situação tributária do ISS da nota fiscal Situações possíveis: N - Normal / R - Retida / S - Substituição tributária | Caractere |
pisPasep | retorna o número do PIS/PASEP do prestador da nota fiscal | Caractere |
inscricaoMunicipalIntermediario | retorna o número da inscrição municipal do intermediário da nota fiscal | Caractere |
bairro | retorna o nome do bairro no endereço do tomador da nota fiscal | Caractere |
obrigaCnae | retorna se o prestador é obrigado a informar a CNAE no serviço da nota fiscal | Caractere |
inscricaoMunicipalPrestador | retorna o número da inscrição municipal do prestador da nota fiscal | Caractere |
obra | retorna o número da Obra informado na nota fiscal | Caractere |
prestadorSubstituto | retorna se o prestador da nota fiscal está configurado em seu cadastro como substituto tributário Opções possíveis: S - Sim / N - Não | Caractere |
emitidaPor | retorna por qual processo a nota fiscal está sendo emitida pelo prestador Opções possíveis:1 - Importação de RPS / 2 - Tela de emissão do sistema (site) | Caractere |
optanteSimples | retorna o status atual do prestador da nota fiscal em relação a opção do simples nacional Opções possíveis: Sim / Não | Caractere |
tomador | retorna o CPF/CNPJ do tomador da nota fiscal | Caractere |
paisTomador | retorna o código do BACEN do país onde o tomador da nota fiscal está domiciliado | Caractere |
telefone | retorna o número do telefone fixo do tomador da nota fiscal | Caractere |
estrangeiro | retorna se o tomador da nota fiscal é estrangeiro Opções possíveis: Sim / Não | Caractere |
numero | retorna o número residencial no endereço do tomador da nota fiscal | Caractere |
tipoPessoaTomador | retorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / O - Outros / E - Estrangeiro | Caractere |
rpsForaDoPrazo | retorna se o RPS relacionado a nota fiscal foi convertido fora do prazo Opções possíveis: Sim / Não | Caractere |
idUsuario | retorna o login do usuário da Central de Usuários Betha que foi o emissor da nota fiscal | Caractere |
nomeTomador | retorna o nome do tomador da nota fiscal | Caractere |
nomePrestador | retorna o nome do prestador da nota fiscal | Caractere |
municipioTomador | retorna o código do IBGE do município onde o tomador da nota fiscal está domiciliado | Caractere |
municipioEntidade | retorna o código do IBGE do município gerador da nota fiscal | Caractere |
prestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
tipoPessoaPrestador | retorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / O - Outros | Caractere |
servicoPrestadoForaPais | retorna se o serviço da nota fiscal foi prestado fora do país Opções possíveis: Sim / Não | Caractere |
nroProcessoSuspensao | retorna o número do processo de suspensão informado na nota fiscal | Caractere |
outrasInformacoes | retorna a descrição das observações informadas na nota fiscal | Caractere |
retorna o e-mail do tomador da nota fiscal | Caractere | |
celular | retorna o telefone celular do tomador da nota fiscal | Caractere |
localPrestacaoServico | retorna o código do IBGE do município onde o serviço da nota fiscal foi prestado | Caractere |
dataFatoGerador | retorna a data e hora do fato gerador da nota fiscal | Data |
dataEmissaoPisPasep | retorna a data de emissão do PIS/PASEP do prestador da nota fiscal | Data |
dataEmissaoRPS | retorna a data e hora de emissão do RPS convertido em nota fiscal | Data |
dataEmissao | retorna a data e hora de emissão da nota fiscal | Data |
valorLiquido | retorna o valor líquido calculado da nota fiscal | Numérico |
outrasRetencoes | retorna o valor calculado dos tributos federais da nota fiscal para outras retenções | Numérico |
baseCalculo | retorna o valor total da base de cálculo da nota fiscal | Numérico |
valorServico | retorna o valor total de serviços da nota fiscal | Numérico |
naturezaOperacao | retorna a natureza de operação da nota fiscal Naturezas possíveis: 1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Numérico |
numeroNota | retorna o número da nota fiscal | Numérico |
csll | retorna o valor calculado dos tributos federais da nota fiscal para csll | Numérico |
pis_pasep | retorna o valor calculado dos tributos federais da nota fiscal para pis/pasep | Numérico |
valorDescIncondicional | retorna o valor total calculado para o desconto incondicional da nota fiscal | Numérico |
aliquota | retorna a alíquota do serviço da nota fiscal OBS: Não usar essa variável quando puder informar mais de um serviço na nota | Numérico |
ir | retorna o valor calculado dos tributos federais da nota fiscal para imposto de renda | Numérico |
valorDeducao | retorna o valor total calculado de dedução da nota fiscal | Numérico |
inss | retorna o valor calculado dos tributos federais da nota fiscal para inss | Numérico |
loteRPS | retorna o número do lote de rps convertido em nota fiscal | Numérico |
portePrestador | retorna o porte da empresa atual do prestador da nota fiscal Portes possíveis:0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte / (EMP) 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Numérico |
valorISS | retorna o valor total calculado de ISS da nota fiscal | Numérico |
cofins | retorna o valor calculado dos tributos federais da nota fiscal para cofins | Numérico |
naturezaJuridicaTomador | retorna o código da natureza jurídica do tomador da nota fiscal | Numérico |
valorDescCondicional | retorna o valor total calculado para o desconto condicionado da nota fiscal | Numérico |
numeroRPS | retorna o número do RPS convertido em nota fiscal | Numérico |
naturezaJuridica | retorna o código da natureza jurídica do prestador da nota fiscal | Numérico |
notaFiscalServico | retorna as informações da relação dos serviços relacionados a nota fiscal | Listagem |
notaFiscalServico.descricao | retorna a discriminação informada para item da lista de serviços da nota fiscal | Caractere |
notaFiscalServico.vlServico | retorna o valor total do serviço para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.vlDeducao | retorna o valor de dedução para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.vlDescIncondicional | retorna o valor do desconto incondicionado para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.vlDescCondicional | retorna o valor do desconto condicionado para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.vlBaseCalculo | retorna o valor da base de cálculo para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.aliquota | retorna a alíquota efetiva para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.vlIss | retorna o valor calculado de ISS de prestadores não optantes do simples nacional, ou se optantes, que utilizam alíquota municipal, para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.valorUnitario | retorna o valor unitário do serviço para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.qtdServico | retorna a quantidade de serviço para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.vlIssOptante | retorna o valor calculado de ISS de prestadores optantes do simples nacional para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.aliqIbptFederal | retorna a alíquota federal do IBPT configurada para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.aliqIbptEstadual | retorna a alíquota estadual do IBPT configurada para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.aliqIbptMunicipal | retorna a alíquota municipal do IBPT configurada para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.descricaoCnae | retorna a descrição da CNAE relacionada a cada item da lista de serviços da nota fiscal | Caractere |
notaFiscalServico.aliquotaEspecifica | retorna a alíquota específica configurada para o prestador para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.paisServico | retorna o código do BACEN do país onde o serviço da nota fiscal foi prestado | Caractere |
notaFiscalServico.IListaServicos | retorna o código do item da lista de serviço da nota fiscal | Caractere |
notaFiscalServico.IMunicipios | retorna o código do IBGE do município onde o serviço da nota fiscal foi prestado | Caractere |
notaFiscalServico.ICnaes | retorna o código da CNAE relacionada a cada item da lista de serviço da nota fiscal | Caractere |
notaFiscalServico.listasServicos | retorna informações do cadastro da lista de serviços para a relação de itens da lista relacionado a nota fiscal | Listagem |
notaFiscalServico.listasServicos.descricao | retorna a descrição de cada item da lista da nota fiscal | Caractere |
notaFiscalServico.listasServicos.aliquota | retorna a alíquota configurada para cada item da lista de serviços | Numérico |
notaFiscalServico.listasServicos.incideSubstituicaoTributaria | retorna se o item da lista de serviço está configurado para incidir substituição tributária Opções possíveis: Sim Não | Caractere |
notaFiscalServico.listasServicos.issDevidoLocalPrestacao | retorna se o item da lista de serviço está configurado para o ISS ser devido no local da prestação do serviço Opções possíveis: Sim / Não | Caractere |
dadosPrestador | retorna informações do cadastro de pessoas do prestador | Objeto |
dadosPrestador.nomeSocialFantasia | retorna o nome social/fantasia do prestador da nota fiscal | Caractere |
dadosPrestador.inscricaoEstadual | retorna o número da inscrição estadual do prestador da nota fiscal | Caractere |
dadosPrestador.cep | retorna o CEP no endereço principal do prestador da nota fiscal | Caractere |
dadosPrestador.bairro | retorna o nome do bairro no endereço principal do prestador da nota fiscal | Caractere |
dadosPrestador.logradouro | retorna o nome do logradouro no endereço principal do prestador da nota fiscal | Caractere |
dadosPrestador.numero | retorna o número predial no endereço principal do prestador da nota fiscal | Caractere |
dadosPrestador.complemento | retorna o complemento no endereço principal do prestador da nota fiscal | Caractere |
dadosPrestador.estado | retorna a UF do estado no endereço principal do prestador da nota fiscal | Caractere |
dadosPrestador.email | retorna o e-mail principal do prestador da nota fiscal | Caractere |
dadosPrestador.site | retorna o site do prestador da nota fiscal | Caractere |
dadosPrestador.telefone | retorna o número do telefone fixo principal do prestador da nota fiscal | Caractere |
dadosPrestador.celular | retorna o número do telefone celular principal do prestador da nota fiscal | Caractere |
competencia | retorna as informações do cadastro de competências relacionada a nota fiscal | Objeto |
competencia.descricao | retorna a descrição da competência relacionada a nota fiscal | Caractere |
competencia.dtInicial | retorna a data inicial da competência relacionada a nota fiscal | Data |
competencia.dtFinal | retorna a data final da competência relacionada a nota fiscal | Data |
competencia.dtVcto | retorna a data de vencimento da competência relacionada a nota fiscal | Data |
dadosTomador | retorna informações do cadastro do tomador da nota fiscal | Objeto |
dadosTomador.inscricaoMunicipal | retorna o número da inscrição municipal do tomador da nota fiscal | Caractere |
dadosTomador.inscricaoEstadual | retorna o número da inscrição estadual do tomador da nota fiscal | Caractere |
dadosTomador.site | retorna o site do tomador da nota fiscal | Caractere |
dadosTomador.complemento | retorna o complemento no endereço do tomador da nota fiscal | Caractere |
dadosTomador.uf | retorna a UF do estado no endereço do tomador da nota fiscal | Caractere |
dadosTomador.municipioEstrangeiro | retorna o nome do município estrangeiro no endereço do tomador da nota fiscal | Caractere |
dadosTomador.optanteSimples | retorna o status atual do tomador da nota fiscal em relação a opção do simples nacional Opções possíveis: Sim / Não | Caractere |
dadosTomador.porteEmpresa | retorna o porte da empresa atual do tomador da nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
condicoesPagamento | retorna informações da relação das condições de pagamento relacionadas a nota fiscal | Listagem |
condicoesPagamento.tipo | retorna o tipo da condição de pagamento da nota fiscal Tipos possíveis: | Caractere |
condicoesPagamento.totalParcelas | retorna o total de parcelas da condição de pagamento para cada tipo de condição informado na nota fiscal | Numérico |
condicoesPagamento.baseCalculo | retorna o valor da base de cálculo da condição de pagamento para cada tipo de condição informado na nota fiscal | Numérico |
condicoesPagamento.parcela | retorna o número da parcela da condição de pagamento para cada tipo de condição informado na nota fiscal | Numérico |
condicoesPagamento.vencimento | retorna o vencimento da parcela da condição de pagamento para cada tipo de condição informado na nota fiscal | Data |
condicoesPagamento.valor | retorna o valor da parcela da condição de pagamento para cada tipo de condição informado na nota fiscal | Numérico |
dadosTributosFederais | retorna as informações das alíquotas calculadas para os tributos federais | Objeto |
dadosTributosFederais.vlAliquotaPis | retorna a alíquota calculada na nota fiscal para o PIS | Numérico |
dadosTributosFederais.vlAliquotaCofins | retorna a alíquota calculada na nota fiscal para o Cofins | Numérico |
dadosTributosFederais.vlAliquotaInss | retorna a alíquota calculada na nota fiscal para o INSS | Numérico |
dadosTributosFederais.vlAliquotaIr | retorna a alíquota calculada na nota fiscal para o Imposto de renda | Numérico |
dadosTributosFederais.vlAliquotaCsll | retorna a alíquota calculada na nota fiscal para a CSLL | Numérico |
dadosTributosFederais.vlAliquotaOutras | retorna a alíquota calculada na nota fiscal para outros tributos | Numérico |
emails | retorna informações dos destinatários da nota fiscal | Listagem |
emails.destinatario | retorna a relação dos e-mails destinatários da nota fiscal |
Nota: Nessa fórmula para poder bloquear o processo de emissão da nota, deve ser utilizado a variável interna suspender no retorno final da fórmula.
Exemplo de aplicabilidade da fórmula:
se(situacaoTributaria == 'R' && tipoPessoaTomador != 'J'){
suspender ‘Não é permitido emitir a nota com Situação Tributária Retida para tomador pessoa
física.'
}
Fórmula da Validação da solicitação de acesso
Nessa fórmula são configuradas as lógicas de validação que permitem bloquear o prestador de solicitar acesso ao sistema e-Nota. Essa fórmula será executada na funcionalidade Solicitação de Acesso disponível na página públicada do sistema. Na guia Variáveis do console do script da fórmula estarão disponíveis as seguintes variáveis:
Nome da variável | Descrição de retorno | Tipo de dado |
---|---|---|
optanteSimples | retorna o status atual do contribuinte na solicitação de acesso em relação a opção do simples nacional Opções possíveis: true / false | Boolean |
contemAnexo | retorna o status da solicitação de acesso em relação a conter anexo vinculado Opções possíveis: true / false | Boolean |
contribuinteExiste | retorna se o CPF/CNPJ do contribuinte informado na solicitação, está registrado no Cadastro de Contribuintes do e-nota para a entidade cujo solicitação está sendo feita Opções possíveis: true / false | Boolean |
faxContribuinte | retorna o número do Fax do contribuinte na solicitação de acesso | Caractere |
numeroPredialContribuinte | retorna o número predial do endereço do contribuinte na solicitação de acesso | Caractere |
inscricaoMunicipal | retorna o número da inscrição municipal do contribuinte na solicitação de acesso | Caractere |
inscricaoEstadual | retorna o número da inscrição estadual do contribuinte na solicitação de acesso | Caractere |
cpfCnpj | retorna o CPF/CNPJ do contribuinte na solicitação de acesso | Caractere |
nomeSocial | retorna o nome social do contribuinte na solicitação de acesso | Caractere |
siteContribuinte | retorna o site do contribuinte na solicitação de acesso | Caractere |
observacaoSolicitacao | retorna a descrição da observação informada na solicitação de acesso | Caractere |
razaoSocial | retorna a razão social do contribuinte na solicitação de acesso | Caractere |
telefoneFixoContribuinte | retorna o número do telefone fixo do contribuinte na solicitação de acesso | Caractere |
celularContribuinte | retorna o número do telefone celular do contribuinte na solicitação de acesso | Caractere |
emailContribuinte | retorna o e-mail do contribuinte na solicitação de acesso | Caractere |
cepContribuinte | retorna o CEP do endereço do contribuinte na solicitação de acesso | Caractere |
bairroContribuinte | retorna o nome do bairro do endereço do contribuinte na solicitação de acesso | Caractere |
complementoEnderecoContribuinte | retorna o complemento do endereço do contribuinte na solicitação de acesso | Caractere |
nomeFantasia | retorna o nome fantasia do contribuinte na solicitação de acesso | Caractere |
logradouroContribuinte | retorna o nome do logradouro do endereço do contribuinte na solicitação de acesso | Caractere |
dataCadastro | retorna a data de cadastro da solicitação de acesso | Data |
municipioContribuinte | retorna o código IBGE do município no endereço do contribuinte da solicitação de acesso | Numérico |
perfil | retorna o tipo do perfil de acesso informado pelo contribuinte na solicitação de acesso Tipos possíveis: 0 - Prestador / 1 - Tomador | Numérico |
porteEmpresa | retorna o porte da empresa do contribuinte na solicitação de acesso Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Numérico |
quantidadeAnexos | retorna a quantidade de anexos relacionados a solicitação de acesso | Numérico |
tipoPessoa | retorna o tipo da pessoa do contribuinte na solicitação de acesso Tipos possíveis: 0 - Física / 1 - Jurídica | Numérico |
modalidadeIss | retorna a modalidade do ISS atual do contribuinte na solicitação de acesso. Modalidades possíveis: 0 - Não enquadrado / 1 - Fixo / 2 - Homologado / 3 - Estimado | Numérico |
Nota: Nessa fórmula para poder bloquear o processo de solicitação de acesso ao sistema, deve ser utilizado a variável interna suspender no retorno final da fórmula.
Exemplo de aplicabilidade da fórmula:
se(perfil == 1){
suspender 'Nessa entidade apenas solicitações de acesso para o perfil Prestador poderá ser registrada!'}
Fórmula da Validação do cancelamento de notas
Nessa fórmula são configuradas as lógicas de validação que permitem bloquear o cancelamento da nota fiscal pelo prestador. Essa fórmula será executada em processos efetuados pelo prestador, via tela do sistema na funcionalidade Cancelar nota e também em cancelamentos realizados via WebServices. Na guia Variáveis do console do script da fórmula estarão disponíveis as seguintes variáveis:
Nome da variável | Descrição de retorno | Tipo de dado |
---|---|---|
prestadorOptanteSimples | retorna o status do prestador na nota fiscal em relação a opção do simples nacional Opções possíveis: true / false | Boolean |
descontadoPrefeitura | retorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: true / false | Boolean |
servicoPrestadoForaPais | retorna se o serviço da nota fiscal foi prestado fora do país Opções possíveis: true / false | Boolean |
notaAssinadaDigitalmente | retorna se a nota fiscal está assinada digitalmente Opções possíveis: true / false | Boolean |
tomadorOptanteSimples | retorna o status do tomador na nota fiscal em relação a opção do simples nacional Opções possíveis: true false | Boolean |
cpfCnpjPrestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
serieRPS | retorna a sigla da série do RPS da nota fiscal | Caractere |
emailTomador | retorna o e-mail do tomador na nota fiscal | Caractere |
documentoTomador | retorna o CPF/CNPJ para tomadores brasileiros e o número do documento de identificação para tomadores estrangeiros | Caractere |
situacaoTributaria | retorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributária | Caractere |
tipoPessoaPrestador | etorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física J - Jurídica | Caractere |
modalidadeIssPrestador | retorna a modalidade do ISS do prestador na nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo / H - Homologado / E- Estimado | Caractere |
cpfCnpjIntermediario | retorna o CPF/CNPJ do intermediário da nota fiscal | Caractere |
dataFatoGerador | retorna a data e hora do fato gerador da nota fiscal | Data |
dataEmissaoRPS | retorna a data e hora de emissão do RPS da nota fiscal | Data |
dataCancelamento | retorna a data e hora do cancelamento da nota fiscal | Data |
dataEmissao | retorna a data e hora de emissão da nota fiscal | Data |
porteTomador | retorna o porte da empresa do tomador na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI/ 7 - Demais | Numérico |
valorLiquido | retorna o valor líquido da nota fiscal | Numérico |
baseCalculo | retorna o valor total da base de cálculo da nota fiscal | Numérico |
valorServico | retorna o valor total do serviço da nota fiscal | Numérico |
naturezaOperacao | retorna a natureza de operação registrada na nota fiscal. Naturezas possíveis: 1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Numérico |
valorIssExibido | retorna o valor total de iss exibido na nota fiscal | Numérico |
portePrestador | retorna o porte da empresa do prestador na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Numérico |
loteRPS | retorna o número do lote de RPS da nota fiscal | Numérico |
numeroNota | retorna o número do lote de RPS da nota fiscal | Numérico |
numeroNota | retorna o número da nota fiscal | Numérico |
numeroRPS | retorna o número do RPS da nota fiscal | Numérico |
valorIssNaoExibido | retorna o valor total de iss não exibido na nota fiscal | Numérico |
servicos | retorna as informações da relação dos serviços da nota fiscal | Listagem |
servicos.codigoServico | retorna o código do item da lista de serviço da nota fiscal | Caractere |
servicos.descricao | retorna a descrição do item da lista de serviço da nota fiscal | Caractere |
servicos.aliquota | retorna a alíquota do item da lista de serviço da nota fiscal | Numérico |
servicos.cnae | retorna o código da CNAE relacionada ao item da lista de serviço da nota fiscal | Caractere |
servicos.vlTotalServico | retorna o valor total do serviço para o item da lista da nota fiscal | Numérico |
servicos.vlBaseCalculo | retorna o valor da base de cálculo para o item da lista da nota fiscal | Numérico |
servicos.vlIssExibido | retorna o valor calculado do ISS exibido na nota para o item da lista | Numérico |
servicos.vlIssNaoExibido | retorna o valor calculado do ISS não exibido na nota para o item da lista | Numérico |
competencia | retorna as informações do cadastro de competências que está relacionada a nota fiscal | Objeto |
competencia.descricao | retorna a descrição da competência relacionada a nota fiscal | Caractere |
competencia.dtInicial | retorna a data inicial da competência relacionada a nota fiscal | Data |
competencia.dtFinal | retorna a data final da competência relacionada a nota fiscal | Data |
competencia.dtVcto | retorna a data de vencimento da competência relacionada a fiscal | Data |
Nota: Nessa fórmula para poder bloquear o cancelamento da nota fiscal pelo prestador, deve ser utilizada a variável interna suspender no retorno final da fórmula.
Exemplo de aplicabilidade da fórmula:
se(prestadorOptanteSimples == true){
suspender 'Nota Fiscal não pode ser cancelada!'
}
Fórmula de créditos tributários
Nessa fórmula são configuradas as lógicas que permitem gerar o valor do crédito tributário para a nota fiscal emitida. Essa fórmula será executada em emissões de notas fiscais feitas via tela do sistema, como também pelo processo de conversão de RPS, seja por importação de xml ou pelos envios feitos por webservice, e ainda, pelo processo de geração de crédito tributário realizado pelo módulo fiscal. Na guia Variáveis do console do script da fórmula estarão disponíveis as seguintes variáveis:
Nome da variável | Descrição de retorno | Tipo de dado |
---|---|---|
serieRPS | retorna a sigla da série de rps da nota fiscal | Caractere |
art | retorna o número da ART da nota fiscal | Caractere |
inscricaoMunicipalTomador | retorna o número da inscrição municipal do tomador da nota fiscal | Caractere |
pago | retorna o status da guia de pagamento o qual a nota fiscal está relacionada, se está paga Status possíveis: S - Sim / N - Não | Caractere |
municipioServico | retorna o código do IBGE do município onde o serviço da nota fiscal foi prestado | Caractere |
prestadorImune | retorna se o prestador da nota fiscal está configurado em seu cadastro como imune Opções possíveis: S - Sim / N - Não | Caractere |
inscricaoIntermediario | retorna o CPF/CNPJ do intermediário da nota fiscal | Caractere |
situacaoNota | retorna a situação atual da nota fiscal Situações possíveis: N - Normal / C - Cancelada / S - Substituída | Caractere |
optanteSimplesPrestador | retorna o status atual do prestador em relação a opção do simples nacional Status possíveis: S - Sim / N - Não | Caractere |
descontadoPrefeitura | retorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: S - Sim / N - Não | Caractere |
tomadorForaMunicipio | retorna se o tomador da nota fiscal é domiciliado em município diferente ao do emissor da nota fiscal Opções possíveis: S - Sim / N - Não | Caractere |
inscricaoEstadualTomador | retorna o número da inscrição estadual do tomador | Caractere |
municipioPrestador | retorna o código IBGE do município onde o prestador está domiciliado | Caractere |
condicaoPagamento | retorna o tipo da condição de pagamento da nota fiscal Tipos possíveis: 0 - À vista / 1 - Apresentação / 2 - À prazo / 3 - Cartão de débito / 4 - Cartão de crédito | Caractere |
situacaoTributaria | retorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributária | Caractere |
tomadorEstrangeiro | retorna se o tomador da nota fiscal é estrangeiro Opções disponíveis: S - Sim / N - Não | Caractere |
inscricaoPrestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
possuiCreditoTributario | retorna se a nota fiscal já possui crédito tributário gerado Opções disponíveis: S - Sim / N - Não | Caractere |
optanteSimplesTomador | retorna o status atual do tomador da nota fiscal em relação a opção do simples nacional Opções disponíveis: S - Sim / N - Não | Caractere |
descricaoCompetencia | retorna a descrição da competência da nota fiscal | Caractere |
inscricaoTomador | retorna o CPF/CNPJ do tomador da nota fiscal | Caractere |
modalidadeIssPrestador | retorna a modalidade do ISS atual do prestador da nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo / H - Homologado / E- Estimado | Caractere |
optanteSimplesPrestadorNota | retorna o status do prestador em relação a opção do simples nacional na data do fato gerador da nota fiscal | Caractere |
optanteSimplesTomadorNota | retorna o status do tomador em relação a opção do simples nacional na data do fato gerador da nota fiscal | Caractere |
rpsForaPrazo | retorna se o RPS relacionado a nota fiscal foi convertido fora do prazo Opções possíveis: Sim / Não | Caractere |
obra | retorna o número da Obra da nota fiscal | Caractere |
iBeneficio | retorna o código de cadastro do benefício fiscal relacionado a nota fiscal | Caractere |
prestadorSubstituto | retorna se o prestador da nota fiscal está configurado em seu cadastro como substituto tributário Opções possíveis: S - Sim / N - Não | Caractere |
loteRPS | retorna o número do lote de RPS da nota fiscal | Caractere |
issPagoRelacionadoGuia | retorna o status da guia de pagamento do ISS o qual a nota fiscal está relacionada, se está paga Status possíveis: S - Sim / N - Não | Caractere |
paisTomador | retorna o código BACEN do país no endereço do tomador da nota fiscal | Caractere |
tipoPessoaTomador | retorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / O - Outros / E - Estrangeiro | Caractere |
prestadorIsento | retorna se o prestador da nota fiscal está configurado como isento Opções possíveis: S - Sim / N - Não | Caractere |
nomeTomador | retorna o nome do tomador da nota fiscal | Caractere |
nomePrestador | retorna o nome do prestador da nota fiscal | Caractere |
municipioTomador | retorna o código do IBGE do município onde o tomador da nota fiscal está domiciliado | Caractere |
tipoPessoaPrestador | retorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - Jurídica O - Outros | Caractere |
servicoPrestadoForaPais | retorna se o serviço da nota fiscal foi prestado fora do país Opções possíveis: Sim / Não | Caractere |
localPrestacaoServico | retorna o código do IBGE do município onde o serviço da nota fiscal foi prestado | Caractere |
dataFinalCompetencia | retorna a data final da competência relacionada a nota fiscal | Data |
dhFatoGerador | retorna a data e hora do fato gerador da nota fiscal | Data |
dataEmissaoRPS | retorna a data de emissão do RPS relacionado a nota fiscal | Data |
dataEmissao | retorna a data e hora de emissão da nota fiscal | Data |
dataIniCompetencia | retorna a data inicial da competência relacionada a nota fiscal | Data |
outrasRetencoes | retorna o valor calculado dos tributos federais da nota fiscal para outras retenções | Numérico |
baseCalculo | retorna o valor total da base de cálculo da nota fiscal | Numérico |
valorServico | retorna o valor total de serviços da nota fiscal | Numérico |
naturezaOperacao | retorna a natureza de operação da nota fiscal Naturezas possíveis:1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Numérico |
numeroNota | retorna o número da nota fiscal | Numérico |
qtdeParcelas | retorna a quantidade de parcelas da condição de pagamento da nota fiscal | Numérico |
csll | retorna o valor calculado dos tributos federais da nota fiscal para outras csll | Numérico |
valorDescIncondicional | retorna o valor total calculado para o desconto incondicional da nota fiscal | Numérico |
pisPasep | retorna o valor calculado dos tributos federais da nota fiscal para pis/pasep | Numérico |
naturezaJuridicaPrestador | retorna o código da natureza jurídica do prestador da nota fiscal | Numérico |
valorPago | retorna o valor pago da guia em que a nota fiscal está relacionada | Numérico |
ir | retorna o valor calculado dos tributos federais da nota fiscal para imposto de renda | Numérico |
valorDeducao | retorna o valor total calculado para dedução da nota fiscal | Numérico |
inss | retorna o valor calculado dos tributos federais da nota fiscal para outras inss | Numérico |
porteEmpresaPrestador | retorna o porte da empresa do prestador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Numérico |
valorISS | retorna o valor do ISS gerado na nota fiscal | Numérico |
cofins | retorna o valor calculado dos tributos federais da nota fiscal para outras cofins | Numérico |
naturezaJuridicaTomador | retorna o código da natureza jurídica do tomador da nota fiscal | Numérico |
valorDescCondicional | retorna o valor total calculado para o desconto condicionado da nota fiscal | Numérico |
aliquotaMunicipal | retorna se o prestador da nota fiscal vai tributar utilizando alíquota municipal Opções possíveis: S - Sim / N - Não | Numérico |
numeroRPS | retorna o número do RPS relacionado a nota fiscal | Numérico |
porteEmpresaTomador | retorna o porte da empresa do tomador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Numérico |
qtdNota | retorna a quantidade de notas fiscais que foram emitidas na competência | Numérico |
notaFiscalPrestador | retorna informações do prestador da nota fiscal | Objeto |
notaFiscalPrestador.iPessoas | retorna o código de cadastro da pessoa da nota fiscal | Numérico |
notaFiscalPrestador.iNotas | retorna o número da nota fiscal | Numérico |
notaFiscalPrestador.iMunicipios | retorna o código do IBGE do município onde o prestador da nota fiscal está domiciliado | Caractere |
notaFiscalPrestador.tipoPessoa | retorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / O - Outros | Caractere |
notaFiscalPrestador.inscricao | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
notaFiscalPrestador.nome | retorna o nome do prestador da nota fiscal | Caractere |
notaFiscalPrestador.inscricaoMunicipal | retorna o número da inscrição municipal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.cep | retorna o CEP no endereço principal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.bairro | retorna o nome do bairro no endereço principal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.endereco | retorna o nome do logradouro no endereço principal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.numero | retorna o número predial no endereço principal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.complemento | retorna o complemento no endereço principal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.email | retorna o e-mail principal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.telefone | retorna o número do telefone fixo principal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.celular | retorna o número do telefone celuar principal do prestador da nota fiscal | Caractere |
notaFiscalPrestador.nomeFantasia | retorna o nome social/fantasia do prestador da nota fiscal | Caractere |
notaFiscalPrestador.optanteSimples | retorna o status atual do prestador da nota fiscal em relação a opção do simples nacional Opções possíveis: Sim / Não | Caractere |
notaFiscalPrestador.numPis | retorna o número do PIS/PASEP do prestador da nota fiscal | Caractere |
notaFiscalPrestador.fax | retorna o número do fax do prestador da nota fiscal | Caractere |
notaFiscal | retorna informações da nota fiscal | Objeto |
notaFiscal.iPessoas | retorna o código de cadastro do prestador da nota fiscal | Caractere |
notaFiscal.iNotas | retorna o número da nota fiscal | Caractere |
notaFiscal.iListaServicos | retorna a relação de itens da lista de serviço da nota fiscal | Caractere |
notaFiscal.iTomadores | retorna o código de cadastro do tomador da nota fiscal | Caractere |
notaFiscal.iCompetencias | retorna o código de cadastro da competência da nota fiscal | Caractere |
notaFiscal.numeroVerificacao | retorna o número de verificação da nota fiscal | Caractere |
notaFiscal.dhEmissao | retorna a data e hora de emissão da nota fiscal | Data |
notaFiscal.naturezaOperacao | retorna a natureza de operação registrada na nota fiscal. Naturezas possíveis: 1 - Tributação no Município / 2 - Tributação fora do Município / 3 - Isenção / 4 - Imune / 5 - Exigibilidade suspensa por decisão judicial / 6 - Exigibilidade suspensa por procedimento administrativo / 7 - Não incidência / 8 - Exportação | Caractere |
notaFiscal.vlPisPasep | retorna o valor calculado dos tributos federais da nota fiscal para pis/pasep | Numérico |
notaFiscal.vlCofins | retorna o valor calculado dos tributos federais da nota fiscal para cofins | Numérico |
notaFiscal.vlInss | retorna o valor calculado dos tributos federais da nota fiscal para inss | Numérico |
notaFiscal.vlIr | retorna o valor calculado dos tributos federais da nota fiscal para imposto de renda | Numérico |
notaFiscal.vlCsll | retorna o valor calculado dos tributos federais da nota fiscal para csll | Numérico |
notaFiscal.vlOutrasRetencoes | retorna o valor calculado dos tributos federais da nota fiscal para outras retenções | Numérico |
notaFiscal.situacao | retorna a situação atual da nota fiscal Situações possíveis: N - Normal / C - Cancelada / S - Substituída | Caractere |
notaFiscal.rps | retorna o número do RPS da nota fiscal | Caractere |
notaFiscal.serieRps | retorna a sigla da sérei do RPS da nota fiscal | Caractere |
notaFiscal.dhEmissRps | retorna a data e hora de emissão do rps relacionado a nota fiscal | Data |
notaFiscal.iLotes | retorna o número do lote de RPS da nota fiscal | Caractere |
notaFiscal.convForaPrazo | retorna se o RPS relacionado a nota fiscal foi convertido fora do prazo Opções possíveis: Sim / Não | Caractere |
notaFiscal.optanteSimples | retorna o status da nota fiscal em relação a opção do simples nacional Opções possíveis: Sim / Não | Caractere |
notaFiscal.assinatura | retorna o status da nota fiscal se está assinada digitalmente Opções possíveis: true false | Boolean |
notaFiscal.iCnaes | retorna a relação de códigos da cnae relacionados a nota fiscal | Caractere |
notaFiscal.servicoForaPais | retorna se o serviço da nota fiscal foi prestado fora do país Opções possíveis: Sim / Não | Caractere |
notaFiscal.descricaoCnae | retorna a descrição das cnaes relacionadas a nota fiscal | Caractere |
notaFiscal.outrasInformacoes | retorna a descrição das observações informadas na nota fiscal | Caractere |
notaFiscal.vlLiquido | retorna o valor líquido da nota fiscal | Numérico |
notaFiscal.aliquotaPis | retorna a alíquota calculada na nota fiscal para o PIS | Numérico |
notaFiscal.aliquotaCofins | retorna a alíquota calculada na nota fiscal para o Cofins | Numérico |
notaFiscal.aliquotaInss | retorna a alíquota calculada na nota fiscal para o INSS | Numérico |
notaFiscal.aliquotaIr | retorna a alíquota calculada na nota fiscal para o Imposto de renda | Numérico |
notaFiscal.aliquotaCsll | retorna a alíquota calculada na nota fiscal para a CSLL | Numérico |
notaFiscal.aliquotaOutras | retorna a alíquota calculada na nota fiscal para outros tributos | Numérico |
notaFiscal.descontadoPrefeitura | retorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: Sim / Não | Caractere |
notaFiscal.cartaCorrecao | retorna se existe carta de correção emitida para a nota fiscal Opções possíveis: Sim / Não | Caractere |
notaFiscal.creditoGerado | retorna se já existe valor de crédito tributário gerado para a nota fiscal Opções possíveis: Sim / Não | Caractere |
notaFiscal.inscricaoTomador | retorna o CPF/CNPJ do tomador da nota fiscal | Caractere |
notaFiscal.nomeTomador | retorna o nome do tomador da nota fiscal | Caractere |
notaFiscal.vlTotalServico | retorna o valor total do serviço da nota fiscal | Numérico |
notaFiscal.vlTotalDeducao | retorna o valor total de deduções da nota fiscal | Numérico |
notaFiscal.vlTotalDescIncondicional | retorna o valor total de desconto incondicionado da nota fiscal | Numérico |
notaFiscal.vlTotalDescCondicional | retorna o valor total de desconto condicionado da nota fiscal | Numérico |
notaFiscal.vlTotalBaseCalculo | retorna o valor total da base de cálculo da nota fiscal | Numérico |
notaFiscal.vlTotalIss | retorna o valor total de ISS calculado na nota fiscal para prestadores não optantes do simples nacional | Numérico |
notaFiscal.inscricaoPrestador | retorna o CPF/CNPJ do prestador da nota fiscal | Caractere |
notaFiscal.nomePrestador | retorna o nome do prestador da nota fiscal | Caractere |
notaFiscal.vlIssOptante | fiscal para prestadores optantes do simples nacional | Numérico |
notaFiscal.situacaoGuia | retorna a situação da guia de pagamento da nota fiscal | Caractere |
notaFiscal.responsavelRetencao | retorna se o prestador da nota fiscal está configurado em seu cadastro como responsável tributário Opções possíveis: S - Sim / N - Não | Caractere |
notaFiscalServico | retorna as informações dos serviços relacionados a nota fiscal | Listagem |
notaFiscalServico.iPessoas | retorna o código de cadastro do prestador da nota fiscal | Caractere |
notaFiscalServico.iNotas | retorna o número da nota fiscal | Caractere |
notaFiscalServico.descricao | retorna a descrição do item da lista de serviços relacionados a nota fiscal | Caractere |
notaFiscalServico.vlServico | retorna o valor total de cada serviço relacionado a nota fiscal | Numérico |
notaFiscalServico.vlDeducao | retorna o valor de dedução de cada serviço relacionado a nota fiscal | Numérico |
notaFiscalServico.vlDescIncondicional | retorna o valor do desconto incondicionado de cada serviço relacionado a nota fiscal | Numérico |
notaFiscalServico.vlDescCondicional | retorna o valor do desconto condicionado de cada serviço relacionado a nota fiscal | Numérico |
notaFiscalServico.vlBaseCalculo | retorna o valor da base de cálculo de cada serviço da nota fiscal | Numérico |
notaFiscalServico.aliquota | retorna a alíquota de cada serviço relacionado a nota fiscal | Numérico |
notaFiscalServico.vlIss | retorna o valor de ISS calculado de cada serviço relacionado a nota fiscal não optante do simples nacional | Numérico |
notaFiscalServico.iListaServicos | retorna o código da lista de cada serviço relacionado a nota fiscal | Caractere |
notaFiscalServico.valorUnitario | retorna o valor unitário de cada serviço relacionado a nota fiscal | Numérico |
notaFiscalServico.qtdServico | retorna a quantidade de serviço para cada item da lista relacionado a nota fiscal | Caractere |
notaFiscalServico.iCnaes | retorna o código da cnae de cada serviço relacionado a nota fiscal | Caractere |
notaFiscalServico.vlIssOptante | retorna o valor de ISS calculado de cada serviço relacionado a nota fiscal optante do simples nacional | Numérico |
notaFiscalServico.iPaisesExterior | Caractere | |
notaFiscalServico.aliqIbptFederal | retorna a alíquota federal do IBPT configurada para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.aliqIbptEstadual | retorna a alíquota estadual do IBPT configurada para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.aliqIbptMunicipal | retorna a alíquota municipal do IBPT configurada para cada item da lista de serviços da nota fiscal | Numérico |
notaFiscalServico.descricaoCnae | retorna a descrição da cnae relacionada a cada serviço da nota fiscal | Caractere |
notaFiscalTomador | retorna informações do tomador da nota fiscal | Objeto |
notaFiscalTomador.iPessoas | retorna o código de cadastro do prestador da nota fiscal cujo o tomador está relacionado | Caractere |
notaFiscalTomador.iNotas | retorna o número da nota fiscal | Caractere |
notaFiscalTomador.tipoPessoa | retorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / E - Estrangeiro | Caractere |
notaFiscalTomador.inscricao | retorna o CPF/CNPJ do tomador não estrangeiro da nota fiscal | Caractere |
notaFiscalTomador.nome | retorna o nome do tomador da nota fiscal | Caractere |
notaFiscalTomador.inscricaoMunicipal | retorna o número da inscrição municipal do tomador da nota fiscal | Caractere |
notaFiscalTomador.cep | retorna o cep do endereço do tomador da nota fiscal | Caractere |
notaFiscalTomador.bairro | retorna o nome do bairro do endereço do tomador da nota fiscal | Caractere |
notaFiscalTomador.endereco | retorna o nome do logradouro do endereço do tomador da nota fiscal | Caractere |
notaFiscalTomador.complemento | retorna o complemento do endereço do tomador da nota fiscal | Caractere |
notaFiscalTomador.email | retorna o e-mail principal do tomador da nota fiscal | Caractere |
notaFiscalTomador.telefone | retorna o número do telefone fixo do tomador da nota fiscal | Caractere |
notaFiscalTomador.celular | retorna o número do celular do tomador da nota fiscal | Caractere |
notaFiscalTomador.pais | retorna o código Bacen do país do tomador da nota fiscal | Caractere |
notaFiscalTomador.municipio | retorna o código IBGE do município do tomador da nota fiscal | Caractere |
notaFiscalTomador.numeroDocumento | retorna o número do documento de tomadores estrangeiros relacionados a nota fiscal | Caractere |
notaFiscalTomador.estrangeiro | retorna se o tomador da nota fiscal é estranfeiro Opções possíveis: S - Sim / N - Não | Caractere |
notaFiscalTomador.inscricaoEstadual | retorna o número da inscrição estadual do tomador da nota fiscal | Caractere |
notaFiscalTomador.nomeFantasia | retorna o nome fantasia do tomador da nota fiscal | Caractere |
notaFiscalTomador.optanteSimples | retorna o status do tomador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - Não | Caractere |
notaFiscalTomador.porteEmpresa | retorna o porte da empresa do tomador registrado na nota fiscal Portes possíveis: 0 - Não classificada / 1 - Microempresa (ME) / 2 - Empresa de Pequeno Porte (EPP) / 3 - Empresa de Médio Porte (EMP) / 4 - Empresa de Grande Porte (EGP) / 5 - Microempreendedor Individual (MEI) / 6 - EIRELI / 7 - Demais | Caractere |
notaFiscalTomador.website | retorna o site do tomador da nota fiscal | Caractere |
Nota: Nessa fórmula para poder armazenar e retornar o valor do crédito tributário calculado para nota fiscal, deve conter configurado as seguintes variáveis padrão do sistema:
retornar: função interna de uso obrigatório, responsável por fazer o retorno do valor do crédito para as funcionalidades do sistema;
valorCredito: função interna responsável por armazenar o valor final do crédito a ser gerado na nota fiscal;
gerarCredito: função interna de uso obrigatório, responsável por indicar se deve ou não gerar crédito na nota. Deverá ser utilizado S para sim e N para não;
liberarQuando: função interna de uso obrigatório, responsável por indicar em qual momento o valor do crédito gerado para a nota fiscal deve ser liberado. Deverá ser utilizado E quando for ao emitir a nota fiscal e P quando for ao pagar o ISS da nota fiscal;
dataExpiracao: função interna responsável por armazenar a data de expiração do crédito tributário da nota. Se o crédito não possuir data de expiração não deve ser informado essa variável;
expirarCreditoAutomaticamente: função interna responsável por indicar se o crédito tributário da nota deverá ser expirado automaticamente pelo sistema, de acordo com a data de expiração informada. Deverá ser utilizado S para sim e N para não.
Exemplo de aplicabilidade da fórmula:
vlCredito = 0.00;
se (situacaoTributaria == 'N') {
percorrer(notaFiscalServico) {
vlCredito += (item.vlBaseCalculo *0.07);
}
} senao {
vlCredito = 0;
}
retornar valorCredito:vlCredito,gerarCredito:'S',liberarQuando:'P', dataExpiracao:'30-03-2023',expirarCreditoAutomaticamente:'S';