Descrição dos campos da chamada e retorno
Chamada
TIPO DE CONSULTA
A API permite consultar as fórmulas dos tributos atuais e também as fórmulas dos tributos da Reforma Tributária. Para diferenciar o tipo de consulta, a API utiliza o campo "RT".
Para consultar as fórmulas dos tributos da Reforma, é necessário enviar na chamada o campo "RT" preenchido com "true".
Caso não seja enviado este campo na chamado ou caso este seja enviado mas preenchido com algo diferente de "true", a API retornará as fórmulas dos tributos atuais.
BLOCOS E CAMPOS DA CHAMADA
Bloco "formulaEspecifica":
Este bloco é composto por quatro campos: bcComposicao, indicadorCredito, tipoAntecipacao e bcComposicaoFCPAntecipacao.
- Para os tributos atuais, os quatro campos são aplicáveis.
- Para a Reforma Tributária, apenas os campos
bcComposicaoeindicadorCreditodevem ser utilizados.
Portanto, nas consultas de fórmulas relacionadas à Reforma Tributária, devem ser enviados apenas esses dois campos do bloco formulaEspecifica.
Todos os campos são numéricos e representam os IDs das respectivas tabelas. Esses IDs correspondem aos códigos retornados nas regras tributárias fornecidas pela Systax.
O preenchimento dos campos é opcional:
- Se um ou mais IDs forem informados, será retornada a fórmula correspondente aos IDs enviados.
- Se um campo não for informado, ele não será considerado no retorno.
CAMPO TRIBUTO
Este é um campo do tipo texto. Ele pode ser enviado vazio ou preenchido.
- Quando não preenchido, o sistema retornará todas as fórmulas disponíveis.
- Quando preenchido, o sistema retornará apenas as fórmulas aplicáveis aos tributos informados.
Valores Aceitos:
-
Tributos atuais:
icms,icmsst,antecipacao,pis,cofins,ipi -
Tributos da Reforma Tributária:
CBS,IBSUF,IBSMun,IS
Formato de preenchimento:
O campo pode ser enviado com um ou mais tributos, separados por vírgula.
Exemplos:
- "tributo": "icms"
- "tributo": "icms, ipi".
Retorno
Descrição
|
API |
Definições |
|
"indicador" |
corresponde ao ID da fórmula na tabela especifica |
|
"descricao" |
descreve a definição da fórmula. Por exemplo, bcComposicao=1, descrição: valor da operação com IPI |
|
"formula" |
é a fórmula a ser utilizada para cálculo do ID correspondente |
|
"tributo" |
indica os tributos que podem ser calculados com essa fórmula |
|
"observacoes" |
indica particularidades aplicadas a fórmula |
Tipos de Fórmulas retornadas para cada Tributo:
|
Campo Tributo |
Fórmula correspondente |
|
ICMS |
bcComposicao + indicador_credito |
|
ICMSST |
bcComposicao + indicador_credito |
|
ANTECIPACAO |
tipoAntecipacao +bcComposicaoFCPAntecipacao + indicadorCredito |
|
PIS |
bcComposicao + indicadorCredito |
|
COFINS |
bcComposicao + indicadorCredito |
|
IPI |
bcComposicao + indicadorCredito |
|
CBS |
bcComposicao + indicador_credito |
|
IBSUF |
bcComposicao + indicador_credito |
|
IBSMun |
bcComposicao + indicador_credito |
|
IS |
bcComposicao + indicador_credito |
Exemplo: Se for enviado "tributo": "icms" retornará tudo relativo a "bcComposicao" e "indicadorCredito" que se aplica para este tributo. Sendo assim, não deve retornar bcComposicao aplicável apenas para ipi, por exemplo.
Retorno
|
|
|
|
|
|
|
|
|
|
|
|