Histórico da Página

Índice

01.

...

Visão Geral

A classe TCIWritten (Tax Configurator Integration Written) foi desenvolvida para viabilizar o acesso aos dados gravados nas tabelas F2D (Tributos Genéricos Calculados)e CJ3 (Tabela Escrituracao por item) do Configurador de Tributos (FISA170) de uma forma dinâmica e intuitiva.

Este documento tem o objetivo de demonstrar o funcionamento da classeTCIWritten

...

e seus os métodos.

02.

...

Introdução

A classe TCIWritten facilita a recuperação de dados específicos das tabelas F2D e CJ3 utilizando métodos que permitem o acesso aos registros por meio de IDs. O retorno dos dados é estruturado no formato JSON, tornando-o fácil de manipular e integrar com outras partes de uma aplicação.

03. Como identificar se uma nota possui cálculos realizados pelo configurador de tributos

Ao inicializar a MATXFIS usando a função MafisIni na rotina de inclusão de documentos de entrada ou saída, é necessário informar que a rotina está apta a processar o configurador de tributos. Essa informação deve ser passada no parâmetro 33.

Por exemplo:

Bloco de código

language	java

...

Utilizando os métodos disponíveis deve-se informar o ID (ou IDs) que se deseja obter os dados, feito isso será retornado o dado em tipo caractere estruturado como Json.

03. MÉTODOS

New()

New() é o método construtor da classe TCIWritten.

Exemplo de implementação

Bloco de código

language	js
theme	Midnight
title	Exemplo implementação New()

Function Exemplo()
	oDados := JsonObject():New()
	
	oDados := TCIWritten():New()

return

SetId()

O método SetId() serve para informa o Id ou Id's que deseja obter as informações.

Exemplo de implementação

Bloco de código

language	js
theme	Midnight
title	Exemplo de implementação SetId()

Function Exemplo()
	oDados := JsonObject():New()
	aIds := {"369ca132-2b3b-ac96-6b78-3247afcc2219","a5dcda40-d145-28d1-c57f-1047e15ce1fe"}
	
	oDados := TCIWritten():New()
	oDados:SetId(aIds)

return

GetDataId()

O método GetDataId() serve para retornar os dados obtidos das tabelas F2D e CJ3 do ID(s) solicitado através do método SetId()

Exemplo de implementação

Bloco de código

language	js
theme	Midnight
title	Exemplo de implementação GetDataId()

Function Exemplo()
	oDados := JsonObject():New()
	aIds := {"369ca132-2b3b-ac96-6b78-3247afcc2219","a5dcda40-d145-28d1-c57f-1047e15ce1fe"}
	cResponse := ""
	
	oDados := TCIWritten():New()
	oDados:SetId(aIds)
	cResponse := oDados:GetDataId()

return cResponse

Informações

title	Informação

Para o correto funcionamento do método GetDataId() é imprescindível informar o(s) ID(s) que deseja os dados através do método SetId(), caso contrário

Exemplo de retorno GetDataId()

Iniciando Mafisini com configurador de Tributos

// Valida a utilização do configurador de tributos
// lCalcTG: variável lógica que indica se a função ChkTrbGen foi encontrada e executada com sucesso
lCalcTG  := IIf(FindFunction("ChkTrbGen"), ChkTrbGen("SD2","D2_IDTRIB"), .F.)

//Inicia os calculos da Matxfis
MaFisIni(SA1->A1_COD, SA1->A1_LOJA, cTipoPar,cTipoNf, SA1->A1_TIPO , MaFisRelImp("MT100",{"SF2","SD2"}),,.T.,,,,,,,,,,,,,,,,,,,,,,,,,lCalcTG)

//...Corpo da função...

// Grava o campo responsável pelo relacionamento do item com o configurador de tributos
If lTrbGen
	SD2->D2_IDTRIB	:= MaFisTG(1,"SD2",nY)
EndIf

Função ChkTrbGen

A função ChkTrbGen responsável por efetuar algumas validações para utilização dos tributos genéricos.

