Skip to main content

4 - Estrutura de dados da Requisição do Motor de Cálculo

Campo

Cabeçalho / Item

Descrição

Obrigatório

Valores Aceitos

sessionID

Cabeçalho

Código de qualquer formato gerado pelo cliente e utilizado para obter controle das transações. Recomendamos que seja um código único por requisição.

Não

Texto e numérico

sisOrig

Código numérico que identifica o sistema de origem de request. Controle do cliente e utilizado quando há vários sistemas requisitando o motor de cálculo. Se for utilizar somente 1 solução pra chamar o motor, por exemplo, pode mandar 1 no parâmetro.

Não

Texto e numérico

dtCalc

Data de cálculo a ser considerada na vigência da regra.

Sim

Formato 'YYYY-MM-DD'

finNFe

Finalidade de emissão da NF-e

Não

1 - NF-e normal;
2 - NF-e complementar;
3 - NF-e de ajuste;
4 - NF-e de mercadoria;
5 - NF-e de crédito;
6 - NF-e de débito.

cMunFG

Código do Município de Ocorrência do Fato
Gerador do ICMS

Não

Numérico

cMunFGIBS

Código do Município de consumo, fato
gerador do IBS / CBS

Não

Numérico

Campo

Cabeçalho / Item

Descrição

Obrigatório

Valores Aceitos

tpNFDebito

Cabeçalho

Tipo de Nota de Débito

Não

1=Transferência de créditos para Cooperativas;
2=Anulação de Crédito por Saídas Imunes/Isentas;
3=Débitos de notas fiscais não processadas na apuração;
4=Multa e juros;
5=Transferência de crédito de sucessão;

tpNFCredito

Tipo de Nota de Crédito

Não

Numérico

tpEnteGov

Tipo de ente governamental

Não

1=União
2=Estado
3=Distrito Federal
4=Município

pRedutor

Percentual de redução de alíquota em
compra governamental

Não

Numérico

tpNF

Tipo de Nota da operação

Sim

0 - Entrada
1 - Saida

ufOrigem

Campo utilizado para informar o Estado de saída da operação.

Sim

Texto

municipioOrigem

Código do municipio remetente da operação.

Não

Numérico

ufDestino

Campo utilizado para informar o Estado de destino da operação.

Sim

Texto

municipioDestino

Código do municipio destinatário da operação.

Não

Numérico

ufEntrega

Campo utilizado para informar o Estado de entrega da operação.

Não

Texto

Campo

Cabeçalho / Item

Descrição

Obrigatório

Valores Aceitos

municipioEntrega

Cabeçalho

Código do municipio de entrega da operação.

Não

Numérico

municipioExecucao

Código do municipio de execução da operação.

Não

Numérico

chaveBanco

Código do Cockpit do cliente considerado no cálculo

SimNão

Texto e numérico

id

Item

Identificação única de cada item da requisição

Não

Numérico

idCenario

Código do cenário

Não

Numérico

naturezaOperacao

Código de natureza de operação do cenário.

Sim

Numérico

finalidade

Código da finalidade do cenário.

Não

Numérico

perfilOrigem

Código do perfil remetente da operação.

Sim

Numérico

cnaeOrigem

Código do cnae remetente da operação.

Não

Numérico

perfilDestino

Código do perfil destinatário da operação.

Sim

Numérico

cnaeDestino

Código do cnae destinatário da operação.

Não

Numérico

prestador

Código do perfil prestador da operação.

Não

Numérico

tomador

Código do perfil tomador da operação.

Não

Numérico

executor

Código do perfil executor da operação.

Não

Numérico

cProd

Código do produto previamente configurado.

Sim

Texto e numérico

Campo

Cabeçalho / Item

Descrição

Obrigatório

Valores Aceitos

orig

 

Origem do Produto

Não


0
1
2
3
4
5
6
7
8

cEAN

Item

Código de barras (GTIN) do produto

Não

Numérico

ncm

Classificação fiscal do produto

Não

Numérico

extipi

Código EX da TIPI

Não

Numérico

vProdUni

Valor unitário do produto

Sim

Numérico

qTrib

Quantidade Tributável

Sim

Numérico

uTrib

Unidade Tributável

Não

Texto e numérico

vUnTrib

Valor unitario Tributável

Não

Numérico

vOutro

Valor de outros tributos da operação

Não

Numérico

vAcrescVop

Valor de acréscimo referente ajustes ao valor da operação

Não

Numérico

vJuros

Valor de juros da operação

Não

Numérico

vMultas

Valor de multas da operação

Não

Numérico

vAcresc

Valor de acréscimo da operação

Não

Numérico

vEncargos

Valor de encargos da operação

Não

Numérico

vTransp

Valor de transporte da operação

Não

Numérico

vTributos

Valor de tributos da operação

Não

Numérico

vDescInc

Valor de desconto incondicional da operação

Não

Numérico

vImpSel

Valor de imposto seletivo da operação

Não

Numérico

pDevTrib

percentual de cashback da operação

Não

Numérico