Financeiro x TAF (classe TafIntegration)

01. VISÃO GERAL

Classe de uso interno da Totvs

Classe que permite integração nativa do módulo Financeiro com o Totvs Automação Fiscal (TAF).

Nome da classe: totvs.protheus.backoffice.fin.taf.integration.TafIntegration

Documentação de projeto: Integração com TAF / TGI (uso interno)

Necessário FINA989 com data igual ou superior a 01/04/2024 e FINXREINF com data igual ou superior a 15/09/2023.

02. MÉTODOS

setParameters()

Define os parâmetros da consulta aos dados do Financeiro.

Parâmetros:

Nome

Tipo

Descrição

Obrigatório

Valor

padrão

jParameters

json

Json com os parâmetros da consulta, conforme abaixo.

Sim

Estrutura esperada no json de parâmetros

Nome	Tipo	Descrição	Obrigatório	Valor padrão
branch	character	Filial do Protheus que será consultada (informar código completo)	Sim
initialDate	date	Data inicial	Sim
finalDate	date	Data final	Sim
typeDatePayable	character	Data que será considerada para o contas a pagar (1 = contabilização, 2 = emissão)	Sim
typeDateReceivable	character	Data que será considerada para o contas a receber (1 = contabilização, 2 = emissão)	Sim
event4020	character	REINF: Define se a consulta deverá retornar registrod o bloco 40 ou do bloco 20 (informar "40" ou "20")	Não	"40"
pageSize	numeric	Quantidade de registros por página	Não	100

Retorno: não há

getBills()

Retorna um json no padrão oData com os dados dos títulos financeiros conforme parâmetros definidos praviamente.

Parâmetros:

Nome	Tipo	Descrição	Obrigatório	Valor padrão
nPage	numeric	Página que está sendo consultada	Não	1

Retorno:

Propriedade	Tipo	Descrição
hasNext	logical	Indica se há mais páginas para consulta
remainingRecords	numeric	Número de registros restantes
items[]	JSON[]	Lista de títulos
items[].branch	character	Filial do título financeiro
items[].billPrefix	character	Prefixo do título financeiro
items[].billNumber	character	Número do título financeiro. Se possuir múltiplas parcelas e não for oriundo de nota fiscal, recebe a parcela como sufixo separado por hífem. Exemplo: "123456-A"
items[].billDate	character	Data de emissão ou contabilização do título (conforme parâmetros typeDatePayable e typeDateReceivable)
items[].billOriginType	character	Origem do documento (1 = Oriundo de nota fiscal; 2 = Título avulso)
items[].participatingCode	character	Código do cliente/fornecedor (mesma regra do extrator)
items[].operationType	character	Operação (0 = A Pagar; 1 = A Receber)
items[].finSentTaf	character	Situação de integração com o TAF (1 = Enviado ao TAF; 2 = Não enviado) - FKF_REINF
items[].modelIdentificationCode	character	Código do modelo do documento fiscal de origem do título
items[].documentNumber	character	Número da nota fiscal
items[].documentSeries	character	Série da nota fiscal
items[].documentValue	numeric	Valor bruto da nota fiscal
items[].natureOfIncome	JSON	Naturezas de rendimento
items[].natureOfIncome.code	character	Código da natureza de rendimentos

getWriteOff()

Retorna um json no padrão oData com os dados das baixas financeiras conforme parâmetros definidos praviamente.

Parâmetros:

Nome	Tipo	Descrição	Obrigatório	Valor padrão
nPage	numeric	Página que está sendo consultada	Não	1

Retorno:

Propriedade	Tipo	Descrição
hasNext	logical	Indica se há mais páginas para consulta
remainingRecords	numeric	Número de registros restantes
items[]	JSON[]	Lista de baixas
items[].branch	character	Filial do título financeiro
items[].billPrefix	character	Prefixo do título financeiro
items[].billNumber	character	Número do título financeiro
items[].billInstallment	character	Parcela do título financeiro
items[].paymentDate	character	Data da baixa
items[].paymentSequence	character	Sequência da baixa
items[].finSentTaf	character	Situação de integração com o TAF (1 = Enviado ao TAF; 2 = Não enviado) - FK2_REINF
items[].participatingCode	character	Código do cliente/fornecedor (mesma regra do extrator)
items[].operationType	character	Operação (0 = A Pagar; 1 = A Receber)
items[].natureOfIncome	JSON	Naturezas de rendimento
items[].natureOfIncome.code	character	Código da natureza de rendimentos

Exemplo de retorno

{
  "items": [
    {
      "branch": "D MG 01",
      "billNumber": "F989CT014",
      "billPrefix": "RNF",
      "billInstallment": "",
      "paymentDate": "2023-1-5",
      "paymentSequence": "01",
      "finSentTaf": "2",
      "participatingCode": "RNF01501F",
      "operationType": "0",
      "natureOfIncome": [{ "code": "15010" }]
    }
  ],
  "hasNext": false,
  "remainingRecords": 0
}

03. EXEMPLOS DE USO

Exemplo

method loadData() class MyIntegration

    local oFin as object
    local jParameters := JsonObject():new() as Json
    local lHasNext := .T. as logical
    local jResponse as json
    local nPage := 1 as numeric
    local cFili := 'D MG 01' as character
    local cPathBills  := 'C:\TEMP\Json_TAF\json_bills'+FWUUIDV4()+'.json' as character
    local cPathWriteOff  := 'C:\TEMP\Json_TAF\json_WriteOff'+FWUUIDV4()+'.json' as character

    oFin := totvs.protheus.backoffice.fin.taf.integration.TafIntegration():new()

    jParameters['branch'] := "D MG 01 "
    jParameters['initialDate'] := cToD("01/03/2024")
    jParameters['finalDate'] := cToD("31/03/2024")
    jParameters['typeDatePayable'] := "2"
    jParameters['typeDateReceivable'] := "2"
 
    oFin:setParameters(jParameters)
 
    nPage := 1
    lHasNext := .T.
    while lHasNext
        jResponse := oFin:getBills(nPage++)
        if jResponse:hasProperty('hasNext')
            lHasNext := jResponse['hasNext']
 
            //Tratamento dos dados recebidos
        else
            //Tratamento de falha
        endIf
 
    endDo

    nPage := 1
    lHasNext := .T.
    while lHasNext
        jResponse := oFin:getWriteOff(nPage++)
        if jResponse:hasProperty('hasNext')
            lHasNext := jResponse['hasNext']
 
            //Tratamento dos dados recebidos
        else
            //Tratamento de falha
        endIf
 
    endDo

Return

04. TABELAS UTILIZADAS

SE2 - Títulos a pagar

FK7 - Tabela auxiliar

FKF - Complemento do título

FKW - Impostos x natureza de rendimento

FKY - Impostos x natureza de rendimento x baixas

Árvore de páginas

Financeiro x TAF (classe TafIntegration)

01. VISÃO GERAL

02. MÉTODOS

setParameters()

getBills()

getWriteOff()

03. EXEMPLOS DE USO

04. TABELAS UTILIZADAS