# 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**

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-defini%C3%A7%C3%A3o-vige"><tbody><tr><td>**Campo**</td><td>**Definição**</td></tr><tr><td>vigencia\_em</td><td>Consulta todos os registros vigentes na data da consulta informada. Se não for preenchido retorna todos os registros vigentes</td></tr><tr><td>ncm</td><td>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</td></tr><tr><td>ex\_tipi</td><td>Busca registros que contenham EX tipi na NCM informados na consulta. Se não for preenchido retorna todos os registros com e sem Ex</td></tr><tr><td>order</td><td>Array de opções para ordenar, usar campo e a opção separados por pipe</td></tr><tr><td>limit</td><td>Máximo de itens a ser retornado por página. Default = 100</td></tr><tr><td>offset</td><td>Define a posição inicial da paginação. Default = 1</td></tr><tr><td>ID</td><td>ID registro correspondente da tabela tipi interna da Systax</td></tr></tbody></table>

**Retorno**

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-mess"><tbody><tr><td>**Campo**</td><td>**Descrição**</td></tr><tr><td>message</td><td>Retorna se a consulta foi realizada com sucesso ou não</td></tr><tr><td>id</td><td>ID registro correspondente da tabela tipi interna da Systax</td></tr><tr><td>ncm</td><td>NCM</td></tr><tr><td>ex\_tipi</td><td>EX tipi</td></tr><tr><td>vigencia\_de</td><td>Data conforme a publicação da TIPI</td></tr><tr><td>vigencia\_ate</td><td>Data conforme a publicação da TIPI</td></tr><tr><td>aliquota</td><td>Alíquota do IPI conforme publicado na TIPI</td></tr><tr><td>descricao</td><td>Descrição da NCM</td></tr><tr><td>nota</td><td>Informação complementar referente a legislação</td></tr></tbody></table>

**Códigos de retorno**

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-c%C3%B3digo-msg-descri%C3%A7%C3%A3o"><tbody><tr><td>Código</td><td>Msg</td><td>Descrição</td></tr><tr><td>200</td><td>Ok</td><td>Consulta realizada com sucesso</td></tr><tr><td>400</td><td>token\_invalid</td><td>Token inválido</td></tr><tr><td>400</td><td>token\_expired</td><td>Token expirado</td></tr><tr><td>500</td><td>internal\_error</td><td>Erro interno</td></tr></tbody></table>