Pular para o conteúdo principal

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.

executando

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.

executando

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.

executando

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.

executando

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.

executando

Havendo algum erro, é apresentado na guia Erros, a causa e a posição no script onde está a sintaxe incorreta.

executando

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.

executando

É importante salientar que fórmulas com problemas de sintaxe o sistema não irá permitir salvar o script, exibindo assim a seguinte mensagem:

executando

Quando a fórmula não possuir nenhum problema, a mesma poderá ser salva e o sistema vai apresentar a seguinte mensagem:

executando

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ávelDescrição de retornoTipo de dado
situacaoretorna a situação da guia de pagamento com possibilidade de emissão de boleto. Situações possíveis: A - Aberta / U - Abaixo do limiteCaractere
cpfCnpjPrestadorretorna o CPF/CNPJ do prestador relacionado a guia de pagamentoCaractere
tipoRetorna o tipo da guia de pagamento gerada Tipos possíveis: P - Serviços Prestados / T - Serviços TomadosCaractere
sistemaOrigemretorna o sistema que originou a guia de pagamento Sistemas possíveis: NOTACaractere
dhGeracaoretorna a data de geração da guia de pagamentoData
dataAtualretorna a data atualData
dataVencimentoretorna a data de vencimento da guiaData
dataVencimentoUnificadoraretorna a data de vencimento da guia principal, quando junto a ela existem guias abaixo do limite unificadasData
parcelaretorna como número da parcela, o mês da data inicial da competência da guiaNumérico
numeroGuiaretorna o código de identificação da guia no banco de dadosNumérico
vlSaldoUtilizadoretorna o valor de saldo que foi utilizado na guia geradaNumérico
valorGuiaretorna 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
valorImpostoretorna 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
valorTaxaExpedienteretorna 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
competenciaretorna informações do cadastro de competênciasObjeto
competencia.descricaoretorna a descrição da competência relacionada a guiaCaractere
competencia.exercicioretorna o ano da competência relacionada a guiaCaractere
competencia.dtInicialretorna a data inicial da competência relacionada a guiaData
competencia.dtFinalretorna a data final da competência relacionada a guiaData
competencia.dtVctoretorna a data de vencimento da competência relacionada a guiaData
IndexadoresUtil.corrente(Sigla)retorna se o indexador é uma moeda corrente no país conforme a sigla indicada no parâmetroFunçã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âmetroFunçã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âmetroFunção
IndexadoresUtil.valorIndexadorNaData(Sigla, Data)retorna o valor do indexador conforme a sigla e a data indicada no parâmetroFunçã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âmetroFunção
IndexadoresUtil.relacaoIndexadores(Sigla)retorna uma lista de valores do indexador conforme a sigla indicada no parâmetroFunção
DataUtil.ehDiaUtil(Data)retorna se a data indicada no parâmetro é um dia útilFunção
DataUtil.isDomingo(Data)retorna se a data indicada no parâmetro é um domingoFunção
DataUtil.isSabado(Data)retorna se a data indicada no parâmetro é um sábadoFunção
DataUtil.ultimoDiaUtil(Data)retorna o dia útil anterior à data indicada no parâmetroFunção
DataUtil.proximoDiaUtil(Data)retorna o próximo dia útil à data indicada no parâmetroFunção
Feriados.ehFeriado(Data)retorna se a data indicada no parâmetro, de acordo com o cadastro de feriados do sistema, é feriadoFunção
DataUtil.isFeriado(Data)retorna se a data indicada no parâmetro, de acordo com o calendário, é feriadoFunçã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.

