Estrutura dos Dados da Request


TAG

PAI

DESCRIÇÃO

OBRIGATÓRIO

request

/

Ocorrência mínima: 1 | Ocorrência máxima: 1

Sim

cabecalho

request

Ocorrência mínima: 1 | Ocorrência máxima: 1

Sim

usuario

cabecalho

Usuário cadatrado no Cockpit

Sim

senha

cabecalho

Senha do usuário do Cockpit

Sim

sessionID

cabecalho

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.

Sim

sisOrig

cabecalho

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.

Sim

dtCalc

cabecalho

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

Sim

ufOrig 

cabecalho

Campo utilizado para informar o Estado de saída da mercadoria.

Sim

ufDest

cabecalho

Campo utilizado para informar o Estado de destino da mercadoria.

Sim

tpNF

cabecalho

Tipo da operação:
0 – Entrada
1 – Saída

Sim

CNAERem

cabecalho

Código CNAE correspondente ao remetente.

Não

CNAEDest

cabecalho

Código CNAE correspondente ao destinatário.

Não

munOrig

cabecalho

Código do município de saída da mercadoria, de acordo com a tabela IBGE (consultar tabela no site do IBGE)

Não

munDest

cabecalho

Código do município de entrada da mercadoria, de acordo com a tabela IBGE (consultar tabela no site do IBGE)

Não

impAtiv

cabecalho

Ativação do cálculo de impostos e adição ao preço de custo:
0 – Sem impostos, ativa o cálculo para embutir os tributos (ICMS, PIS, COFINS).
1 – Com impostos, inativa o cálculo, comportamento padrão.

2 -  calculará preço líquido, o Net_price (custo sem impostos)

4 – Sem impostos, ativa o cálculo para embutir os tributos (ICMS, PIS Crédito, COFINS Crédito).

Ver anexo 2 deste manual para mais detalhes de utilização.

Não

generico

cabecalho

Campo genérico para funções especiais para a request inteira, não deve ser informado se não for especialmente necessário.
Conforme tabela de informações genéricas do cabeçalho. **

Ver tópico "informações genéricas da request" deste manual para mais detalhes de utilização.

Não

chavebanco

cabecalho

Código do Cockpit considerado no cálculo

Permite utilizar um único Motor de Cálculo e vários bancos de dados. As chaves precisam ser previamente cadastradas e informadas no momento do cálculo.

Caso não seja informada, o motor irá procurar por um banco de dados padrão, que poderá ser configurado opcionalmente.

Não

Itens

request

Ocorrência mínima: 1 | Ocorrência máxima: 1

Sim

Item

item

Ocorrência mínima: 1 | Ocorrência máxima: 990

Sim

Id

item

Identificação única de cada item.

Sim

natOp

item

Conforme tabela

Sim

finalidade

item

Código da finalidade do cenário.

Não

perfilRem

item

Obedecerá a tabela e códigos combinada a partir de parâmetros da contratação do serviço.

Sim

perfilDest

item

Obedecerá a tabela e códigos combinada a partir de parâmetros da contratação do serviço.

Sim

cProd

item

Código do produto previamente configurado.

Sim

Orig

item

Inteiro de 0 a 8 conforme tabela.

Sim

cEAN

item

Código de barras do produto

Não

NCM

item

Classificação fiscal do produto

Não

EXTIPI

item

Código EX da TIPI

Não

vProdUni

item

Valor unitário do produto.

Sim

qTrib

item

Quantidade

Sim

vFrete

item

Valor do frete

Não

vSeg

item

Valor do seguro

Não

vOutro

item

Outras despesas acessórias

Não

pDesc item Percentual do desconto incondicional Não

vDesc

item

Valor do desconto incondicional

Não

outrasDesp

item

Outras despesas, para operações de entrada quando aplicável. Ocorrência mínima: 1 | Ocorrência máxima: 1

Não

vII

outrasDesp

Valor Imposto de Importação

Não

bcII

outrasDesp

Base de cálculo do Imposto de Importação

Não

vIOF

outrasDesp

Valor Imposto sobre Operações Financeiras

Não

vEncCamb

outrasDesp

Valor dos encargos cambiais

Não

vDespAdu

outrasDesp

Valor despesas aduaneiras

Não

pCredSN

item

Alíquota do Simples Nacional aplicável no cálculo do crédito pelo contribuinte destinatário.

Não

infCustoAquis

item

Ativação do cálculo do custo de aquisição:
0 ou null – Inativo
1 – Ativo

Não

generico

item

Campo genérico para funções especiais no âmbito do item, não deve ser informado se não for especialmente necessário.
Veja tabela de informações genéricas do item. 

Ver tópico "informações genéricas da request" deste manual para mais detalhes de utilização.

Não

modalidade item

Informar a modalidade de inclusão da margem de lucro.

Ver tópico "Anexo 3: Modalidade da Margem de Lucro" deste manual para mais detalhes de utilização.

Não
margem item percentual de margem de lucro a ser aplicado na formação do preço. Não