Produto | Tributação Produtos (Consultar) - GET

Objetivo

A finalidade deste método é possibilitar a consulta dos dados tributários dos produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/tributacao-produtos

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	string	Não há
modelo.regimeTributacao	Regime especial de tributação	string	Não há
modelo.uFClienteFornecedor	UF do cliente ou fornecedor para consulta da tributação. Se não informado, é considerada a UF da empresa de consulta.	string	Não há
modelo.tipoTributacao	Tipo de tributação para consulta. ED = Entrada de Distribuidor, EI = Entrada de Indústria, EM = Entrada de Microempresa, SD = Saída para Devolução Distribuidor, SI = Saída para Devolução a Indústria, SM = Saída para Devolução a Microempresa, SC = Saída para Contribuintes, SN = Saída para Não Contribuintes. Padrão: “SN”.	string	Não há
modelo.idCategoria	Código sequencial do cadastro de categoria.	Integer	Não há
modelo.indicaUsaAFV	Indica se usa AFV	String	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.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)
NumeroEmpresa	Número da empresa	Integer	Não há
UFEmpresa	Descrição da categoria	String	Não há
UFDestino	UF do cliente ou fornecedor para consulta da tributação. Se não informado, é considerada a UF da empresa de consulta.	String	Não há
RegimeTributacao	Regime especial de tributação	String	Não há
NumeroDivisao	Número da Divisão da empresa consultada	Integer	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á
TipoTributacao	Ver detalhes do parâmetro “Tipo de Tributação”	String	Não há
CstIcms	Código da situação tributária de ICMS	String	Não há
PercentualICMS	Percentual tributado de ICMS	Number	Não há
PercentualIsentoICMS	Percentual de isenção de ICMS	Number	Não há
AliquotaICMS	Alíquota do ICMS	Number	Não há
AliquotaPIS	Alíquota de PIS	Number	Não há
AliquotaCofins	Alíquota de COFINS	Number	Não há
MVA	Percentual de acréscimo MVA / IVA	Number	Não há
AliquotaICMSST	Alíquota destino para cálculo de ST	Number	Não há
ReducaoBaseICMSST	Percentual redução da base de ICMS ST	Integer	Não há
ValorPautaICMSST	Valor pauta de ICMS ST	Number	Não há
AliquotaIPI	Alíquota de IPI	Integer	Não há
ValorPautaIPI	Valor de pauta de IPI	Number	Não há
AliquotaFCPICMS	Alíquota de FCP ICMS	Number	Não há
UsaPMCBaseST	Usa PMC para cálculo da base de ICMS ST	String	Não há
STConformeEntrada	Utiliza valor da última entrada na base de ICMS ST	String	Não há
SomaIPInoST	Agrega IPI no cálculo do ICMS ST	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):

{
  "NumeroEmpresa": 0,
  "UFEmpresa": "string",
  "UFDestino": "string",
  "RegimeTributacao": "string",
  "NumeroDivisao": 0,
  "NumeroTributacao": 0,
  "TipoTributacao": "string",
  "CstIcms": "string",
  "PercentualICMS": 0,
  "PercentualIsentoICMS": 0,
  "AliquotaICMS": 0,
  "AliquotaPIS": 0,
  "AliquotaCofins": 0,
  "MVA": 0,
  "AliquotaICMSST": 0,
  "ReducaoBaseICMSST": 0,
  "ValorPautaICMSST": 0,
  "AliquotaIPI": 0,
  "ValorPautaIPI": 0,
  "AliquotaFCPICMS": 0,
  "UsaPMCBaseST": "string",
  "STConformeEntrada": "string",
  "SomaIPInoST": "string",
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}

Árvore de páginas