Tabela de conteúdos
GET - Consulta de Tributação
Este método devolve as regras fiscais cadastradas no ERP Prosyst (ICMS, ICMS-ST, IPI, DIFAL/FCP e IBS/CBS), para que o sistema integrado armazene as regras e recalcule os tributos do seu lado. O método não calcula o imposto de um pedido: ele entrega os percentuais, as reduções e os demais campos de cada regra, exatamente como estão cadastrados.
A consulta é feita um tipo de imposto por vez, informado no parâmetro Imposto, e o retorno é paginado.
/api/tributacao
Exemplo URL
<IP do Serviço>:<Porta liberada para o serviço>/api/tributacao?Imposto=Icms&Pagina=1&TamanhoPagina=500
Parâmetros do Header
| Parâmetro | Descrição |
|---|---|
| auth | Token de autenticação obtido via login. Sem ele, ou com token inválido, o retorno é HTTP 401. |
Parâmetros da URL
Todos os parâmetros vão na URL (query string). Só o Imposto é obrigatório.
| Parâmetro | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
| Imposto | Texto ou número | Sim | Tipo de imposto a consultar. Veja os valores na tabela abaixo. | |
| CodigoMaterial | Texto | Não | Código do material. Retorna as regras do material e também as regras genéricas que valem para ele (pela classificação fiscal/NCM, grupo tributário, classe/tipo e origem da mercadoria). No ICMS e no ICMS-ST, retorna só as regras com UF de origem igual à UF da empresa. | |
| CodigoCliente | Texto | Não | Código do cliente. Retorna as regras da UF do cliente, do grupo tributário dele e, no IBS/CBS, do município dele, além das regras genéricas. No ICMS e no ICMS-ST, retorna só as regras com UF de origem igual à UF da empresa. Pode ser combinado com o CodigoMaterial. |
|
| CodigoEstabelecimento | Número | Não | Estabelecimento padrão | Estabelecimento (filial) em que a consulta é feita. Nas alíquotas de IBS/CBS, retorna também só as regras desse estabelecimento e as que valem para todos. |
| DataInicial | Data (AAAA-MM-DD) | Não | Retorna só as regras cuja vigência começa nesta data ou depois. | |
| DataFinal | Data (AAAA-MM-DD) | Não | Retorna só as regras cuja vigência termina nesta data ou antes. Regras sem data final ficam de fora. Com as duas datas, a vigência da regra precisa estar inteira dentro do período. Nos cadastros de substituição tributária por vigência, que só têm data de início, essa data precisa estar dentro do período. Os cadastros sem vigência ignoram o período. | |
| Ordenacao | Texto ou número | Não | Uf | Ordem dos registros. Veja os valores na tabela abaixo. |
| Pagina | Número | Não | 1 | Página a retornar, a partir de 1. |
| TamanhoPagina | Número | Não | 500 | Quantidade de registros por página, de 1 a 500. |
Pagina até ler a quantidade indicada em TotalRegistros.
Valores do parâmetro Imposto
| Valor | Nº | O que retorna | Filtros aceitos |
|---|---|---|---|
| Icms | 0 | Regras de ICMS: alíquota, redução de base, alíquota interna, diferimento, desoneração e crédito presumido. | material, cliente, período |
| IcmsSt | 1 | Regras de ICMS-ST: MVA, redução de base, alíquota interna, FCP-ST, pauta e PMPF. | material, cliente, período |
| Ipi | 2 | Regras de IPI: percentual, valor fixo e preço de venda no varejo. | material, período |
| IpiClassificacaoFiscal | 3 | Percentual de IPI cadastrado na classificação fiscal (NCM). | material (pela NCM dele) |
| DifalFcp | 4 | DIFAL: alíquota interna da UF de destino, percentual de FCP e indicação de partilha. | material, cliente, período |
| PartilhaDifal | 5 | Percentuais de partilha do DIFAL entre a UF de origem e a UF de destino. | período |
| ClassificacaoTributariaIbsCbs | 6 | Classificações tributárias da Reforma Tributária (cClassTrib), com CST e percentuais de redução do IBS e da CBS. | período |
| VinculoClassificacaoTributariaIbsCbs | 7 | Qual classificação tributária vale para cada material ou faixa de NCM. | material, período |
| AliquotaIbsCbs | 8 | Alíquotas de IBS (UF e município), CBS e Imposto Seletivo. | material, cliente, estabelecimento, período |
Filtro que não se aplica ao imposto informado é ignorado, sem erro.
pct_ipi da consulta de materiais. No cálculo do ERP, vale primeiro a regra de IPI, depois o percentual do material e, por último, o da NCM.
Cadastros retornados no ICMS e no ICMS-ST
No ICMS e no ICMS-ST, o método retorna os mesmos cadastros que o ERP usa no cálculo da nota fiscal. Quais são esses cadastros depende dos parâmetros do sistema 15 configurados na empresa. Quando mais de um cadastro vale, os registros vêm numa única lista, em ordem de prioridade: o ERP usa o primeiro que se aplica ao item e só passa para o seguinte quando não acha regra no anterior.
Os registros vêm sempre no formato do imposto, seja qual for o cadastro de origem. Os campos que o cadastro não tem vêm zerados ou vazios.
ICMS (Imposto=Icms)
| Parametrização | Cadastros retornados, em ordem de prioridade |
|---|---|
UTILIZA-MTTRIB ativo | 1. Tributação de ICMS por material e UF de origem/destino 2. Alíquota de ICMS de saída do cadastro de estados |
UTILIZA-MTTRIB inativo e UTILIZA-CFGICMS ativo | 1. Configuração de regras de ICMS 2. Alíquota de ICMS de saída do cadastro de estados |
UTILIZA-MTTRIB e UTILIZA-CFGICMS inativos | 1. ICMS do material por UF de destino 2. Alíquota de ICMS de saída do cadastro de estados |
A alíquota do cadastro de estados é o padrão: o ERP a usa quando o item não tem regra em nenhum outro cadastro.
ICMS-ST (Imposto=IcmsSt)
| Parametrização | Cadastros retornados, em ordem de prioridade |
|---|---|
UTILIZA-SUBTRIB3 ativo e PR37851-N-USA-CFGSUBTR inativo | 1. Configuração de regras de ICMS-ST 2. Substituição tributária por vigência (por produto, NCM ou UF) |
UTILIZA-SUBTRIB3 ativo e PR37851-N-USA-CFGSUBTR ativo | 1. Substituição tributária por vigência |
UTILIZA-SUBTRIB3 inativo | 1. Substituição tributária por UF e NCM 2. Substituição tributária por UF |
UTILIZA-SUBTRIB3 inativo, com CodigoCliente de um cliente que tem grupo tributário | 1. Configuração de regras de ICMS-ST (fora se PR37851-N-USA-CFGSUBTR estiver ativo) 2. Substituição tributária por vigência 3. Substituição tributária por UF e NCM 4. Substituição tributária por UF |
UTILIZA-SUBTRIB3 inativo, o ERP trata de outro jeito o cliente que tem grupo tributário. O método só consegue aplicar esse tratamento quando recebe o CodigoCliente. Na carga sem cliente, vêm só os cadastros de substituição tributária por UF e NCM e por UF.
Valores do parâmetro Ordenacao
| Valor | Nº | Descrição |
|---|---|---|
| Uf | 0 | UF de origem, UF de destino e número da regra. Nos impostos sem UF, ordena pela vigência inicial. |
| Vigencia | 1 | Data de início da vigência e identificação da regra. |
| Prioridade | 2 | No ICMS e no ICMS-ST, a ordem em que o ERP procura a regra do item: a mais específica primeiro (grupo tributário, material, NCM) e, entre as iguais, a de vigência mais recente. Nos demais impostos, equivale a Vigencia. |
Em IpiClassificacaoFiscal, que não tem vigência, a ordem é sempre pelo código da NCM. Nos cadastros de ICMS e de ICMS-ST sem vigência, Vigencia ordena pela UF.
A ordenação vale dentro de cada cadastro. Quando o imposto retorna mais de um cadastro, eles continuam na ordem de prioridade da tabela Cadastros retornados no ICMS e no ICMS-ST.
Como ler o retorno
- Campo de código zerado ou vazio (material, NCM, grupo tributário, UF) indica uma regra genérica, que vale para qualquer valor daquele campo.
- No ICMS e no ICMS-ST, o método retorna só as regras ativas. Nos demais impostos, retorna as ativas e canceladas. Em todos, vêm as regras vigentes e as não vigentes: use os campos
Situacao,VigenciaInicialeVigenciaFinalpara decidir o que aplicar. - Os cadastros que não têm situação vêm com
Situacao=Ativa. Os que não têm vigência vêm com as datas vazias. - O
TotalRegistrossoma todos os cadastros retornados, e a paginação passa de um cadastro para o seguinte. - Datas vêm no formato ISO 8601. Campos de lista (finalidade, situação, tipo de redução etc.) vêm pelo nome.
- As regras não guardam a data da última alteração. Para manter a base do sistema integrado atualizada, refaça a carga completa periodicamente, ou use a
DataInicialpara buscar as regras que passaram a valer depois da última carga.
Exemplos de Requisição
/api/tributacao?Imposto=Icms /api/tributacao?Imposto=Icms&CodigoCliente=1520&CodigoMaterial=10045&Ordenacao=Vigencia /api/tributacao?Imposto=IcmsSt&CodigoMaterial=10045 /api/tributacao?Imposto=DifalFcp&CodigoCliente=1520 /api/tributacao?Imposto=PartilhaDifal /api/tributacao?Imposto=Icms&DataInicial=2026-01-01&DataFinal=2026-12-31 /api/tributacao?Imposto=AliquotaIbsCbs&CodigoCliente=1520&CodigoMaterial=10045&CodigoEstabelecimento=2&DataInicial=2026-01-01&Pagina=1&TamanhoPagina=200
Exemplos de Retorno
Sucesso — ICMS
{
"TotalRegistros": 1,
"BemSucedido": true,
"MensagemFalha": null,
"NovoCodigo": null,
"Dados": [
{
"NumeroRegra": 245,
"VigenciaInicial": "2026-03-01T00:00:00",
"VigenciaFinal": "2099-12-31T00:00:00",
"UfOrigem": "RS",
"UfDestino": "SC",
"CodigoMaterial": 0,
"ClassificacaoFiscal": 21069090,
"GrupoTributarioCliente": 3,
"GrupoTributarioMaterial": 0,
"ClasseTipo": 0,
"OrigemMercadoria": "",
"Finalidade": "Comercializacao",
"CstIcms": "20",
"PercentualIcms": 12.00,
"PercentualReducao": 41.66667,
"TipoReducao": "BaseCalculo",
"PercentualIcmsInterno": 17.00,
"PercentualDiferimento": 0.0,
"PercentualDiferimentoIndustrializacao": 0.0,
"MotivoDesoneracao": "Nenhum",
"PercentualDesoneracao": 0.0,
"TipoBaseCalculo": "TipoDeRegraPadrao",
"Situacao": "Ativa",
"CreditosPresumidos": [
{ "Sequencia": 1, "Percentual": 2.0000 }
]
}
]
}
Sucesso — Alíquotas de IBS/CBS
{
"TotalRegistros": 1,
"BemSucedido": true,
"MensagemFalha": null,
"NovoCodigo": null,
"Dados": [
{
"Id": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
"CodigoTributo": 1,
"TipoTributo": "Cbs",
"CodigoClassificacao": "000001",
"Uf": "",
"CodigoMunicipio": 0,
"CodigoEstabelecimento": 0,
"CodigoMaterial": 0,
"NcmInicial": 0,
"NcmFinal": 0,
"AliquotaPadrao": 0.9000,
"AliquotaDiferimento": 0.0,
"AliquotaDesoneracao": 0.0,
"AliquotaReducao": 0.0,
"AliquotaCreditoPresumido": 0.0,
"VigenciaInicial": "2026-01-01T00:00:00",
"VigenciaFinal": "2026-12-31T00:00:00",
"Situacao": "Ativo"
}
]
}
Erro
{
"BemSucedido": false,
"MensagemFalha": "Material inexistente no Prosyst.",
"NovoCodigo": null,
"Dados": null
}
Campos retornados por imposto
Icms
- NumeroRegra, VigenciaInicial, VigenciaFinal → identificação e vigência da regra
- UfOrigem, UfDestino → UFs da operação
- CodigoMaterial, ClassificacaoFiscal, GrupoTributarioMaterial, ClasseTipo, OrigemMercadoria → a que produtos a regra se aplica
- GrupoTributarioCliente → a que clientes a regra se aplica
- Finalidade → Todas, Industrializacao, Comercializacao, ConsumoProprio ou VendaParaAtivo
- CstIcms → CST do ICMS
- PercentualIcms, PercentualReducao, TipoReducao (BaseCalculo ou ValorImposto), PercentualIcmsInterno
- PercentualDiferimento, PercentualDiferimentoIndustrializacao
- MotivoDesoneracao, PercentualDesoneracao
- TipoBaseCalculo → se o valor do IPI compõe a base do ICMS
- Situacao → Ativa ou Cancelada
- CreditosPresumidos → lista com Sequencia e Percentual
IcmsSt
- NumeroRegra, VigenciaInicial, VigenciaFinal, UfOrigem, UfDestino, CodigoMaterial, ClassificacaoFiscal, GrupoTributarioCliente, InscricaoEstadual
- TipoRegra → Mva, Mvapmpf ou Difa
- Saída: PercentualMvaSaida, PercentualReducaoBaseSaida, PercentualIcmsInternoSaida, PercentualReducaoSimplesSaida, PercentualDiferencaAliquotaSaida, ValorFixoStSaida, AplicaReducaoSaida
- Entrada: PercentualMvaEntrada, PercentualReducaoBaseEntrada, PercentualIcmsInternoEntrada, PercentualReducaoSimplesEntrada, PercentualDiferencaAliquotaEntrada, AplicaReducaoEntrada
- AplicaConsumoProprio, AplicaVendaAtivo, PrecoMvaPmpf, PercentualFcp, Situacao
- ValorFixoIpi, ValorFixoPis, ValorFixoCofins → valor fixo por unidade, preenchido só nos registros de substituição tributária por vigência
Ipi
- NumeroRegra, VigenciaInicial, VigenciaFinal, CodigoMaterial, ClassificacaoFiscal, GrupoTributarioMaterial
- PercentualIpi, ValorFixoIpi, ValorPrecoVendaVarejo, Situacao
IpiClassificacaoFiscal
- ClassificacaoFiscal, Descricao, PercentualIpi, ReducaoIcmsZonaFranca, Situacao
DifalFcp
- NumeroRegra, VigenciaInicial, VigenciaFinal, UfOrigem, UfDestino, CodigoMaterial
- PercentualIcmsInterno, PercentualFcp, PartilhaUfOrigem, PartilhaUfDestino, FormaCalculo
PartilhaDifal
- NumeroRegra, VigenciaInicial, VigenciaFinal, PercentualUfDestino, PercentualUfOrigem
ClassificacaoTributariaIbsCbs
- Id, CodigoClassificacao (cClassTrib), Descricao, CstIbsCbs
- PercentualReducaoIbs, PercentualReducaoCbs
- TributacaoRegular, ReducaoBaseCalculo, CreditoPresumido, MonofasiaPadrao, MonofasiaRetencao, MonofasiaRetida, MonofasiaDiferimento, EstornoCredito
- VigenciaInicial, VigenciaFinal
VinculoClassificacaoTributariaIbsCbs
- Id, CodigoClassificacao, CodigoClassificacaoRegular, CodigoMaterial, NcmInicial, NcmFinal, VigenciaInicial, VigenciaFinal, Situacao
AliquotaIbsCbs
- Id, CodigoTributo, TipoTributo (Ibsmun, Ibsuf, Cbs ou ImpostoSeletivo), CodigoClassificacao
- Uf, CodigoMunicipio, CodigoEstabelecimento, CodigoMaterial, NcmInicial, NcmFinal
- AliquotaPadrao, AliquotaDiferimento, AliquotaDesoneracao, AliquotaReducao, AliquotaCreditoPresumido
- VigenciaInicial, VigenciaFinal, Situacao
Erros
| Situação | HTTP | Mensagem |
|---|---|---|
Imposto não informado ou inválido | 400 | Algumas validações para a consulta de tributação não foram bem-sucedidas. (com o detalhe de cada campo) |
Pagina menor que 1 ou TamanhoPagina fora de 1 a 500 | 400 | Algumas validações para a consulta de tributação não foram bem-sucedidas. (com o detalhe de cada campo) |
DataInicial maior que DataFinal | 400 | A data inicial não pode ser maior que a data final. |
| Material não encontrado | 400 | Material inexistente no Prosyst. |
| Cliente não encontrado | 400 | Cliente inexistente no Prosyst. |
| Estabelecimento não encontrado | 400 | Estabelecimento não encontrado. |
| Token ausente ou inválido | 401 |