Parâmetros

- - cAlias - Alias da tabela no qual será gravado o ID de relacionamento com a tabela F2D.
  - cCampo - Campo no qual será gravado o ID de relacionamento com a tabela F2D.

Função MaFisTG

A função MaFisTG é resposavel pela gravação e exclusão dos tributos calculados pelo configurador de tributos.

Parâmetros

- - Tipo da operação ( 1- Gravação dos tributos genéricos ou 2 - Exclusão dos tributos genéricos)
  - Alias da tabela
  - Item da nota
  - Id do tributo (Utilizado para exclusão)

04. Como Usar

Para utilizar a classe, instancie um objeto da classe TCIWritten, utilizando namespace totvs.protheus.backoffice.fiscal.tciclass e utilize os métodos disponíveis para informar o ID (ou IDs) dos registros que deseja obter. Os dados serão retornados no formato JSON.

Dica

title	Uso de Namespace

Para mais informações sobre o uso de namespaces, consulte o manual Namespace.

Classes em TLPP que herdam de classe com namespace precisam utilizar o namespace na declaração da classe ou utilizar o namespace no programa que executa a chamada da classe.

Para fontes escritos em TLPP, pode adicionar o namespace no início do arquivo fonte. Por exemplo:

Bloco de código

language	java
theme	Midnight
title	TLPP

#include 'tlpp-core.th'

using totvs.protheus.backoffice.fiscal.tciclass

Function Teste() 

    Local  oDados as object 
    
    oDados := TCIWritten():New()

Return

Para fontes escritos em ADVPL deve ser utilizado por extendo o namespace + classe.

Bloco de código

language	java
theme	Midnight
title	ADVPL

#include "Protheus.CH"

Function Teste()

	Local  oDados as object
	
	//Verifica se a classe existe
	If FindClass("totvs.protheus.backoffice.fiscal.tciclass.TCIWritten")
		oDados := totvs.protheus.backoffice.fiscal.tciclass.TCIWritten():New()
	Endif

Return

05. Métodos

New()

Descrição

O construtor da classe. Inicializa um novo objeto da classe TCIWritten.

Exemplo de implementação

Bloco de código

language	js
theme	Midnight
title	Exemplo implementação New()

	oDados := TCIWritten():New()

SetId()

Descrição

Define os IDs dos registros que se deseja obter os dados. Pode ser um único ID ou uma lista de IDs.

Parâmetros

- - ids (array): Lista de IDs dos registros.

Exemplo de implementação

Bloco de código

language	js
theme	Midnight
title	Exemplo de implementação SetId()

// Definindo um único ID
	aIds := {"369ca132-2b3b-ac96-6b78-3247afcc2219"}

	oDados := TCIWritten():New()
	oDados:SetId(aIds)

// Definindo múltiplos IDs
	aIds := {"369ca132-2b3b-ac96-6b78-3247afcc2219","a5dcda40-d145-28d1-c57f-1047e15ce1fe"}
	
	oDados := TCIWritten():New()
	oDados:SetId(aIds)

GetDataId()

Descrição

Recupera os dados dos registros definidos pelos IDs.

Retorno

- - json: Dados dos registros no formato JSON.

Exemplo de implementação

Bloco de código

language	js
theme	Midnight
title	Exemplo de implementação GetDataId()

	aIds := {"ec451397-7b97-8114-a231-74a1490e1417"}
	cResponse := ""
	
	oDados := TCIWritten():New()
	oDados:SetId(aIds)
	cResponse := oDados:GetDataId()

Informações

title	Informação

Para o correto funcionamento do método GetDataId() é imprescindível informar o(s) ID(s) que deseja os dados através do método SetId(), caso contrário será retornado uma mensagem: "erro - Necessita informar Id"

Exemplo de retorno GetDataId()

Bloco de código

language	js
theme	Midnight
title	Exemplo de retorno GetDataId()

