CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela XXX
    1. Outras Ações / Ações relacionadas
  4. Tela XXX
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


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 MATXFIS.

Este documento tem o objetivo de demonstrar o funcionamento da classe e seus métodos, facilitando a integração de tributos.

02. COMO USAR

A Classe TaxOperandIntegrator possibilita receber e processar dados de tributos através de um JSON estruturado, integrando esses valores à MATXFIS 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.

03. MÉTODOS

New()

Método construtor da classe.

Exemplo de utilização


using 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 à MATXFIS e retornando o feedback após fim do processamento, podendo ser warning ou success.

O método ProcessItemTaxJson retorna uma string estruturada como JSON com o feedback do processamento

Exemplo de utilização

using 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": { ;
        "TRIB01": { ;
            "base_valor": 1000.00, ;
            "aliquota": 18.00, ;
            "valor": 180.00, ;
            "CST": "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:

Novos tributos

Os novos tributos (tributos da reforma), obrigatoriamente precisam conter a seguinte estrutura:

Estrutura JSON novos tributos

    numero_item
		|_id_tributo
			|_base_valor
		 	|_base_quantidade
        	|_base_um
        	|_aliquota
        	|_valor
        	|_CST
        	|_CCT
        	|_vl_tributado
        	|_vl_isento
        	|_vl_outros
        	|_vl_diferido
        	|_pc_diferido
        	|_pc_reducao_base
        	|_base_original
        	|_pc_reducao_aliq
        	|_aliquota_original

Composição JSON


 {
    "1": {
      "000062": {
        "base_valor": 0,
        "base_quantidade": 10000,
        "base_um": "UM",
        "aliquota": 10,
        "valor": 500,
        "CST": "000",
        "CCT": "003",
        "vl_tributado": 6.55,
        "vl_isento": 0.00,
        "vl_outros": 0.00,
        "vl_diferido": 0.00,
        "pc_diferido": 0,
        "pc_reducao_base": 0,
        "base_original": 0,
        "pc_reducao_aliq": 0,
        "aliquota_original": 0.00
      	}
   	}
}


Caso a estrutura não seja respeitada o método retornará um warning e o processamento será interrompido

Propriedades do Tributo (F2D)

PropriedadeDescrição
base_valor

Valor da base do imposto

base_quantidadeValor da base quando é operação com quantidade
base_umUnidade de medida (preenchimento obrigatório caso haja valor na propriedade base_quantidade)
aliquotaAlíquota do tributo
valorValor do imposto



Propriedades de escrituração (CJ3)

PropriedadeDescrição
CSTClassificação fiscal
CCTCCT IBS/CBS
vl_tributadoValor tributado
vl_isentoValor isento
vl_outrosValor outros

vl_diferido

Valor diferido

pc_diferido

Percentual do diferimento

pc_reducao_base

Percentual da redução

base_original

Base original

pc_reducao_aliq

Percentual de redução de alíquota

aliquota_original

Alíquota original

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.

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

    numero_item
		|_id_tributo
			|_base_valor
        	|_aliquota
        	|_valor

 Composição JSON

{
    "1": {
      "000021": {
        "base_valor": 10000,
        "aliquota": 10,
        "valor": 500,
       	}
   	}
}










05. TABELAS UTILIZADAS

Coloque o link das tabelas relacionadas