executando

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ávelDescrição de retornoTipo de dado
cnaeretorna o código da CNAE da nota fiscalCaractere
nroDocumentoEstrangeiroretorna o número de identificação do tomador estrangeiro relacionado a nota fiscalCaractere
tipoTomadorretorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / E - EstrangeiroCaractere
enquadramentoretorna a modalidade do ISS atual do prestador da nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo / H - Homologado / E- EstimadoCaractere
optanteSimplesretorna o status do prestador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - NãoCaractere
tipoPessoaretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - JurídicaCaractere
municipioPrestadorretorna o código IBGE do município no endereço do prestadorCaractere
municipioTomadorretorna o código IBGE do município no endereço do tomadorCaractere
itemListaServicoretorna o código do item da lista de serviço da nota fiscalCaractere
situacaoTributariaretorna a situação tributária do ISS da nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributáriaCaractere
servicoPrestadoForaPaisretorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: S - Sim / N - NãoCaractere
tomadorOptanteSimplesretorna o status do tomador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - NãoCaractere
inscricaoPrestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
inscricaoTomadorretorna 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
localPrestacaoServicoretorna o código do IBGE do município onde o serviço da nota fiscal foi prestadoCaractere
servicoDescontadoPrefeituraretorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: S - Sim / N - NãoCaractere
dataValidadeFinalBeneficioretorna a data final da validade registrada para o benefício fiscalData
dataFatoGeradorretorna a data do fato gerador da nota fiscalData
dataValidadeInicialBeneficioretorna a data inicial da validade registrada para o benefício fiscalData
dataEmissaoRpsretorna a data de emissão do RPS relacionado a nota fiscalData
dataEmissaoretorna a data de emissão da nota fiscalData
incentivoFiscalretorna o código de cadastro do incentivo fiscalNumérico
baseCalculoretorna a base de cálculo da nota fiscalNumérico
naturezaOperacaoretorna 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çãoNumérico
porteEmpresaretorna 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 - DemaisNumérico
valorOriginalIssServicoretorna o valor original do ISS calculado no serviço da nota fiscalNumérico
codigoNaturezaJuridicaretorna o código da natureza jurídica do tomador da nota fiscalNumérico
porteEmpresaTomadorretorna 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 - DemaisNumérico
aliquotaretorna a alíquota original do serviço da nota fiscalNumérico
naturezaJuridicaretorna o código da natureza jurídica do prestador da nota fiscalNumé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ávelDescrição de retornoTipo de dado
cnaeretorna o código da CNAE de cada serviço da nota fiscalCaractere
nroDocumentoEstrangeiroretorna o número de identificação do tomador estrangeiro relacionado a nota fiscalCaractere
tipoTomadorretorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / E - EstrangeiroCaractere
enquadramentoretorna a modalidade do ISS atual do prestador da nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo H / - HomologadoE- EstimadoCaractere
optanteSimplesretorna o status do prestador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - NãoCaractere
tipoPessoaretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - JurídicaCaractere
municipioPrestadorretorna o código IBGE do município no endereço do prestadorCaractere
municipioTomadorretorna o código IBGE do município no endereço do tomadorCaractere
itemListaServicoretorna o código do item da lista de serviço da nota fiscalCaractere
situacaoTributariaretorna a situação tributária do ISS da nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributária / Caractere
servicoPrestadoForaPaisretorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: S - Sim / N - NãoCaractere
tomadorOptanteSimplesretorna o status do tomador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - NãoCaractere
inscricaoPrestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
inscricaoTomadorretorna 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
localPrestacaoServicoretorna o código do IBGE do município onde o serviço da nota fiscal foi prestadoCaractere
servicoDescontadoPrefeituraretorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: S - Sim / N - NãoCaractere
dataValidadeFinalBeneficioretorna a data final da validade registrada para o benefício fiscalData
dataFatoGeradorretorna a data do fato gerador da nota fiscalData
dataValidadeInicialBeneficioretorna a data inicial da validade registrada para o benefício fiscalData
dataEmissaoRpsretorna a data de emissão do RPS relacionado a nota fiscalData
dataEmissaoretorna a data de emissão da nota fiscalData
incentivoFiscalretorna o código de cadastro do incentivo fiscalNumérico
baseCalculoretorna a base de cálculo da nota fiscalNumérico
naturezaOperacaoretorna 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çãoNumérico
porteEmpresaretorna 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 - DemaisNumérico
valorOriginalIssServicoretorna o valor original do ISS calculado no serviço da nota fiscalNumérico
codigoNaturezaJuridicaretorna o código da natureza jurídica do tomador da nota fiscalNumérico
porteEmpresaTomadorretorna 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 - DemaisNumérico
aliquotaretorna a alíquota original do serviço da nota fiscalNumérico
naturezaJuridicaretorna o código da natureza jurídica do prestador da nota fiscalNumé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ávelDescrição de retornoTipo de dado
notaFiscalSubstitutaretorna informações das notas fiscais substitutasObjeto
notaFiscalSubstituta.iNotasretornar o número da nota fiscalNumérico
notaFiscalSubstituta.optanteSimplesretorna o status em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituta.optanteSimplesTomadorretorna o status do tomador em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituta.porteEmpresaPrestadorretorna 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 - DemaisCaractere
notaFiscalSubstituta.porteEmpresaTomadorretorna 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 - DemaisCaractere
notaFiscalSubstituta.modalidadeIssretorna a modalidade do ISS registrada na nota fiscal. Modalidades possíveis: NAO_ENQUADRADO / FIXO / HOMOLOGADO / ESTIMADOCaractere
notaFiscalSubstituta.naturezaOperacaoretorna 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çãoCaractere
notaFiscalSubstituta.situacaoTributariaretorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributáriaCaractere
notaFiscalSubstituta.cpfCnpjPrestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
notaFiscalSubstituta.cpfCnpjTomadorretorna o CPF/CNPJ do tomador da nota fiscalCaractere
notaFiscalSubstituta.cpfCnpjIntermediarioretorna o CPF/CNPJ do intermediário da nota fiscalCaractere
notaFiscalSubstituta.vlLiquidoretorna o valor líquido calculado na nota fiscalNumérico
notaFiscalSubstituta.vlBaseCalculoretorna o valor total da base de cálculo da nota fiscalNumérico
notaFiscalSubstituta.vlTotalIssExibidoretorna o valor total de iss exibido na nota fiscalNumérico
notaFiscalSubstituta.vlTotalIssNaoExibidoretorna o valor total de iss não exibido na nota fiscalNumérico
notaFiscalSubstituta.rpsretorna o número do RPS da nota fiscalNumérico
notaFiscalSubstituta.dhEmissaoRpsretorna a data e hora de emissão do RPS da nota fiscalData
notaFiscalSubstituta.serieRpsretorna a sigla da série de rps da nota fiscalCaractere
notaFiscalSubstituta.numeroLoteRpsretorna o número do lote do RPS da nota fiscalNumérico
notaFiscalSubstituta.servicoForaDoPaisretorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: true / falseBoolean
notaFiscalSubstituta.tipoPessoaretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: FISICA / JURIDICACaractere
notaFiscalSubstituta.assinadaretorna se a nota fiscal está assinada digitalmente Opções possíveis: true / falseBoolean
notaFiscalSubstituta.dhEmissaoretorna a data e hora de emissão da nota fiscalData
notaFiscalSubstituta.dhFatoGeradorretorna a data e hora do fato gerador da nota fiscalData
notaFiscalSubstituta.optanteSimplesPrestadorDtFatoGeradorretorna 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 / falseBoolean
notaFiscalSubstituta.porteEmpresaPrestadorDtFatoGeradorretorna 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 - DemaisCaractere
notaFiscalSubstituta.optanteSimplesAtualTomadorretorna o status atual em relação a opção do simples nacional do tomador da nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituta.porteEmpresaAtualTomadorretorna 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 - DemaisCaractere
notaFiscalSubstituta.vlTotalServicosretorna o valor total dos serviços da nota fiscalNumérico
notaFiscalSubstituta.competencia.descricaoretorna a descrição da competência da nota fiscalCaractere
notaFiscalSubstituta.competencia.exercicioretorna o ano da competência da nota fiscalNumérico
notaFiscalSubstituta.competencia.dtInicialretorna a data inicial da competência da nota fiscalData
notaFiscalSubstituta.competencia.dtFinalretorna a data final da competência da nota fiscalData
notaFiscalSubstituta.competencia.dtVctoretorna a data de vencimento da competência da nota fiscal
notaFiscalSubstituta.servicos.aliquotaretorna a alíquota de cada serviço da nota fiscalNumérico
notaFiscalSubstituta.servicos.descricaoretorna a descrição do item da lista de cada serviço da nota fiscalCaractere
notaFiscalSubstituta.servicos.iCnaesretorna o código da CNAE de cada serviço da nota fiscalCaractere
notaFiscalSubstituta.servicos.iListaServicosretorna o código do item da lista de cada serviço da nota fiscalCaractere
notaFiscalSubstituta.servicos.vlIssretorna o valor do ISS calculado e exibido de cada serviço da nota fiscalNumérico
notaFiscalSubstituta.servicos.vlIssNaoExibidoretorna o valor do ISS calculado e não exibido de cada serviço da nota fiscalNumérico
notaFiscalSubstituta.servicos.vlServicoretorna o valor do serviço de cada serviço da nota fiscalNumérico
notaFiscalSubstituidaretorna informações das notas fiscais substituídasObjeto
notaFiscalSubstituida.iNotasretornar o número da nota fiscalNumérico
notaFiscalSubstituida.optanteSimplesretorna o status em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituida.optanteSimplesTomadorretorna o status do tomador em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituida.porteEmpresaPrestadorretorna 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 - DemaisCaractere
notaFiscalSubstituida.porteEmpresaTomadorretorna 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 - DemaisCaractere
notaFiscalSubstituida.modalidadeIssretorna a modalidade do ISS registrada na nota fiscal. Modalidades possíveis: NAO_ENQUADRADO / FIXO / HOMOLOGADO / ESTIMADOCaractere
notaFiscalSubstituida.naturezaOperacaoretorna 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çãoCaractere
notaFiscalSubstituida.situacaoTributariaretorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributáriaCaractere
notaFiscalSubstituida.cpfCnpjPrestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
notaFiscalSubstituida.cpfCnpjTomadorretorna o CPF/CNPJ do tomador da nota fiscalCaractere
notaFiscalSubstituida.cpfCnpjIntermediarioretorna o CPF/CNPJ do intermediário da nota fiscalCaractere
notaFiscalSubstituida.vlLiquidoretorna o valor líquido calculado na nota fiscalNumérico
notaFiscalSubstituida.vlBaseCalculoretorna o valor total da base de cálculo da nota fiscalNumérico
notaFiscalSubstituida.vlTotalIssExibidoretorna o valor total de iss exibido na nota fiscalNumérico
notaFiscalSubstituida.vlTotalIssNaoExibidonotaFiscalSubstituida.vlTotalIssNaoExibidoNumérico
notaFiscalSubstituida.rpsretorna o número do RPS da nota fiscalNumérico
notaFiscalSubstituida.dhEmissaoRpsretorna a data e hora de emissão do RPS da nota fiscalData
notaFiscalSubstituida.serieRpsretorna a sigla da série de rps da nota fiscalCaractere
notaFiscalSubstituida.numeroLoteRpsretorna o número do lote do RPS da nota fiscalNumérico
notaFiscalSubstituida.servicoForaDoPaisretorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: true / falseBoolean
notaFiscalSubstituida.tipoPessoaretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: FISICA / JURIDICACaractere
notaFiscalSubstituida.assinadaretorna se a nota fiscal está assinada digitalmente Opções possíveis: true / falseBoolean
notaFiscalSubstituida.dhEmissaoretorna a data e hora de emissão da nota fiscalData
notaFiscalSubstituida.dhFatoGeradorretorna a data e hora do fato gerador da nota fiscalData
notaFiscalSubstituida.optanteSimplesPrestadorDtFatoGeradorretorna 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 falseBoolean
notaFiscalSubstituida.porteEmpresaPrestadorDtFatoGeradorretorna 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 - DemaisCaractere
notaFiscalSubstituida.optanteSimplesAtualTomadorretorna o status atual em relação a opção do simples nacional do tomador da nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituida.porteEmpresaAtualTomadorretorna 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 - DemaisCaractere
notaFiscalSubstituida.vlTotalServicosretorna o valor total dos serviços da nota fiscalNumérico
notaFiscalSubstituida.competencia.descricaoretorna a descrição da competência da nota fiscalCaractere
notaFiscalSubstituida.competencia.exercicioretorna o ano da competência da nota fiscalNumérico
notaFiscalSubstituida.competencia.dtInicialnotaFiscalSubstituida.competencia.dtInicialData
notaFiscalSubstituida.competencia.dtFinalretorna a data final da competência da nota fiscalData
notaFiscalSubstituida.competencia.dtVctoretorna a data de vencimento da competência da nota fiscal
notaFiscalSubstituta.servicos.aliquotanotaFiscalSubstituta.servicos.aliquotaNumérico
notaFiscalSubstituta.servicos.descricaoretorna a descrição do item da lista de cada serviço da nota fiscalCaractere
notaFiscalSubstituta.servicos.iCnaesretorna o código da CNAE de cada serviço da nota fiscalCaractere
notaFiscalSubstituta.servicos.iListaServicosretorna o código do item da lista de cada serviço da nota fiscalCaractere
notaFiscalSubstituta.servicos.vlIssretorna o valor do ISS calculado e exibido de cada serviço da nota fiscalNumérico
notaFiscalSubstituta.servicos.vlIssNaoExibidoretorna o valor do ISS calculado e não exibido de cada serviço da nota fiscalNumérico
notaFiscalSubstituta.servicos.vlServicoretorna o valor do serviço de cada serviço da nota fiscalNumérico
notaFiscalSubstituidaretorna informações das notas fiscais substituídasObjeto
notaFiscalSubstituida.iNotasretornar o número da nota fiscalNumérico
notaFiscalSubstituida.optanteSimplesretorna o status em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituida.optanteSimplesTomadorretorna o status do tomador em relação a opção do simples nacional que está registrado na nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituida.porteEmpresaPrestadorretorna 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 - DemaisCaractere
notaFiscalSubstituida.porteEmpresaTomadorretorna 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 - DemaisCaractere
notaFiscalSubstituida.modalidadeIssretorna a modalidade do ISS registrada na nota fiscal. Modalidades possíveis: NAO_ENQUADRADO / FIXO / HOMOLOGADO / ESTIMADOCaractere
notaFiscalSubstituida.naturezaOperacaoretorna 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çãoCaractere
notaFiscalSubstituida.situacaoTributariaretorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributáriaCaractere
notaFiscalSubstituida.cpfCnpjPrestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
notaFiscalSubstituida.cpfCnpjTomadorretorna o CPF/CNPJ do tomador da nota fiscalCaractere
notaFiscalSubstituida.cpfCnpjIntermediarioretorna o CPF/CNPJ do intermediário da nota fiscalCaractere
notaFiscalSubstituida.vlLiquidoretorna o valor líquido calculado na nota fiscalNumérico
notaFiscalSubstituida.vlBaseCalculoretorna o valor total da base de cálculo da nota fiscalNumérico
notaFiscalSubstituida.vlTotalIssExibidoretorna o valor total de iss exibido na nota fiscalNumérico
notaFiscalSubstituida.vlTotalIssNaoExibidoretorna o valor total de iss não exibido na nota fiscalNumérico
notaFiscalSubstituida.rpsretorna o número do RPS da nota fiscalNumérico
notaFiscalSubstituida.dhEmissaoRpsretorna a data e hora de emissão do RPS da nota fiscalData
notaFiscalSubstituida.serieRpsretorna a sigla da série de rps da nota fiscalCaractere
notaFiscalSubstituida.numeroLoteRpsretorna o número do lote do RPS da nota fiscalNumérico
notaFiscalSubstituida.servicoForaDoPaisretorna se o serviço prestado na nota foi fora do Brasil (outro país) Opções possíveis: true / falseBoolean
notaFiscalSubstituida.tipoPessoaretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: FISICA / JURIDICACaractere
notaFiscalSubstituida.assinadaretorna se a nota fiscal está assinada digitalmente Opções possíveis: true / falseBoolean
notaFiscalSubstituida.dhEmissaoretorna a data e hora de emissão da nota fiscalData
notaFiscalSubstituida.dhFatoGeradorretorna a data e hora do fato gerador da nota fiscalData
notaFiscalSubstituida.optanteSimplesPrestadorDtFatoGeradorretorna 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 / falseBoolean
notaFiscalSubstituida.porteEmpresaPrestadorDtFatoGeradorretorna 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 - DemaisCaractere
notaFiscalSubstituida.optanteSimplesAtualTomadorretorna o status atual em relação a opção do simples nacional do tomador da nota fiscal Opções possíveis: true / falseBoolean
notaFiscalSubstituida.porteEmpresaAtualTomadorretorna 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 - DemaisCaractere
notaFiscalSubstituida.vlTotalServicosretorna o valor total dos serviços da nota fiscalNumérico
notaFiscalSubstituida.competencia.descricaoretorna a descrição da competência da nota fiscalCaractere
notaFiscalSubstituida.competencia.exercicioretorna o ano da competência da nota fiscalNumérico
notaFiscalSubstituida.competencia.dtInicialretorna a data inicial da competência da nota fiscalData
notaFiscalSubstituida.competencia.dtFinalretorna a data final da competência da nota fiscalData
notaFiscalSubstituida.competencia.dtVctoretorna a data de vencimento da competência da nota fiscal
notaFiscalSubstituida.servicos.aliquotaretorna a alíquota de cada serviço da nota fiscalNumérico
notaFiscalSubstituida.servicos.descricaoretorna a descrição do item da lista de cada serviço da nota fiscalCaractere
notaFiscalSubstituida.servicos.iCnaesretorna o código da CNAE de cada serviço da nota fiscalCaractere
notaFiscalSubstituida.servicos.iListaServicosretorna o código do item da lista de cada serviço da nota fiscalCaractere
notaFiscalSubstituida.servicos.vlIssretorna o valor do ISS calculado e exibido de cada serviço da nota fiscalNumérico
notaFiscalSubstituida.servicos.vlIssNaoExibidoretorna o valor do ISS calculado e não exibido de cada serviço da nota fiscalNumérico
notaFiscalSubstituida.servicos.vlServicoretorna o valor do serviço de cada serviço da nota fiscalNumé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ávelDescrição de retornoTipo de dado
tomadorForaMunicipioretorna se o tomador da nota fiscal é domiciliado em município diferente ao do emissor da nota fiscal Opções possíveis: true / falseBoolean
serieRPSretorna a sigla da série de rps da nota fiscalCaractere
artretorna o número da ART informado na nota fiscalCaractere
cepTomadorretorna o CEP do endereço do tomador da nota fiscalCaractere
nomeFantasiaTomadorretorna o nome fantasia do tomador da nota fiscalCaractere
discriminacaoServicoretorna 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 notaCaractere
nomeUsuarioretorna o nome do usuário da Central de Usuários Betha que foi o emissor da nota fiscalCaractere
logradouroretorna o nome do logradouro no endereço do tomador da nota fiscalCaractere
inscricaoIntermediarioretorna o CPF/CNPJ do intermediário da nota fiscalCaractere
utilizaAliqMunicipalretorna se o prestador da nota fiscal vai tributar utilizando alíquota municipal Opções possíveis: S - Sim / N - NãoCaractere
imuneretorna se o prestador da nota fiscal está configurado em seu cadastro como imune Opções possíveis: S - Sim / N - NãoCaractere
enquadPrestadorretorna a modalidade do ISS atual do prestador da nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo / H - Homologado / E- EstimadoCaractere
RPSAutorizadoretorna 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ãoCaractere
descontadoPrefeituraretorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: S - Sim / N - NãoCaractere
nomeIntermediarioretorna o nome do intermediário da nota fiscalCaractere
municipioPrestadorretorna o código do IBGE do município onde o prestador da nota fiscal está domiciliadoCaractere
situacaoTributariaretorna a situação tributária do ISS da nota fiscal Situações possíveis: N - Normal / R - Retida / S - Substituição tributáriaCaractere
pisPasepretorna o número do PIS/PASEP do prestador da nota fiscalCaractere
inscricaoMunicipalIntermediarioretorna o número da inscrição municipal do intermediário da nota fiscalCaractere
bairroretorna o nome do bairro no endereço do tomador da nota fiscalCaractere
obrigaCnaeretorna se o prestador é obrigado a informar a CNAE no serviço da nota fiscalCaractere
inscricaoMunicipalPrestadorretorna o número da inscrição municipal do prestador da nota fiscalCaractere
obraretorna o número da Obra informado na nota fiscalCaractere
prestadorSubstitutoretorna se o prestador da nota fiscal está configurado em seu cadastro como substituto tributário Opções possíveis: S - Sim / N - NãoCaractere
emitidaPorretorna 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
optanteSimplesretorna o status atual do prestador da nota fiscal em relação a opção do simples nacional Opções possíveis: Sim / NãoCaractere
tomadorretorna o CPF/CNPJ do tomador da nota fiscalCaractere
paisTomadorretorna o código do BACEN do país onde o tomador da nota fiscal está domiciliadoCaractere
telefoneretorna o número do telefone fixo do tomador da nota fiscalCaractere
estrangeiroretorna se o tomador da nota fiscal é estrangeiro Opções possíveis: Sim / NãoCaractere
numeroretorna o número residencial no endereço do tomador da nota fiscalCaractere
tipoPessoaTomadorretorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / O - Outros / E - EstrangeiroCaractere
rpsForaDoPrazoretorna se o RPS relacionado a nota fiscal foi convertido fora do prazo Opções possíveis: Sim / NãoCaractere
idUsuarioretorna o login do usuário da Central de Usuários Betha que foi o emissor da nota fiscalCaractere
nomeTomadorretorna o nome do tomador da nota fiscalCaractere
nomePrestadorretorna o nome do prestador da nota fiscalCaractere
municipioTomadorretorna o código do IBGE do município onde o tomador da nota fiscal está domiciliadoCaractere
municipioEntidaderetorna o código do IBGE do município gerador da nota fiscalCaractere
prestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
tipoPessoaPrestadorretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / O - OutrosCaractere
servicoPrestadoForaPaisretorna se o serviço da nota fiscal foi prestado fora do país Opções possíveis: Sim / NãoCaractere
nroProcessoSuspensaoretorna o número do processo de suspensão informado na nota fiscalCaractere
outrasInformacoesretorna a descrição das observações informadas na nota fiscalCaractere
emailretorna o e-mail do tomador da nota fiscalCaractere
celularretorna o telefone celular do tomador da nota fiscalCaractere
localPrestacaoServicoretorna o código do IBGE do município onde o serviço da nota fiscal foi prestadoCaractere
dataFatoGeradorretorna a data e hora do fato gerador da nota fiscalData
dataEmissaoPisPasepretorna a data de emissão do PIS/PASEP do prestador da nota fiscalData
dataEmissaoRPSretorna a data e hora de emissão do RPS convertido em nota fiscalData
dataEmissaoretorna a data e hora de emissão da nota fiscalData
valorLiquidoretorna o valor líquido calculado da nota fiscalNumérico
outrasRetencoesretorna o valor calculado dos tributos federais da nota fiscal para outras retençõesNumérico
baseCalculoretorna o valor total da base de cálculo da nota fiscalNumérico
valorServicoretorna o valor total de serviços da nota fiscalNumérico
naturezaOperacaoretorna 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çãoNumérico
numeroNotaretorna o número da nota fiscalNumérico
csllretorna o valor calculado dos tributos federais da nota fiscal para csllNumérico
pis_pasepretorna o valor calculado dos tributos federais da nota fiscal para pis/pasepNumérico
valorDescIncondicionalretorna o valor total calculado para o desconto incondicional da nota fiscalNumérico
aliquotaretorna 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 notaNumérico
irretorna o valor calculado dos tributos federais da nota fiscal para imposto de rendaNumérico
valorDeducaoretorna o valor total calculado de dedução da nota fiscalNumérico
inssretorna o valor calculado dos tributos federais da nota fiscal para inssNumérico
loteRPSretorna o número do lote de rps convertido em nota fiscalNumérico
portePrestadorretorna 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 - DemaisNumérico
valorISSretorna o valor total calculado de ISS da nota fiscalNumérico
cofinsretorna o valor calculado dos tributos federais da nota fiscal para cofinsNumérico
naturezaJuridicaTomadorretorna o código da natureza jurídica do tomador da nota fiscalNumérico
valorDescCondicionalretorna o valor total calculado para o desconto condicionado da nota fiscalNumérico
numeroRPSretorna o número do RPS convertido em nota fiscalNumérico
naturezaJuridicaretorna o código da natureza jurídica do prestador da nota fiscalNumérico
notaFiscalServicoretorna as informações da relação dos serviços relacionados a nota fiscalListagem
notaFiscalServico.descricaoretorna a discriminação informada para item da lista de serviços da nota fiscalCaractere
notaFiscalServico.vlServicoretorna o valor total do serviço para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.vlDeducaoretorna o valor de dedução para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.vlDescIncondicionalretorna o valor do desconto incondicionado para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.vlDescCondicionalretorna o valor do desconto condicionado para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.vlBaseCalculoretorna o valor da base de cálculo para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.aliquotaretorna a alíquota efetiva para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.vlIssretorna 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 fiscalNumérico
notaFiscalServico.valorUnitarioretorna o valor unitário do serviço para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.qtdServicoretorna a quantidade de serviço para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.vlIssOptanteretorna o valor calculado de ISS de prestadores optantes do simples nacional para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.aliqIbptFederalretorna a alíquota federal do IBPT configurada para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.aliqIbptEstadualretorna a alíquota estadual do IBPT configurada para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.aliqIbptMunicipalretorna a alíquota municipal do IBPT configurada para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.descricaoCnaeretorna a descrição da CNAE relacionada a cada item da lista de serviços da nota fiscalCaractere
notaFiscalServico.aliquotaEspecificaretorna a alíquota específica configurada para o prestador para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.paisServicoretorna o código do BACEN do país onde o serviço da nota fiscal foi prestadoCaractere
notaFiscalServico.IListaServicosretorna o código do item da lista de serviço da nota fiscalCaractere
notaFiscalServico.IMunicipiosretorna o código do IBGE do município onde o serviço da nota fiscal foi prestadoCaractere
notaFiscalServico.ICnaesretorna o código da CNAE relacionada a cada item da lista de serviço da nota fiscalCaractere
notaFiscalServico.listasServicosretorna informações do cadastro da lista de serviços para a relação de itens da lista relacionado a nota fiscalListagem
notaFiscalServico.listasServicos.descricaoretorna a descrição de cada item da lista da nota fiscalCaractere
notaFiscalServico.listasServicos.aliquotaretorna a alíquota configurada para cada item da lista de serviçosNumérico
notaFiscalServico.listasServicos.incideSubstituicaoTributariaretorna se o item da lista de serviço está configurado para incidir substituição tributária Opções possíveis: Sim NãoCaractere
notaFiscalServico.listasServicos.issDevidoLocalPrestacaoretorna 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ãoCaractere
dadosPrestadorretorna informações do cadastro de pessoas do prestadorObjeto
dadosPrestador.nomeSocialFantasiaretorna o nome social/fantasia do prestador da nota fiscalCaractere
dadosPrestador.inscricaoEstadualretorna o número da inscrição estadual do prestador da nota fiscalCaractere
dadosPrestador.cepretorna o CEP no endereço principal do prestador da nota fiscalCaractere
dadosPrestador.bairroretorna o nome do bairro no endereço principal do prestador da nota fiscalCaractere
dadosPrestador.logradouroretorna o nome do logradouro no endereço principal do prestador da nota fiscalCaractere
dadosPrestador.numeroretorna o número predial no endereço principal do prestador da nota fiscalCaractere
dadosPrestador.complementoretorna o complemento no endereço principal do prestador da nota fiscalCaractere
dadosPrestador.estadoretorna a UF do estado no endereço principal do prestador da nota fiscalCaractere
dadosPrestador.emailretorna o e-mail principal do prestador da nota fiscalCaractere
dadosPrestador.siteretorna o site do prestador da nota fiscalCaractere
dadosPrestador.telefoneretorna o número do telefone fixo principal do prestador da nota fiscalCaractere
dadosPrestador.celularretorna o número do telefone celular principal do prestador da nota fiscalCaractere
competenciaretorna as informações do cadastro de competências relacionada a nota fiscalObjeto
competencia.descricaoretorna a descrição da competência relacionada a nota fiscalCaractere
competencia.dtInicialretorna a data inicial da competência relacionada a nota fiscalData
competencia.dtFinalretorna a data final da competência relacionada a nota fiscalData
competencia.dtVctoretorna a data de vencimento da competência relacionada a nota fiscalData
dadosTomadorretorna informações do cadastro do tomador da nota fiscalObjeto
dadosTomador.inscricaoMunicipalretorna o número da inscrição municipal do tomador da nota fiscalCaractere
dadosTomador.inscricaoEstadualretorna o número da inscrição estadual do tomador da nota fiscalCaractere
dadosTomador.siteretorna o site do tomador da nota fiscalCaractere
dadosTomador.complementoretorna o complemento no endereço do tomador da nota fiscalCaractere
dadosTomador.ufretorna a UF do estado no endereço do tomador da nota fiscalCaractere
dadosTomador.municipioEstrangeiroretorna o nome do município estrangeiro no endereço do tomador da nota fiscalCaractere
dadosTomador.optanteSimplesretorna o status atual do tomador da nota fiscal em relação a opção do simples nacional Opções possíveis: Sim / NãoCaractere
dadosTomador.porteEmpresaretorna 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 - DemaisCaractere
condicoesPagamentoretorna informações da relação das condições de pagamento relacionadas a nota fiscalListagem
condicoesPagamento.tiporetorna o tipo da condição de pagamento da nota fiscal Tipos possíveis:Caractere
condicoesPagamento.totalParcelasretorna o total de parcelas da condição de pagamento para cada tipo de condição informado na nota fiscalNumérico
condicoesPagamento.baseCalculoretorna o valor da base de cálculo da condição de pagamento para cada tipo de condição informado na nota fiscalNumérico
condicoesPagamento.parcelaretorna o número da parcela da condição de pagamento para cada tipo de condição informado na nota fiscalNumérico
condicoesPagamento.vencimentoretorna o vencimento da parcela da condição de pagamento para cada tipo de condição informado na nota fiscalData
condicoesPagamento.valorretorna o valor da parcela da condição de pagamento para cada tipo de condição informado na nota fiscalNumérico
dadosTributosFederaisretorna as informações das alíquotas calculadas para os tributos federaisObjeto
dadosTributosFederais.vlAliquotaPisretorna a alíquota calculada na nota fiscal para o PISNumérico
dadosTributosFederais.vlAliquotaCofinsretorna a alíquota calculada na nota fiscal para o CofinsNumérico
dadosTributosFederais.vlAliquotaInssretorna a alíquota calculada na nota fiscal para o INSSNumérico
dadosTributosFederais.vlAliquotaIrretorna a alíquota calculada na nota fiscal para o Imposto de rendaNumérico
dadosTributosFederais.vlAliquotaCsllretorna a alíquota calculada na nota fiscal para a CSLLNumérico
dadosTributosFederais.vlAliquotaOutrasretorna a alíquota calculada na nota fiscal para outros tributosNumérico
emailsretorna informações dos destinatários da nota fiscalListagem
emails.destinatarioretorna 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ávelDescrição de retornoTipo de dado
optanteSimplesretorna o status atual do contribuinte na solicitação de acesso em relação a opção do simples nacional Opções possíveis: true / falseBoolean
contemAnexoretorna o status da solicitação de acesso em relação a conter anexo vinculado Opções possíveis: true / falseBoolean
contribuinteExisteretorna 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 / falseBoolean
faxContribuinteretorna o número do Fax do contribuinte na solicitação de acessoCaractere
numeroPredialContribuinteretorna o número predial do endereço do contribuinte na solicitação de acessoCaractere
inscricaoMunicipalretorna o número da inscrição municipal do contribuinte na solicitação de acessoCaractere
inscricaoEstadualretorna o número da inscrição estadual do contribuinte na solicitação de acessoCaractere
cpfCnpjretorna o CPF/CNPJ do contribuinte na solicitação de acessoCaractere
nomeSocialretorna o nome social do contribuinte na solicitação de acessoCaractere
siteContribuinteretorna o site do contribuinte na solicitação de acessoCaractere
observacaoSolicitacaoretorna a descrição da observação informada na solicitação de acessoCaractere
razaoSocialretorna a razão social do contribuinte na solicitação de acessoCaractere
telefoneFixoContribuinteretorna o número do telefone fixo do contribuinte na solicitação de acessoCaractere
celularContribuinteretorna o número do telefone celular do contribuinte na solicitação de acessoCaractere
emailContribuinteretorna o e-mail do contribuinte na solicitação de acessoCaractere
cepContribuinteretorna o CEP do endereço do contribuinte na solicitação de acessoCaractere
bairroContribuinteretorna o nome do bairro do endereço do contribuinte na solicitação de acessoCaractere
complementoEnderecoContribuinteretorna o complemento do endereço do contribuinte na solicitação de acessoCaractere
nomeFantasiaretorna o nome fantasia do contribuinte na solicitação de acessoCaractere
logradouroContribuinteretorna o nome do logradouro do endereço do contribuinte na solicitação de acessoCaractere
dataCadastroretorna a data de cadastro da solicitação de acessoData
municipioContribuinteretorna o código IBGE do município no endereço do contribuinte da solicitação de acessoNumérico
perfilretorna o tipo do perfil de acesso informado pelo contribuinte na solicitação de acesso Tipos possíveis: 0 - Prestador / 1 - TomadorNumérico
porteEmpresaretorna 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 - DemaisNumérico
quantidadeAnexosretorna a quantidade de anexos relacionados a solicitação de acessoNumérico
tipoPessoaretorna o tipo da pessoa do contribuinte na solicitação de acesso Tipos possíveis: 0 - Física / 1 - JurídicaNumérico
modalidadeIssretorna a modalidade do ISS atual do contribuinte na solicitação de acesso. Modalidades possíveis: 0 - Não enquadrado / 1 - Fixo / 2 - Homologado / 3 - EstimadoNumé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ávelDescrição de retornoTipo de dado
prestadorOptanteSimplesretorna o status do prestador na nota fiscal em relação a opção do simples nacional Opções possíveis: true / falseBoolean
descontadoPrefeituraretorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: true / falseBoolean
servicoPrestadoForaPaisretorna se o serviço da nota fiscal foi prestado fora do país Opções possíveis: true / falseBoolean
notaAssinadaDigitalmenteretorna se a nota fiscal está assinada digitalmente Opções possíveis: true / falseBoolean
tomadorOptanteSimplesretorna o status do tomador na nota fiscal em relação a opção do simples nacional Opções possíveis: true falseBoolean
cpfCnpjPrestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
serieRPSretorna a sigla da série do RPS da nota fiscalCaractere
emailTomadorretorna o e-mail do tomador na nota fiscalCaractere
documentoTomadorretorna o CPF/CNPJ para tomadores brasileiros e o número do documento de identificação para tomadores estrangeirosCaractere
situacaoTributariaretorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributáriaCaractere
tipoPessoaPrestadoretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física J - JurídicaCaractere
modalidadeIssPrestadorretorna a modalidade do ISS do prestador na nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo / H - Homologado / E- EstimadoCaractere
cpfCnpjIntermediarioretorna o CPF/CNPJ do intermediário da nota fiscalCaractere
dataFatoGeradorretorna a data e hora do fato gerador da nota fiscalData
dataEmissaoRPSretorna a data e hora de emissão do RPS da nota fiscalData
dataCancelamentoretorna a data e hora do cancelamento da nota fiscalData
dataEmissaoretorna a data e hora de emissão da nota fiscalData
porteTomadorretorna 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 - DemaisNumérico
valorLiquidoretorna o valor líquido da nota fiscalNumérico
baseCalculoretorna o valor total da base de cálculo da nota fiscalNumérico
valorServicoretorna o valor total do serviço da nota fiscalNumérico
naturezaOperacaoretorna 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çãoNumérico
valorIssExibidoretorna o valor total de iss exibido na nota fiscalNumérico
portePrestadorretorna 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 - DemaisNumérico
loteRPSretorna o número do lote de RPS da nota fiscalNumérico
numeroNotaretorna o número do lote de RPS da nota fiscalNumérico
numeroNotaretorna o número da nota fiscalNumérico
numeroRPSretorna o número do RPS da nota fiscalNumérico
valorIssNaoExibidoretorna o valor total de iss não exibido na nota fiscalNumérico
servicosretorna as informações da relação dos serviços da nota fiscalListagem
servicos.codigoServicoretorna o código do item da lista de serviço da nota fiscalCaractere
servicos.descricaoretorna a descrição do item da lista de serviço da nota fiscalCaractere
servicos.aliquotaretorna a alíquota do item da lista de serviço da nota fiscalNumérico
servicos.cnaeretorna o código da CNAE relacionada ao item da lista de serviço da nota fiscalCaractere
servicos.vlTotalServicoretorna o valor total do serviço para o item da lista da nota fiscalNumérico
servicos.vlBaseCalculoretorna o valor da base de cálculo para o item da lista da nota fiscalNumérico
servicos.vlIssExibidoretorna o valor calculado do ISS exibido na nota para o item da listaNumérico
servicos.vlIssNaoExibidoretorna o valor calculado do ISS não exibido na nota para o item da listaNumérico
competenciaretorna as informações do cadastro de competências que está relacionada a nota fiscalObjeto
competencia.descricaoretorna a descrição da competência relacionada a nota fiscalCaractere
competencia.dtInicialretorna a data inicial da competência relacionada a nota fiscalData
competencia.dtFinalretorna a data final da competência relacionada a nota fiscalData
competencia.dtVctoretorna a data de vencimento da competência relacionada a fiscalData

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ávelDescrição de retornoTipo de dado
serieRPSretorna a sigla da série de rps da nota fiscalCaractere
artretorna o número da ART da nota fiscalCaractere
inscricaoMunicipalTomadorretorna o número da inscrição municipal do tomador da nota fiscalCaractere
pagoretorna o status da guia de pagamento o qual a nota fiscal está relacionada, se está paga Status possíveis: S - Sim / N - NãoCaractere
municipioServicoretorna o código do IBGE do município onde o serviço da nota fiscal foi prestadoCaractere
prestadorImuneretorna se o prestador da nota fiscal está configurado em seu cadastro como imune Opções possíveis: S - Sim / N - NãoCaractere
inscricaoIntermediarioretorna o CPF/CNPJ do intermediário da nota fiscalCaractere
situacaoNotaretorna a situação atual da nota fiscal Situações possíveis: N - Normal / C - Cancelada / S - SubstituídaCaractere
optanteSimplesPrestadorretorna o status atual do prestador em relação a opção do simples nacional Status possíveis: S - Sim / N - NãoCaractere
descontadoPrefeituraretorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: S - Sim / N - NãoCaractere
tomadorForaMunicipioretorna 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ãoCaractere
inscricaoEstadualTomadorretorna o número da inscrição estadual do tomadorCaractere
municipioPrestadorretorna o código IBGE do município onde o prestador está domiciliadoCaractere
condicaoPagamentoretorna 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éditoCaractere
situacaoTributariaretorna a situação tributária do ISS registrada na nota fiscal. Situações possíveis: N - Normal / R - Retida / S - Substituição tributáriaCaractere
tomadorEstrangeiroretorna se o tomador da nota fiscal é estrangeiro Opções disponíveis: S - Sim / N - NãoCaractere
inscricaoPrestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
possuiCreditoTributarioretorna se a nota fiscal já possui crédito tributário gerado Opções disponíveis: S - Sim / N - NãoCaractere
optanteSimplesTomadorretorna 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ãoCaractere
descricaoCompetenciaretorna a descrição da competência da nota fiscalCaractere
inscricaoTomadorretorna o CPF/CNPJ do tomador da nota fiscalCaractere
modalidadeIssPrestadorretorna a modalidade do ISS atual do prestador da nota fiscal. Modalidades possíveis: N - Não enquadrado / F - Fixo / H - Homologado / E- EstimadoCaractere
optanteSimplesPrestadorNotaretorna o status do prestador em relação a opção do simples nacional na data do fato gerador da nota fiscalCaractere
optanteSimplesTomadorNotaretorna o status do tomador em relação a opção do simples nacional na data do fato gerador da nota fiscalCaractere
rpsForaPrazoretorna se o RPS relacionado a nota fiscal foi convertido fora do prazo Opções possíveis: Sim / NãoCaractere
obraretorna o número da Obra da nota fiscalCaractere
iBeneficioretorna o código de cadastro do benefício fiscal relacionado a nota fiscalCaractere
prestadorSubstitutoretorna se o prestador da nota fiscal está configurado em seu cadastro como substituto tributário Opções possíveis: S - Sim / N - NãoCaractere
loteRPSretorna o número do lote de RPS da nota fiscalCaractere
issPagoRelacionadoGuiaretorna 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ãoCaractere
paisTomadorretorna o código BACEN do país no endereço do tomador da nota fiscalCaractere
tipoPessoaTomadorretorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / O - Outros / E - EstrangeiroCaractere
prestadorIsentoretorna se o prestador da nota fiscal está configurado como isento Opções possíveis: S - Sim / N - NãoCaractere
nomeTomadorretorna o nome do tomador da nota fiscalCaractere
nomePrestadorretorna o nome do prestador da nota fiscalCaractere
municipioTomadorretorna o código do IBGE do município onde o tomador da nota fiscal está domiciliadoCaractere
tipoPessoaPrestadorretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - Jurídica O - OutrosCaractere
servicoPrestadoForaPaisretorna se o serviço da nota fiscal foi prestado fora do país Opções possíveis: Sim / NãoCaractere
localPrestacaoServicoretorna o código do IBGE do município onde o serviço da nota fiscal foi prestadoCaractere
dataFinalCompetenciaretorna a data final da competência relacionada a nota fiscalData
dhFatoGeradorretorna a data e hora do fato gerador da nota fiscalData
dataEmissaoRPSretorna a data de emissão do RPS relacionado a nota fiscalData
dataEmissaoretorna a data e hora de emissão da nota fiscalData
dataIniCompetenciaretorna a data inicial da competência relacionada a nota fiscalData
outrasRetencoesretorna o valor calculado dos tributos federais da nota fiscal para outras retençõesNumérico
baseCalculoretorna o valor total da base de cálculo da nota fiscalNumérico
valorServicoretorna o valor total de serviços da nota fiscalNumérico
naturezaOperacaoretorna 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çãoNumérico
numeroNotaretorna o número da nota fiscalNumérico
qtdeParcelasretorna a quantidade de parcelas da condição de pagamento da nota fiscalNumérico
csllretorna o valor calculado dos tributos federais da nota fiscal para outras csllNumérico
valorDescIncondicionalretorna o valor total calculado para o desconto incondicional da nota fiscalNumérico
pisPasepretorna o valor calculado dos tributos federais da nota fiscal para pis/pasepNumérico
naturezaJuridicaPrestadorretorna o código da natureza jurídica do prestador da nota fiscalNumérico
valorPagoretorna o valor pago da guia em que a nota fiscal está relacionadaNumérico
irretorna o valor calculado dos tributos federais da nota fiscal para imposto de rendaNumérico
valorDeducaoretorna o valor total calculado para dedução da nota fiscalNumérico
inssretorna o valor calculado dos tributos federais da nota fiscal para outras inssNumérico
porteEmpresaPrestadorretorna 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 - DemaisNumérico
valorISSretorna o valor do ISS gerado na nota fiscalNumérico
cofinsretorna o valor calculado dos tributos federais da nota fiscal para outras cofinsNumérico
naturezaJuridicaTomadorretorna o código da natureza jurídica do tomador da nota fiscalNumérico
valorDescCondicionalretorna o valor total calculado para o desconto condicionado da nota fiscalNumérico
aliquotaMunicipalretorna se o prestador da nota fiscal vai tributar utilizando alíquota municipal Opções possíveis: S - Sim / N - NãoNumérico
numeroRPSretorna o número do RPS relacionado a nota fiscalNumérico
porteEmpresaTomadorretorna 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 - DemaisNumérico
qtdNotaretorna a quantidade de notas fiscais que foram emitidas na competênciaNumérico
notaFiscalPrestadorretorna informações do prestador da nota fiscalObjeto
notaFiscalPrestador.iPessoasretorna o código de cadastro da pessoa da nota fiscalNumérico
notaFiscalPrestador.iNotasretorna o número da nota fiscalNumérico
notaFiscalPrestador.iMunicipiosretorna o código do IBGE do município onde o prestador da nota fiscal está domiciliadoCaractere
notaFiscalPrestador.tipoPessoaretorna o tipo da pessoa do prestador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / O - OutrosCaractere
notaFiscalPrestador.inscricaoretorna o CPF/CNPJ do prestador da nota fiscalCaractere
notaFiscalPrestador.nomeretorna o nome do prestador da nota fiscalCaractere
notaFiscalPrestador.inscricaoMunicipalretorna o número da inscrição municipal do prestador da nota fiscalCaractere
notaFiscalPrestador.cepretorna o CEP no endereço principal do prestador da nota fiscalCaractere
notaFiscalPrestador.bairroretorna o nome do bairro no endereço principal do prestador da nota fiscalCaractere
notaFiscalPrestador.enderecoretorna o nome do logradouro no endereço principal do prestador da nota fiscalCaractere
notaFiscalPrestador.numeroretorna o número predial no endereço principal do prestador da nota fiscalCaractere
notaFiscalPrestador.complementoretorna o complemento no endereço principal do prestador da nota fiscalCaractere
notaFiscalPrestador.emailretorna o e-mail principal do prestador da nota fiscalCaractere
notaFiscalPrestador.telefoneretorna o número do telefone fixo principal do prestador da nota fiscalCaractere
notaFiscalPrestador.celularretorna o número do telefone celuar principal do prestador da nota fiscalCaractere
notaFiscalPrestador.nomeFantasiaretorna o nome social/fantasia do prestador da nota fiscalCaractere
notaFiscalPrestador.optanteSimplesretorna o status atual do prestador da nota fiscal em relação a opção do simples nacional Opções possíveis: Sim / NãoCaractere
notaFiscalPrestador.numPisretorna o número do PIS/PASEP do prestador da nota fiscalCaractere
notaFiscalPrestador.faxretorna o número do fax do prestador da nota fiscalCaractere
notaFiscalretorna informações da nota fiscalObjeto
notaFiscal.iPessoasretorna o código de cadastro do prestador da nota fiscalCaractere
notaFiscal.iNotasretorna o número da nota fiscalCaractere
notaFiscal.iListaServicosretorna a relação de itens da lista de serviço da nota fiscalCaractere
notaFiscal.iTomadoresretorna o código de cadastro do tomador da nota fiscalCaractere
notaFiscal.iCompetenciasretorna o código de cadastro da competência da nota fiscalCaractere
notaFiscal.numeroVerificacaoretorna o número de verificação da nota fiscalCaractere
notaFiscal.dhEmissaoretorna a data e hora de emissão da nota fiscalData
notaFiscal.naturezaOperacaoretorna 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çãoCaractere
notaFiscal.vlPisPasepretorna o valor calculado dos tributos federais da nota fiscal para pis/pasepNumérico
notaFiscal.vlCofinsretorna o valor calculado dos tributos federais da nota fiscal para cofinsNumérico
notaFiscal.vlInssretorna o valor calculado dos tributos federais da nota fiscal para inssNumérico
notaFiscal.vlIrretorna o valor calculado dos tributos federais da nota fiscal para imposto de rendaNumérico
notaFiscal.vlCsllretorna o valor calculado dos tributos federais da nota fiscal para csllNumérico
notaFiscal.vlOutrasRetencoesretorna o valor calculado dos tributos federais da nota fiscal para outras retençõesNumérico
notaFiscal.situacaoretorna a situação atual da nota fiscal Situações possíveis: N - Normal / C - Cancelada / S - SubstituídaCaractere
notaFiscal.rpsretorna o número do RPS da nota fiscalCaractere
notaFiscal.serieRpsretorna a sigla da sérei do RPS da nota fiscalCaractere
notaFiscal.dhEmissRpsretorna a data e hora de emissão do rps relacionado a nota fiscalData
notaFiscal.iLotesretorna o número do lote de RPS da nota fiscalCaractere
notaFiscal.convForaPrazoretorna se o RPS relacionado a nota fiscal foi convertido fora do prazo Opções possíveis: Sim / NãoCaractere
notaFiscal.optanteSimplesretorna o status da nota fiscal em relação a opção do simples nacional Opções possíveis: Sim / NãoCaractere
notaFiscal.assinaturaretorna o status da nota fiscal se está assinada digitalmente Opções possíveis: true falseBoolean
notaFiscal.iCnaesretorna a relação de códigos da cnae relacionados a nota fiscalCaractere
notaFiscal.servicoForaPaisretorna se o serviço da nota fiscal foi prestado fora do país Opções possíveis: Sim / NãoCaractere
notaFiscal.descricaoCnaeretorna a descrição das cnaes relacionadas a nota fiscalCaractere
notaFiscal.outrasInformacoesretorna a descrição das observações informadas na nota fiscalCaractere
notaFiscal.vlLiquidoretorna o valor líquido da nota fiscalNumérico
notaFiscal.aliquotaPisretorna a alíquota calculada na nota fiscal para o PISNumérico
notaFiscal.aliquotaCofinsretorna a alíquota calculada na nota fiscal para o CofinsNumérico
notaFiscal.aliquotaInssretorna a alíquota calculada na nota fiscal para o INSSNumérico
notaFiscal.aliquotaIrretorna a alíquota calculada na nota fiscal para o Imposto de rendaNumérico
notaFiscal.aliquotaCsllretorna a alíquota calculada na nota fiscal para a CSLLNumérico
notaFiscal.aliquotaOutrasretorna a alíquota calculada na nota fiscal para outros tributosNumérico
notaFiscal.descontadoPrefeituraretorna se o valor do ISS calculado na nota fiscal já foi retido pela prefeitura Opções possíveis: Sim / NãoCaractere
notaFiscal.cartaCorrecaoretorna se existe carta de correção emitida para a nota fiscal Opções possíveis: Sim / NãoCaractere
notaFiscal.creditoGeradoretorna se já existe valor de crédito tributário gerado para a nota fiscal Opções possíveis: Sim / NãoCaractere
notaFiscal.inscricaoTomadorretorna o CPF/CNPJ do tomador da nota fiscalCaractere
notaFiscal.nomeTomadorretorna o nome do tomador da nota fiscalCaractere
notaFiscal.vlTotalServicoretorna o valor total do serviço da nota fiscalNumérico
notaFiscal.vlTotalDeducaoretorna o valor total de deduções da nota fiscalNumérico
notaFiscal.vlTotalDescIncondicionalretorna o valor total de desconto incondicionado da nota fiscalNumérico
notaFiscal.vlTotalDescCondicionalretorna o valor total de desconto condicionado da nota fiscalNumérico
notaFiscal.vlTotalBaseCalculoretorna o valor total da base de cálculo da nota fiscalNumérico
notaFiscal.vlTotalIssretorna o valor total de ISS calculado na nota fiscal para prestadores não optantes do simples nacionalNumérico
notaFiscal.inscricaoPrestadorretorna o CPF/CNPJ do prestador da nota fiscalCaractere
notaFiscal.nomePrestadorretorna o nome do prestador da nota fiscalCaractere
notaFiscal.vlIssOptantefiscal para prestadores optantes do simples nacionalNumérico
notaFiscal.situacaoGuiaretorna a situação da guia de pagamento da nota fiscalCaractere
notaFiscal.responsavelRetencaoretorna se o prestador da nota fiscal está configurado em seu cadastro como responsável tributário Opções possíveis: S - Sim / N - NãoCaractere
notaFiscalServicoretorna as informações dos serviços relacionados a nota fiscalListagem
notaFiscalServico.iPessoasretorna o código de cadastro do prestador da nota fiscalCaractere
notaFiscalServico.iNotasretorna o número da nota fiscalCaractere
notaFiscalServico.descricaoretorna a descrição do item da lista de serviços relacionados a nota fiscalCaractere
notaFiscalServico.vlServicoretorna o valor total de cada serviço relacionado a nota fiscalNumérico
notaFiscalServico.vlDeducaoretorna o valor de dedução de cada serviço relacionado a nota fiscalNumérico
notaFiscalServico.vlDescIncondicionalretorna o valor do desconto incondicionado de cada serviço relacionado a nota fiscalNumérico
notaFiscalServico.vlDescCondicionalretorna o valor do desconto condicionado de cada serviço relacionado a nota fiscalNumérico
notaFiscalServico.vlBaseCalculoretorna o valor da base de cálculo de cada serviço da nota fiscalNumérico
notaFiscalServico.aliquotaretorna a alíquota de cada serviço relacionado a nota fiscalNumérico
notaFiscalServico.vlIssretorna o valor de ISS calculado de cada serviço relacionado a nota fiscal não optante do simples nacionalNumérico
notaFiscalServico.iListaServicosretorna o código da lista de cada serviço relacionado a nota fiscalCaractere
notaFiscalServico.valorUnitarioretorna o valor unitário de cada serviço relacionado a nota fiscalNumérico
notaFiscalServico.qtdServicoretorna a quantidade de serviço para cada item da lista relacionado a nota fiscalCaractere
notaFiscalServico.iCnaesretorna o código da cnae de cada serviço relacionado a nota fiscalCaractere
notaFiscalServico.vlIssOptanteretorna o valor de ISS calculado de cada serviço relacionado a nota fiscal optante do simples nacionalNumérico
notaFiscalServico.iPaisesExteriorCaractere
notaFiscalServico.aliqIbptFederalretorna a alíquota federal do IBPT configurada para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.aliqIbptEstadualretorna a alíquota estadual do IBPT configurada para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.aliqIbptMunicipalretorna a alíquota municipal do IBPT configurada para cada item da lista de serviços da nota fiscalNumérico
notaFiscalServico.descricaoCnaeretorna a descrição da cnae relacionada a cada serviço da nota fiscalCaractere
notaFiscalTomadorretorna informações do tomador da nota fiscalObjeto
notaFiscalTomador.iPessoasretorna o código de cadastro do prestador da nota fiscal cujo o tomador está relacionadoCaractere
notaFiscalTomador.iNotasretorna o número da nota fiscalCaractere
notaFiscalTomador.tipoPessoaretorna o tipo da pessoa do tomador da nota fiscal Tipos possíveis: F - Física / J - Jurídica / E - EstrangeiroCaractere
notaFiscalTomador.inscricaoretorna o CPF/CNPJ do tomador não estrangeiro da nota fiscalCaractere
notaFiscalTomador.nomeretorna o nome do tomador da nota fiscalCaractere
notaFiscalTomador.inscricaoMunicipalretorna o número da inscrição municipal do tomador da nota fiscalCaractere
notaFiscalTomador.cepretorna o cep do endereço do tomador da nota fiscalCaractere
notaFiscalTomador.bairroretorna o nome do bairro do endereço do tomador da nota fiscalCaractere
notaFiscalTomador.enderecoretorna o nome do logradouro do endereço do tomador da nota fiscalCaractere
notaFiscalTomador.complementoretorna o complemento do endereço do tomador da nota fiscalCaractere
notaFiscalTomador.emailretorna o e-mail principal do tomador da nota fiscalCaractere
notaFiscalTomador.telefoneretorna o número do telefone fixo do tomador da nota fiscalCaractere
notaFiscalTomador.celularretorna o número do celular do tomador da nota fiscalCaractere
notaFiscalTomador.paisretorna o código Bacen do país do tomador da nota fiscalCaractere
notaFiscalTomador.municipioretorna o código IBGE do município do tomador da nota fiscalCaractere
notaFiscalTomador.numeroDocumentoretorna o número do documento de tomadores estrangeiros relacionados a nota fiscalCaractere
notaFiscalTomador.estrangeiroretorna se o tomador da nota fiscal é estranfeiro Opções possíveis: S - Sim / N - NãoCaractere
notaFiscalTomador.inscricaoEstadualretorna o número da inscrição estadual do tomador da nota fiscalCaractere
notaFiscalTomador.nomeFantasiaretorna o nome fantasia do tomador da nota fiscalCaractere
notaFiscalTomador.optanteSimplesretorna o status do tomador da nota fiscal em relação a opção do simples nacional Opções possíveis: S - Sim / N - NãoCaractere
notaFiscalTomador.porteEmpresaretorna 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 - DemaisCaractere
notaFiscalTomador.websiteretorna o site do tomador da nota fiscalCaractere

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';