{
  "dados_Id": {
    "ec451397-7b97-8114-a231-74a1490e1417": {
      "TRIB01-XIFIS26": {
        "filial": "XIFIS26",
        "tributo": "ICMS",
        "base_tributo ": 12130.8,

Bloco de código

language	js
theme	Midnight
title	Exemplo de retorno GetDataId()

{
  "dados_Id": {
    "ec451397-7b97-8114-a231-74a1490e1417": {
      "TRIB01-XIFIS26": {
        "filial": "XIFIS26",
        "tributo": "ICMS",
        "base_tributo ": 12130.8,
        "aliquota_tributo": 18,
        "valor_tributo": 2183.54,
        "valor_urf": 0,
        "mva": 0,
        "valor_pauta": 0,
        "percentual_majora": 0,
        "indice_aux_majora": 0,
        "tributo_majora": "",
        "aliquota_majora": 0,
        "valor_majora": 0,
        "ded_dependentes": 0,
        "dados_escriturados": {
          "filial": "XIFIS26",
          "codigo_tributo": "TRIB01",
          "valor_tributado": 0,
          "cst": "90",
          "valor_isento": 0,
          "valor_outros": 12130.8,
          "valoraliquota_nao_tributadotributo": 018,
          "valor_diferidotributo": 02183.54,
          "valor_majoradourf": 0,
          "perc_majoradomva": 0,
          "percvalor_diferidopauta": 0,
          "percpercentual_reducaomajora": 0,
          "valorindice_aux_pautamajora": 0,
          "mvatributo_majora": 0"",
          "indaliquota_aux_mvamajora": 0,
          "Ind_auxvalor_majora": 0,
          "codigoded_tab_cstdependentes": "000001"0,
          "valordados_base_originalescriturados": 0{
        }
  "filial": "XIFIS26",
    },
      "TRIB02-XIFIS26codigo_tributo": {
"TRIB01",
          "filialvalor_tributado": "XIFIS26"0,
          "tributocst": "IPI90",
          "basevalor_tributo isento": 110280,
          "aliquotavalor_tributooutros": 1012130.8,
          "valor_tributonao_tributado": 1102.80,
          "valor_urfdiferido": 0,
          "mvavalor_majorado": 0,
          "valorperc_pautamajorado": 0,
          "percentualperc_majoradiferido": 0,
          "indiceperc_aux_majorareducao": 0,
          "tributovalor_majorapauta": ""0,
          "aliquota_majoramva": 0,
          "valorind_aux_majoramva": 0,
          "dedInd_aux_dependentesmajora": 0,
          "dadoscodigo_tab_escrituradoscst": {"000001",
          "filialvalor_base_original": "XIFIS26",0
        }
  "codigo_tributo": "TRIB02",
    },
      "valor_tributadoTRIB02-XIFIS26": 0,{
          "cstfilial": "49XIFIS26",
          "valor_isentotributo": 0"IPI",
          "valorbase_outrostributo ": 11028,
          "valoraliquota_nao_tributadotributo": 010,
          "valor_diferidotributo": 01102.8,
          "valor_majoradourf": 0,
          "perc_majoradomva": 0,
          "percvalor_diferidopauta": 0,
          "percpercentual_reducaomajora": 0,
          "valorindice_aux_pautamajora": 0,
          "mvatributo_majora": 0"",
          "indaliquota_aux_mvamajora": 0,
          "Ind_auxvalor_majora": 0,
          "codigoded_tab_cstdependentes": "000003"0,
          "valordados_base_originalescriturados": 0{
         }
 "filial": "XIFIS26",
    },
      "TRIB03-XIFIS26codigo_tributo": {"TRIB02",
          "filialvalor_tributado": "XIFIS26"0,
          "tributocst": "PIS49",
          "basevalor_tributo isento": 110280,
          "aliquotavalor_tributooutros": 1.6511028,
          "valor_nao_tributotributado": 181.960,
          "valor_urfdiferido": 0,
          "mvavalor_majorado": 0,
          "valorperc_pautamajorado": 0,
          "percentualperc_majoradiferido": 0,
          "indiceperc_aux_majorareducao": 0,
          "tributovalor_majorapauta": ""0,
          "aliquota_majoramva": 0,
          "valorind_aux_majoramva": 0,
          "dedInd_aux_dependentesmajora": 0,
          "dadoscodigo_tab_escrituradoscst": {"000003",
          "filialvalor_base_original": "XIFIS26",0
        }
  "codigo_tributo": "TRIB03",
    },
      "valor_tributadoTRIB03-XIFIS26": 181.96,{
          "cstfilial": "70XIFIS26",
          "valor_isentotributo": 0"PIS",
          "valorbase_outrostributo ": 011028,
          "valoraliquota_nao_tributadotributo": 01.65,
          "valor_diferidotributo": 0181.96,
          "valor_majoradourf": 0,
          "perc_majoradomva": 0,
          "percvalor_diferidopauta": 0,
          "percpercentual_reducaomajora": 0,
          "valorindice_aux_pautamajora": 0,
          "mvatributo_majora": 0"",
          "indaliquota_aux_mvamajora": 0,
          "Ind_auxvalor_majora": 0,
          "codigo_tab_cst"ded_dependentes": "000005"0,
          "valordados_base_originalescriturados": 0{
        }
  "filial": "XIFIS26",
    },
      "TRIB04-XIFIS26codigo_tributo": {
"TRIB03",
          "filialvalor_tributado": "XIFIS26"181.96,
          "tributocst": "COF70",
          "basevalor_tributo isento": 110280,
          "aliquotavalor_tributooutros": 7.60,
          "valor_nao_tributotributado": 838.130,
          "valor_urfdiferido": 0,
          "mvavalor_majorado": 0,
          "valorperc_pautamajorado": 0,
          "percentualperc_majoradiferido": 0,
          "indiceperc_aux_majorareducao": 0,
          "tributovalor_majorapauta": ""0,
          "aliquota_majoramva": 0,
          "valorind_aux_majoramva": 0,
          "dedInd_aux_dependentesmajora": 0,
          "dadoscodigo_tab_escrituradoscst": {"000005",
          "filialvalor_base_original": "XIFIS26",0
          "codigo_tributo": "TRIB04",}
      },
    "valor_tributado  "TRIB04-XIFIS26": 838.13,{
          "cstfilial": "70XIFIS26",
          "valor_isentotributo": 0"COF",
          "valorbase_outrostributo ": 011028,
          "valoraliquota_nao_tributadotributo": 07.6,
          "valor_diferidotributo": 0838.13,
          "valor_majoradourf": 0,
          "perc_majoradomva": 0,
          "percvalor_diferidopauta": 0,
          "percpercentual_reducaomajora": 0,
          "valorindice_aux_pautamajora": 0,
          "mvatributo_majora": 0"",
          "indaliquota_aux_mvamajora": 0,
          "Ind_auxvalor_majora": 0,
          "codigoded_tab_cstdependentes": "000006"0,
          "valordados_base_originalescriturados": 0{
          }
"filial": "XIFIS26",
           }
"codigo_tributo": "TRIB04",
           }
  }
}

Descrição das propriedades contidas no tributo

...

Descrição das propriedades contidas em dados escriturados

...

"valor_tributado": 838.13,
          "cst": "70",
          "valor_isento": 0,
          "valor_outros": 0,
          "valor_nao_tributado": 0,
          "valor_diferido": 0,
          "valor_majorado": 0,
          "perc_majorado": 0,
          "perc_diferido": 0,
          "perc_reducao": 0,
          "valor_pauta": 0,
          "mva": 0,
          "ind_aux_mva": 0,
          "Ind_aux_majora": 0,
          "codigo_tab_cst": "000006",
          "valor_base_original": 0
        }
      }
    }
  }
}

