Skip to main content

Descrição dos campos da chamada e retorno

Chamada

ChamadaTIPO 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 4quatro campos: bcComposicao,bcComposicao, indicadorCredito,indicadorCredito, tipoAntecipacao e bcComposicaoFCPAntecipacao.
SãobcComposicaoFCPAntecipacao.

  • Para os tributos atuais, os quatro campos são aplicáveis.
  • Para a Reforma Tributária, apenas os campos bcComposicao e indicadorCredito devem 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,ricos cujos númerose representam os IDIDs dedas cada uma dessasrespectivas tabelas. Esses IDs correspondem aos códigos retornados nas regras tributárias fornecidas pela Systax.

O preenchimento dos campos é opcional,opcional:

e
se
    for
  • Se enviadoum algumou valormais retornaráIDs forem informados, será retornada a formulafórmula correspondente aoaos IDIDs ouenviados.
    • ID's indicados, e os demais se nao for enviado não retornará.

    Campo tributo: 

    É

  • Se um campo textonão efor informado, ele não será considerado no retorno.

CAMPO TRIBUTO

Este é um campo do tipo texto. Ele pode ser enviado vazio ou preenchido,preenchido.

e
se
    for
  • Quando não preenchido, buscaráo sistema retornará todas as formulasfórmulas disponíveis.
  • Quando preenchido, o sistema retornará apenas as fórmulas aplicáveis aoaos tributos(s)tributos enviado(s).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 preenchidoenviado com:com icms,um icmsst,ou antecipacao,mais pis,tributos, cofins,separados ipipor vírgula.

Exemplos:

  1. "tributo": "icms"
    2. ou
  2. "tributo": "icms, ipi".

CasoTipos sejade enviado o campo tributo deve retornar as fóFórmulas correspondentes:retornadas para cada Tributo:

Campo Tributo

Fórmula correspondente

icmsICMS

bcComposicao + indicador_credito

icmsstICMSST

bcComposicao + indicador_credito

antecipacaoANTECIPACAO

tipoAntecipacao +bcComposicaoFCPAntecipacao + indicadorCredito

pisPIS

pisbcComposicao + indicadorCredito

cofinsCOFINS

cofinsbcComposicao + indicadorCredito

ipiIPI

ipibcComposicao + indicadorCredito

CBS

bcComposicao + indicador_credito

IBSUF

bcComposicao + indicador_credito

IBSMun

bcComposicao + indicador_credito

IS

bcComposicao + indicador_credito

Exemplo: 

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

exemplo.

Retorno

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
Back to top