Histórico da Página

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

do motor de calculo e por consequência, gravando os registros nas tabelas F2D e CJ3 .

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.

03. MÉTODOS

New()

Método construtor da classe.

Exemplo de utilização

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

...

usingUsing 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": { ;
        "TRIB01000021": { ;
            "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:

Novos tributos

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

Estrutura JSON novos tributos

.

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

Novos tributos

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

Estrutura JSON novos tributos

    numero_item
		|_id_tributo
			|_

    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

 {
    "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
      	}
   	}
}

...

Propriedades do Tributo (F2D)

Propriedades de escrituração (CJ3)

...

...

...

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

    numero_item
		|_id_tributo
			|_base_valor
        	|_aliquota
        	|_valor

 Composição JSON

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

Propriedades do Tributo (F2D)

Propriedades de escrituração (CJ3)

...

tab_CST

...

vl_diferido

...

pc_diferido

...

pc_reducao_base

...

base_original

...

pc_reducao_aliq

...

aliquota_original

...

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:

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

    numero_item
		|_id_tributo
			|_base_valor
		 	|_base_quantidade
        	|_base_um
        	|_aliquota
        	|_valor 
        	|_tab_CST
        	|_CST
        	|_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,
        "tab_CST": "000001",
        "CST": "001",
        "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
      	}
   	}
} 

05. REGRAS OPERANDOS DE INTEGRAÇAO

Novos tributos

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 Escrituração
• Regra de Cálculo

Caso alguma dessas configurações não esteja de acordo será retornada uma mensagem de warning e o processamento será interrompido.

Composição JSON

 {
    "1": {
      "000021": {
        "base_valor": 0,
        "base_quantidade": 10000,
        "base_um": "UM",
        "aliquota": 10,
        "valor": 500,            
		}
    }
}

Propriedades de escrituração (CJ3)

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

    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

 {
    "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 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

• CFGTRIB - Configurador de Tributos
• CFGTRIB - Operandos de Integração