Descrição das propriedades contidas no tributo

Propriedade	Tipo	Descrição
filial	caractere	Filial da operação
tributo	caractere	Sigla do tributo
base_tributo	número	Valor da base do tributo
aliquota_tributo	número	Alíquota do tributo
valor_tributo	número	Valor do tributo
valor_urf	número	Valor da URF
mva	número	Valor do MVA
valor_pauta	número	Valor pauta
percentual_majora	número	Percentual majorado
indice_aux_majora	número	Índice auxiliar majoração
tributo_majora	caractere	Tributo majorado
aliquota_majora	número	Alíquota majorada
valor_majora	número	Valor majorado
ded_dependentes	número	Dedução por dependentes

Descrição das propriedades contidas em dados escriturados

Atributo	Tipo	Descrição
Filial	caractere	Filial da operação
valor_tributado	número	Valor tributado
cst	caractere	CST
valor_isento	número	Valor isento
valor_outros	número	Valor outros
valor_nao_tributado	número	Valor não tributado
valor_deferido	número	Valor deferido
valor_majorado	número	Valor majorado
perc_majorado	número	Percentual majorado
perc_diferido	número	Percentual diferimento
perc_redução	número	Percentual redução
valor_pauta	número	Valor pauta
mva	número	MVA
ind_aux_mva	número	Índice auxiliar MVA
ind_aux_majora	número	Índice auxiliar majorado
codigo_tab_cst	caractere	Cod. Tabela CST
valor_base_original	número	Valor base original

