CONTEÚDO
01. VISÃO GERAL
A Classe TaxOperandIntegrator foi desenvolvida para viabilizar a recepção de tributos com Operandos de integração no Configurador de Tributos (FISA170), permitindo que valores de tributos sejam recebidos via JSON e integrando dinamicamente à estrutura da do motor de calculo e por consequência, gravando os registros nas tabelas F2D e CJ3 .
Atenção
A classe não tem a funcionalidade de gravar registros em tabelas, e por esse motivo é necessário que a classe seja instanciada no contexto onde a Matxfis esta inicializada, pois as funções internas do motor de calculo continuam com a responsabilidade de realizar a gravação.
Este documento tem o objetivo de demonstrar o funcionamento da classe e seus métodos, e as condições para efetivação do processo.
02. COMO USAR
A Classe TaxOperandIntegrator possibilita receber e processar dados de tributos através de um JSON estruturado, integrando esses valores ao motor de calculo do módulo fiscal em tempo de execução. Para o funcionamento correto, é imprescindível que a classe seja utilizada após a inicialização da MATXFIS (após o carregamento da operação MafisIniLoad) e antes do seu encerramento.
Informação
Todos os tributos que terão os seus valores atribuídos pela classe precisam estar previamente cadastrados no Configurador de Tributos (FISA170), e em seu cadastro conter os Operandos de integração seguindo as Regras do Operando de Integração
03. MÉTODOS
New()
Método construtor da classe.
Exemplo de utilização
Exemplo método new
Using Namespace totvs.protheus.backoffice.fiscal.taxoperandintegrator
Function Exemplo()
Local oIntegrador as Json
oIntegrador := TaxOperandIntegrator():New()
Return
ProcessItemTaxJson()
Método principal que recepciona e processa o JSON de tributos do item, realizando todas as validações necessárias e integrando os valores ao motor de calculo e retornando o feedback após fim do processamento, podendo ser warning ou success.
Informação
O método ProcessItemTaxJson retorna uma string estruturada como JSON com o feedback do processamento
Exemplo de utilização
Exemplo método ProcessItemTaxJson
Using Namespace totvs.protheus.backoffice.fiscal.taxoperandintegrator
Function Exemplo()
Local oIntegrador as Object
Local jDadosTributo as Json
Local cRetorno as Character
// Inicializa o integrador
oIntegrador := TaxOperandIntegrator():New()
// Monta o JSON com dados dos tributos
jDadosTributo := { "1": { ;
"000021": { ;
"base_valor": 1000.00, ;
"aliquota": 18.00, ;
"valor": 180.00, ;
} ;
} }
// Processa os tributos
cRetorno := oIntegrador:ProcessItemTaxJson(jDadosTributo)
Return
04. ESTRUTURA DO JSON
Para o funcionamento correto da classe, é necessário que o JSON contenha a estrutura pré-determinada.
Atenção
A classe TaxOperandIntegrator tem por objetivo preencher as referencias internas do configurador de tributos, sendo assim, mesmo que a propriedade tenha o conteúdo zero ou vazio precisa ser informado, pois se tratando de uma integração para recepção dos tributos e seus respectivos valores não é possível presumir o valor.
A Estrutura é composta por:
- Número do Item (nItem);
- ID do Tributo (para mais informações sobre ID do Tributo consulte aqui);
- Propriedades do Tributo (valores ou dados que serão atualizados nas referencias das tabelas F2D e CJ3).
Informação
A classe segue os mesmo princípios do motor de calculo, MATXFIS, sendo assim, os tributos são atualizados por item. Ou seja, cada item terá um tributo ou n tributos.
Novos tributos
Os novos tributos (tributos da reforma), precisam conter a seguinte estrutura:
Estrutura JSON novos tributos
Exemplo estrutura Json Novos Tributos
numero_item |_id_tributo |_base_valor |_base_quantidade |_base_um |_aliquota |_valor |_esc_CST |_esc_CCT |_esc_vl_tributado |_esc_vl_isento |_esc_vl_outros |_esc_vl_diferido |_esc_pc_diferido |_esc_pc_reducao_base |_esc_base_original |_esc_pc_reducao_aliq |_esc_aliquota_original
Composição JSON
Exemplo JSON
{
"1": {
"000062": {
"base_valor": 0,
"base_quantidade": 10000,
"base_um": "UM",
"aliquota": 10,
"valor": 500,
"esc_CST": "000",
"esc_CCT": "003",
"esc_vl_tributado": 6.55,
"esc_vl_isento": 0.00,
"esc_vl_outros": 0.00,
"esc_vl_diferido": 0.00,
"esc_pc_diferido": 0,
"esc_pc_reducao_base": 0,
"esc_base_original": 0,
"esc_pc_reducao_aliq": 0,
"esc_aliquota_original": 0.00
}
}
}
Atenção
Caso a estrutura não seja respeitada o método retornará um warning e o processamento será interrompido
Propriedades do Tributo (F2D)
| Propriedade | Descrição | Type | Obrigatório? |
|---|---|---|---|
| base_valor | Valor da base do imposto | number | Sim |
| base_quantidade | Valor da base quando é operação com quantidade | number | Não* |
| base_um | Unidade de medida | character | Não* |
| aliquota | Alíquota do tributo | number | Sim |
| valor | Valor do imposto | number | Sim |
Propriedades de escrituração (CJ3)
| Propriedade | Descrição | Type | Obrigatório? |
|---|---|---|---|
| esc_CST | Classificação fiscal | character | Não |
| esc_CCT | CCT IBS/CBS | character | Não |
| esc_vl_tributado | Valor tributado | number | Sim |
| esc_vl_isento | Valor isento | number | Sim |
| esc_vl_outros | Valor outros | number | Sim |
esc_vl_diferido | Valor diferido | number | Não |
esc_pc_diferido | Percentual do diferimento | number | Não |
esc_pc_reducao_base | Percentual da redução | number | Não |
esc_base_original | Base original | number | Não |
esc_pc_reducao_aliq | Percentual de redução de alíquota | number | Não |
esc_aliquota_original | Alíquota original | number | Não |
Base quantidade
* Em casos onde é necessário enviar o valor da base por quantidade é obrigatório o envio de todas as propriedades do tributo, sendo necessário também o preenchimento da propriedade base_um.
Tributos legados
Para o funcionamento correto, os tributos legados (tributos correntes atualmente, antes da reforma) precisam ter pelo menos a seguinte estrutura:
Estrutura JSON tributos legados
Exemplo estrutura Json Tributos legados
numero_item |_id_tributo |_base_valor |_aliquota |_valor
Composição JSON
{
"1": {
"000021": {
"base_valor": 10000,
"aliquota": 10,
"valor": 500,
}
}
}
Propriedades do Tributo (F2D)
| Propriedade | Descrição | Type | Obrigatório? |
|---|---|---|---|
| base_valor | Valor da base do imposto | number | Sim |
| base_quantidade | Valor da base quando é operação com quantidade | number | Não* |
| base_um | Unidade de medida (preenchimento obrigatório caso haja valor na propriedade base_quantidade) | character | Não* |
| aliquota | Alíquota do tributo | number | Sim |
| valor | Valor do imposto | number | Sim |
mva | Índice de cálculo MVA | number | Não |
aux_mva | Índice de cálculo auxiliar do MVA | number | Não |
pauta | Pauta | number | Não |
vl_majorado | Percentual de Majoração | number | Não |
aux_majoracao | Indice auxiliar do percentual de majorção | number | Não |
vl_majoracao | Valor Majoração | number | Não |
pc_majorcao | Alíquota Majoração | number | Não |
aliquota_tribut | Alíquota do Tributo por regra de NCM | number | Não |
ded_dep | Dedução por dependentes | number | Não |
Base quantidade
* Em casos onde é necessário enviar o valor da base por quantidade é obrigatório o envio de todas as propriedades do tributo, sendo necessário também o preenchimento da propriedade base_um, exemplo:
Estrutura com base_valor, base_quantidade e base um
numero_item |_id_tributo |_base_valor |_base_quantidade |_base_um |_aliquota |_valor
Composição JSON
{
"1": {
"000021": {
"base_valor": 0,
"base_quantidade": 10000,
"base_um": "UM",
"aliquota": 10,
"valor": 500,
}
}
}
Propriedades de escrituração (CJ3)
| Propriedade | Descrição | type | Obrigatório? |
|---|---|---|---|
esc_tab_CST | Tabela CST | character | Não |
| esc_CST | CST | character | Não |
| esc_vl_tributado | Valor tributado | number | Sim |
| esc_vl_isento | Valor isento | number | Sim |
| esc_vl_outros | Valor outros | number | Sim |
esc_vl_diferido | Valor diferido | number | Não |
esc_pc_diferido | Percentual do diferimento | number | Não |
esc_pc_reducao_base | Percentual da redução | number | Não |
esc_base_original | Base original | number | Não |
esc_pc_reducao_aliq | Percentual de redução de alíquota | number | Não |
esc_aliquota_original | Alíquota original | number | Não |
Escrituração
Em casos onde é necessário enviar a escrituração é obrigatório que todas as propriedades de escrituração estejam no JSON:
Estrutura JSON tributos legados completa
Estrutura completa JSON Tributo legado
numero_item |_id_tributo |_base_valor |_base_quantidade |_base_um |_aliquota |_valor |_mva |_aux_mva |_pauta |_vl_majorado |_aux_majoracao |_vl_majoracao |_pc_majorcao |_aliquota_tribut |_ded_dep |_esc_tab_CST |_esc_CST |_esc_vl_tributado |_esc_vl_isento |_esc_vl_outros |_esc_vl_diferido |_esc_pc_diferido |_esc_pc_reducao_base |_esc_base_original |_esc_pc_reducao_aliq |_esc_aliquota_original
Composição JSON
Exemplo
{
"1": {
"000021": {
"base_valor": 0,
"base_quantidade": 10000,
"base_um": "UM",
"aliquota": 10,
"valor": 500,
"mva": 0,
"aux_mva": 0,
"pauta" : 0,
"vl_majorado": 0,
"aux_majoracao": 0,
"vl_majoracao": 0,
"pc_majorcao": 0,
"aliquota_tribut": 0,
"ded_dep": 0,
"esc_tab_CST": "000001",
"esc_CST": "001",
"esc_vl_tributado": 6.55,
"esc_vl_isento": 0.00,
"esc_vl_outros": 0.00,
"esc_vl_diferido": 0.00,
"esc_pc_diferido": 0,
"esc_pc_reducao_base": 0,
"esc_base_original": 0,
"esc_pc_reducao_aliq": 0,
"esc_aliquota_original": 0.00
}
}
}
05. REGRAS OPERANDOS DE INTEGRAÇAO
Para que a integração funcione é necessário que o Operando de integração esteja configurado nas seguintes regras:
- Regra de Base
- Regra de Alíquota
- Regra de Cálculo
No caso da Regra de Escrituração ela só será necessária, caso no JSON, seja informada alguma propriedade de escrituração. Caso o contrário a classe respeitará a regra de escrituração amarrada ao tributo, se houver.
Caso alguma dessas configurações não esteja de acordo será retornada uma mensagem de warning e o processamento será interrompido.
06. DOCUMENTOS RELACIONADOS
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas