Descrição dos campos

• Observação
• Relação de campos
• Campos obrigatórios
• Exemplo de chamada
• Exemplo de retorno

Observação

O detalhamento dos campos pode ser obtido no Manual de Conteúdo do webservice de Parametrização Fiscal, pois adotamos nessa API REST os mesmos conceitos, tabelas e estruturas daquele webservice.

 

Relação de campos

Campo	Pai	Descrição
vigente_em	Cenário	Data da regra - Dia/Mês/Ano
remetente	Cenário	Conforme tabela de códigos de origens.
destinatário	Cenário	Conforme tabela de códigos de destinos.
nat_op	Cenário	Conforme tabela de naturezas da operação.
finalidade	Cenário	Finalidade da aquisição (revenda/uso e consumo etc)
ibge_mun_mun_origem	Cenário	Código numérico conforme tabela oficial de municípios do IBGE
ibge_mun_mun_destino	Cenário	Código numérico conforme tabela oficial de municípios do IBGE
uf_origem	Cenário
uf_destino	Cenário
ent_sai	Cenário	Movimento da operação: Saída = s | Entrada = e
cean	Produto	Código GTIN da mercadoria. Deve ser informado sempre que disponível.
cod_prod	Produto	Código do produto cadastrado.
origem_mercadoria	Produto	Origem do produto cadastrado, conforme código oficial de 0 a 8.
ncm	Produto	NCM da mercadoria.
ex_tipi	Produto	Código EX TIPI. Deverá ser informado sempre que disponível.
cest	Produto	Código CEST. Informar quando disponível.
versao_requisicao	Produto	Valor atual = 1
versao_retorno	Produto	Valor atual = 1
username	Produto	Conforme dados de autenticação.
senha	Produto	Conforme dados de autenticação.
metodo	Produto	Informação fixa = cálculo.

Campos obrigatórios

Os campos obrigatórios a serem preenchidos para retorno de regras são:

 

Campo	Obrigatório
Username	Sim
Senha	Sim
EAN	Sim
UF Origem	Sim
UF Destino	Sim
Perfil Origem	Sim
Perfil Destino	Sim
Origem produto	Sim
Entrada ou saída	Sim
cenário	Sim
método	Sim

 

Importante: os campos "cod_prod", "cean", "ncm", "ex_tipi" é obrigatório o preenchimento de ao menos um.

Exemplo de chamada

Chamada:

[  
   {  
      "metodo":"calculo",
      "versao_requisicao":"1",
      "versao_retorno":"1",
      "username": "cliente1",
      "senha": "12345",
      "origem_mercadoria":"0",
      "cean":"",
      "ncm":"22042100",
      "ex_tipi":"",
      "cenario":[  
         {  
            "ent_sai":"E",
            "nat_op":"120",
            "finalidade": "569",
            "uf_origem":"SP",
            "uf_destino":"SP",
            "remetente":"1",
            "destinatario":"140",
            "vigente_em": "16/10/2020"
         }
      ]
   }
]

Exemplo de retorno

{
  "icms": {
    "cfop": "5102",
    "cest": "1702900",
    "cst": "102",
    "generico": "tributos_aproximados_Estadual=7.00;tributos_aproximados_Federal=0.00",
    "vigencia_de": "01/01/2001",
    "dispositivo_legal": "art. 37, I, e § 1º do RICMS/SP. art. 52, I do RICMS/SP"
  },
  "pis": {
    "cst": "49",
    "vigencia_de": "14/12/2006",
    "dispositivo_legal": "Lei Complementar 123/2006",
    "observacoes": "Observar condições da Lei Complementar 123/2006",
    "inf_adicionais": "Lei Complementar 123/2006"
  },
  "cofins": {
    "cst": "49",
    "vigencia_de": "14/12/2006",
    "dispositivo_legal": "Lei Complementar 123/2006",
    "observacoes": "Observar condições da Lei Complemetar 123/2006",
    "inf_adicionais": "Lei Complementar 123/2006"
  }}