Descrição dos campos de chamada e retorno


Método: GET

Ao enviar a consulta é feita a identificação do cliente de acordo com as credenciais de autenticação.

 

Definição dos campos da requisição

Campo Definição
vigencia_em Consulta todos os registros vigentes na data da consulta informada. Se não for preenchido retorna todos os registros vigentes
ncm Pode ser enviado de 2 a 8 dígitos e busca registros que comecem com o valor enviado e sempre retorna registros com 8 dígitos
ex_tipi Busca registros que contenham EX tipi na NCM informados na consulta. Se não for preenchido retorna todos os registros com e sem Ex
order Array de opções para ordenar, usar campo e a opção separados por pipe
limit Máximo de itens a ser retornado por página. Default = 100
offset Define a posição inicial da paginação. Default = 1
ID ID registro correspondente da tabela tipi interna da Systax

 

Retorno

Campo Descrição
message Retorna se a consulta foi realizada com sucesso ou não
id ID registro correspondente da tabela tipi interna da Systax
ncm NCM
ex_tipi EX tipi
vigencia_de Data conforme a publicação da TIPI
vigencia_ate Data conforme a publicação da TIPI
aliquota Alíquota do IPI conforme publicado na TIPI
descricao Descrição da NCM
nota Informação complementar referente a legislação

 

Códigos de retorno

Código Msg Descrição
200 Ok Consulta realizada com sucesso
400 token_invalid Token inválido
400 token_expired Token expirado
500 internal_error Erro interno