Método que permite consultar a tributação dos produtos.
GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Tributacao
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 Cadastros Estruturais > API Cadastros Estruturais
Imagem 01 - Configurações de Sistemas/Módulos/Aplicações
N/A
|
O não cumprimento dos Pré-Requisitos a seguir pode impactar o sistema. Confirme as condições exigidas antes de qualquer alteração.
N/A
N/A
AdicionarCategoriaReqDto
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
IdTributacao | Identificador da tributação | array[integer] | Não há. |
IdTributacaoExterno | Identificador externo da tributação | array[integer] | Não há. |
DtaHorAlteracao | Data Hora de Alteração | string($date-time) | Formato: YYYY-MM-DDTHH:MM:SSZ |
| Expand | Propriedade que expande os campos | string | Não há. |
Fields | Campos | string | Não há. |
| Order | Ordenação dos campos | string | Não há. |
Page | Número da Página | integer($int32) | Não há. |
| PageSize | Tamanho da Página | integer($int32) | Não há. |
Não há.
CODE 200 - SUCCESS
BuscarPorFiltroTributacaoResDto
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| idTributacao | Identificador da tributação | integer($int64) | Não há. |
| idTributacaoExterno | Identificador externo da tributação | long | Não há. |
| descricao | Descrição da tributação Máximo de 60 caracteres | string | Não há. |
| descAplicacao | Descrição da Aplicação Descreve a aplicação da tributação Máximo de 160 caracteres | string | Não há. |
| advEntradaNf | Advertência na Entrada Máximo de 160 caracteres | string | Não há. |
| situacEspecialTrib | Situação Especial Máximo de 12 caracteres | string | Não há. |
| status | Status Limitado aos valores: 'I' - inativo / 'A' - Ativo | string | Não há. |
| aceitaPauta | Aceita Informar Pauta Limitado aos valores: 'S' - Sim / 'N' - Não | string | Não há. |
| tributacaoUf | Lista de tributações por UF vinculado a tributação principal | object | Informação retornado quando solicitado no Request pelo filtro Expand |
{
"hasNext": true,
"items": [
{
"expandables": [
"string"
],
"idTributacao": 0,
"idTributacaoExterno": 0,
"descricao": "string",
"descAplicacao": "string",
"advEntradaNf": "string",
"situacEspecialTrib": "string",
"status": "string",
"aceitaPauta": "string",
"tributacaoUf": [
{
"idTributacao": 0,
"ufEmpresa": "string",
"ufClienteFornecedor": "string",
"tipo": "string",
"idRegTributacao": 0,
"percTributado": 0,
"percIsento": 0,
"percOutro": 0,
"percAliqIcms": 0,
"percAcrescSt": 0,
"percAliqSt": 0,
"tipoApropriacaoSt": "string",
"pautaIcms": "string",
"percAntecipado": 0,
"percPresumido": 0,
"observacao": "string",
"sitTribNf": "string",
"aliqIcmsCalculo": 0,
"somaIPIBaseIcms": "string",
"percAcrescIcmsAntec": 0,
"percDespIcms": 0,
"somaIpiBaseSt": "string",
"percAliqIcmsDiferido": 0,
"reducaoCalculoBaseSt": "string",
"ressarcimentoSt": "string",
"percAliqTare": 0,
"percTributadoSt": 0,
"reducaoBaseIcmsCalculoSt": "string",
"aliqBaseIcmsCalculoSt": "string",
"sitTribPis": "string",
"sitTribCofins": "string",
"codAntecipacaoTrib": 0,
"diaVencimentoSt": 0,
"calculaStConformeAliqCalculoPreco": "string",
"tipoCalculoIcms": 0,
"baseIcmsLivroFiscal": "string",
"aliqDifPis": 0,
"aliqDifCofins": 0,
"aliqStCargaLiquida": 0,
"calculaStConformeEntrada": "string",
"sitTribIpi": "string",
"obsPadraoNf": "string",
"percAcrescIcmsRetido": 0,
"percIcmsRetido": 0,
"percIsentoSt": 0,
"percOutrosSt": 0,
"baseIcmsReduzidaCemPorcento": "string",
"percReducaoBasePis": 0,
"percReducaoBaseCofins": 0,
"sitTribSimplesNacional": "string",
"reduzBaseStAntesSomarIpi": "string",
"calculoIcmsParaDescSuframa": "string",
"calculoDescSuframaParaCalculoSt": "string",
"percReducaoPmc": 0,
"somaIpiBaseIcmsAntecipadoOuResumido": "string",
"codNaturezaReceita": 0,
"idNaturezaReceita": 0,
"deduzDescBaseSt": "string",
"percTributacaoIcmsSuframa": 0,
"percAcrescIcmsAntecipado": 0,
"percReducaoAliqEstornoRJ": 0,
"baseCalculoEstornoCreditoRJ": "string",
"sitTribDevolucao": "string",
"percIcmsResol13": 0,
"percIcmsDiferido": 0,
"somaIpiBaseApenasIcmsDiferido": "string",
"somaFreteBaseIpi": "string",
"percMajoracaoCofinsImportacao": 0,
"percCargaTriutariaMedia": 0,
"utilizaCustoMesBasePonderado": "string",
"percAcrescStResol13": 0,
"percMinimoStRetido": 0,
"percRegimeAtacadista": 0,
"percTributadoCalculado": 0,
"percIsentoCalculado": 0,
"percOutrosCalculado": 0,
"obsPadraoCtrcCte": "string",
"percTributadoAntecipado": 0,
"percIsentoAntecipado": 0,
"percOutrosAntecipado": 0,
"aplicaAcrescStCargaLiquidaSt": "string",
"aliqStCargaLiquidaResol13": 0,
"calculaStEmbutidoProduto": "string",
"percIcmsTare": 0,
"percTributadoResol13": 0,
"percIsentoResol13": 0,
"percOutrosResol13": 0,
"calculaIcmsDesoneradoOutros": "string",
"calculaIcmsCreditoCusto": "string",
"percReducaoCargaTribIcmsDI": 0,
"percMajoracaoPisImportacao": 0,
"aliqInternaUfDestino": 0,
"tipoCalculoPartilhaIcms": "string",
"tipoSomaIpiBaseIcmsAntecipado": "string",
"reduzCreditoIcmsAutoDevFornec": "string",
"tipoCalculoBaseIcmsPresumido": "string",
"permiteReducaoBaseIcmsCalculado": "string",
"sitTribIcmsCalculado": "string",
"aliqIcmsDesoneradoOutros": 0,
"agregaCustoIcmsAntecipado": "string",
"obsPadraoDevolucao": "string",
"percIcmsCalculoResol13": 0,
"baseFcpSt": 0,
"aliqFcpSt": 0,
"tipoCalculoFcpSt": "string",
"baseFcpIcms": 0,
"aliqFcpIcms": 0,
"tipoCalcloFcpIcms": "string",
"calculoIcmsEfetivo": "string",
"percReducaoIcmsEfetivo": 0,
"utilizaIcmsCalculadoReducaoFcpSt": "string",
"tipoCalculoIcmsBonificacao": "string",
"sitTribNfBonificacao": "string",
"contrapartidaStCusto": "string",
"codAjustesInfoAdicionais": "string",
"motivoDesoneracao": 0,
"percDiferido": 0,
"percLimiteReducaoPmc": 0,
"codAjustesInfoAdicionaisDevolucao": "string",
"tipoApropriacaoIcmsFrete": "string",
"dataAlteracao": "2025-08-11T14:24:00.238Z",
"usuarioAlteracao": "string",
"regimeTributacao": {
"idRegTributacao": 0,
"descricao": "string",
"geraDebRecIcmsAntecip": "string",
"status": "string",
"indBaseCalcIcmsAntecip": "string",
"utilRegIcmsVlrItemCalcIcmsSt": "string",
"indSimplesNac": "string",
"indCalcDifAliq": "string",
"indUsaPdv": "string",
"utilOficioCstBrutoBaseSt": "string",
"utilRegimeCargaMedia": "string",
"utilRegimeAtac": "string",
"tipoCalFicioCstBrutoBaseSt": "string",
"indTipoCalcSimples": 0,
"regimeTributacaoUF": [
{
"expandables": [
"string"
],
"idRegTributacao": 0,
"uf": "string",
"status": "string",
"indGnreFatPed": "string"
}
]
}
}
]
}
]
} |
application/json, text/json
CODE 400 - BAD
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"notificationType": 0,
"code": "string",
"message": "string",
"detailedMessage": "string",
"status": 0
}
]
} |
O uso do Tipo de Produto em diferentes tecnologias não homologadas, como em Sistema Operacional, Plataforma, Navegadores e outros dispositivos, pode comprometer a segurança dos sistemas e está sujeito a situações não previstas, sem cobertura de suporte. |
| Tipo de produto | API |
|---|---|
| Sistema Operacional | Inclua a descrição relacionada |
| Plataforma | WEB |
| Navegador | Inclua a descrição relacionada |
| Utilização/Experiência | Aplicações Web em geral |
N/A
| Ação | Descrição |
|---|---|
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
| Inclua a ação | Inclua a descrição relacionada |
Nesta seção, adicione links para os Documentos Técnicos (DTs) que registram mudanças na aplicação, garantindo rastreabilidade das atualizações implementadas.
Inclua documentações relacionadas a Inovação, Legislação ou Manutenção.
Os documentos devem ser organizados do Service Pack mais atual para o mais antigo.
Clique para expandir
| |||||
| |||||
|