Destroy()

Descrição

Libera os recursos utilizados pela instância da classe TCIWritten.

Exemplo de implementação

Bloco de código

language	js
theme	Midnight
title	Exemplo de implementação destroy()

	aIds := {"369ca132-2b3b-ac96-6b78-3247afcc2219","a5dcda40-d145-28d1-c57f-1047e15ce1fe"}
	cResponse := ""
	
	oDados := TCIWritten():New()
	oDados:SetId(aIds)
	cResponse := oDados:GetDataId()

	oDados:destroy()

Aviso

title	Atenção

Todos os exemplos demonstrados nesta documentação são fictícios, criados com intuito de orientar, cabendo ao desenvolvedor aplicar os conceitos demonstrados da forma que atenda plenamente as necessidades da operação.

06. Exemplo Completo de Implementação

destroy()

O método destroy() vai limpar tudo que estiver em memória da classe TCIWritten

...

Bloco de código

language	js
theme	Midnight
title	Exemplo de implementação destroy()Completo de Implementação

using totvs.protheus.backoffice.fiscal.tciclass

Function Exemplo()
	Local  aIds as array
	Local  cResponse as character
    Local  oDados as object

    Function Exemplo()
	oDados := JsonObject():New()
	aIds := {"369ca132ec451397-2b3b7b97-ac968114-6b78-3247afcc2219","a5dcda40-d145-28d1-c57f-1047e15ce1fea231-74a1490e1417"}
	    cResponse := ""
	
	
     
    oDados := TCIWritten():New()
	    oDados:SetId(aIds)
	    cResponse := oDados:GetDataId()

	oDados:destroy()

return cResponse

Aviso

title	Atenção

Todos os exemplos demonstrados nesta documentação são fictícios, criados com intuito de orientar, cabendo ao desenvolvedor aplicar os conceitos demonstrados da forma que atenda plenamente as necessidades da operação.

 
Return cResponse

Árvore de páginas

Versões comparadas

Versão antiga 15

Nova versão 36

Chave

01.

Visão Geral

02.

Introdução

03. Como identificar se uma nota possui cálculos realizados pelo configurador de tributos

03. MÉTODOS

New()

Exemplo de implementação

SetId()

Exemplo de implementação

GetDataId()

Exemplo de implementação

Exemplo de retorno GetDataId()

Função ChkTrbGen

Função MaFisTG

04. Como Usar

05. Métodos

New()

SetId()

GetDataId()

Descrição das propriedades contidas no tributo

Descrição das propriedades contidas em dados escriturados

Destroy()

06. Exemplo Completo de Implementação

destroy()