API de solicitação

• Descrição dos campos de chamada
• Descrição dos campos de retorno
• Exemplo de chamada
• Exemplos de retorno

Descrição dos campos de chamada

Um JSON com uma lista de produtos e cenários deve ser informado na chamada da API de solicitação de regras em lote conforme o detalhamento abaixo. Essa API suporta uma lista de 500 regras tributárias.   

 

Campo	Descrição	Tipo
id_cliente	ID do cliente	String
Informações relativas ao produto
Item	Sequencial	String
codigo_produto	Código	String
origem_produto	Origem do material	String
ncm	NCM	String
ex_tipi	ExTIPI	String
ean	EAN	String
descricao	Descrição	String
data_cálculo	Data de cálculo da regra	String
Informações relativas ao cenário
uf_origem	UF origem	String
uf_destino	UF destino	String
natureza_operacao	Natureza de operação	String
perfil_origem	Perfil de origem	String
perfil_destino	Perfil de destinação	String
finalidade	Finalidade(somente para cenários de entrada)	String
ent_sai	Tipo de entrada e saída	String
municipio_origem	Múnicípio de origem	String
municipio_destino	Múnicípio de destino	String

 

Para obter os códigos de referência para o preenchimentos dos campos de origem do produto, natureza de operação, perfil origem, perfil destino e finalidade, acesse a última versão do manual de "Tabelas Auxiliares".

 

Tabela de referência do campo "ent_sai":

Código	Tipo entrada/saída
0	Entrada
1	Saída

 

Descrição dos campos de retorno

Campo	Descrição	Tipo
protocolo	Número do protocolo	String
data	Data e hora de geração do protocolo	String
success	Status	Boolean
message	Mensagem do status	String

 

Observação: O protocolo gerado será informado na API de retorno para obter o resultado do cálculo das regras tributárias. Ele deve ser armazenado para consultas posteriores.

 

Tabela de referência dos campos "success" e "message":

Código de retorno	Descrição	success	message
200	/	true	Consulta enviada com sucesso
400	Produto inválido - é necessário informar uma das combinações de campos: (codigo_produto + origem_produto + ncm + ean) OU (codigo_produto + origem_produto) OU (ncm + origem_produto) OU (ean + origem_produto)	false	Dados inválidos
400	Cenário inválido - é necessário informar os campos uf_origem, uf_destino, natureza_operacao, perfil_origem, perfil_destino e ent_sai	false	Dados inválidos
401	/	false	Não autorizado

 

 

Exemplo de chamada

Lista de produtos e cenários em JSON:

{
  "id_cliente": "id do cliente",
  "produtoCenario": [
    {
      "produtos": [
        {

         "Item": "1"
          "codigo_produto": "codigo do produto",
          "origem_produto": "1",
          "ncm": "",
          "ex_tipi": "",
          "ean": "",
          "descricao": "",
          "data_calculo": "2020-01-01"
        }
      ],
      "cenario": {
        "uf_origem": "EX",    
        "uf_destino": "PI",
        "natureza_operacao": "43",
        "perfil_origem": "682",
        "perfil_destino": "1",
        "finalidade": "43",
        "ent_sai": "0",
        "municipio_origem": "",
        "municipio_destino": ""
      }
    }    
  ]
}

Exemplos de retorno

{
  "data": {
    "protocolo": "5987a877-cd91-400d-a20d-f8bdbee50993",
    "data": "2021-03-18T14:13:13.4988597+00:00"
  },
  "success": true,
  "message": "Consulta enviada com sucesso",
  "record_count": null
}