Produto | Classificação Fiscal Produto (Consultar) - GET

Objetivo

A finalidade deste método é possibilitar a consulta a dados fiscais dos produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/class-fiscal-prod

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Produtos > API Produtos

Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
modelo.CNPJEmpresa	CNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000 Atenção! É recomendado utilizar o filtro de CNPJ ao realizar requisições para esta API.	string	Obrigatório
modelo.idCategoria	Código sequencial do cadastro de categoria.	Integer	Não há
modelo.codigoAcesso	Códigos de acessos associados ao produto (GTIN, Interno, Fornecedor)	string	Quando não informado o IdFornecedor, a busca irá se basear apenas nos tipos de códigos de acesso: EAN, DUN e Interno (E, D e B).
modelo.descricaoProduto	Descrição cadastrada para o produto	string	Não há
modelo.familia	Descrição da família do produto	string	Não há
modelo.dataAtualizacao	Data da ultima atualização Formato: YYYY-MM-DDThh:mm:ss	string	Quando informada a dataAtualizacao serão filtrados os registros que tiveram alteração a partir desta data.
modelo.idFamilia	Código sequencial do cadastro de família do produto	Integer	Não há
modelo.idProduto	Código sequencial do cadastro do produto	Integer	Não há
modelo.idFornecedor	Código sequencial do cadastro de fornecedor	Integer	Quando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F).
modelo._pageNo		Integer	Não há
modelo._pageSize		Integer	Não há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
NCM	Código da Nomenclatura Comum do Mercosul	String	Não há
NumeroTributacao	Número da tributação vinculada ao produto, de acordo com a divisão da empresa consultada	Integer	Não há
CstPISEntrada	Código da Situação Tributária de PIS do produto, em operações de entrada	String	Não há
CstPISSaida	Código da Situação Tributária de PIS do produto, em operações de saída	String	Não há
CstCofinsEntrada	Código da Situação Tributária de Cofins do produto, em operações de entrada	String	Não há
CstCofinsSaida	Código da Situação Tributária de Cofins do produto, em operações de saída	String	Não há
CstIPIEntrada	Código da Situação Tributária de IPI do produto, em operações de entrada	String	Não há
CstIPISaida	Código da Situação Tributária de IPI do produto, em operações de saída	String	Não há
CodigoAcessoPrincipal	Código de acesso principal	String	Não há
IdProduto	Código sequencial do cadastro do produto	Integer	Não há
IdFamilia	Código sequencial do cadastro da família do produto	Integer	Não há
IdProdutoBase	Código sequencial do cadastro do produto base	Integer	Não há
DataUltimaAtualizacao	Data da ultima atualização	String	Não há

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
  "NCM": "string",
  "NumeroTributacao": 0,
  "CstPISEntrada": "string",
  "CstPISSaida": "string",
  "CstCofinsEntrada": "string",
  "CstCofinsSaida": "string",
  "CstIPIEntrada": "string",
  "CstIPISaida": "string",
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}

Árvore de páginas