Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Aviso
titleAviso

Produto ainda em fase de piloto. 

CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Campos
  4. Tabelas utilizadas
  5. Demais informações

...

Modelo a ser seguido para a integração de Baixas de Títulos a Pagar e/ou Receber enviados do sistema Gesplan para o Protheus.

...

O atributo typeindica o evento a ser executado no ERP. O job FWTotvsLinkJob identifica uma nova mensagem e executa a classe TITBxTreadXGsp, responsável pela inclusãobaixa/exclusão/alteração cancelamento dos títulos via rotina automática (FINA040 FINA070 ou FINA050FINA080, conforme especificado no atributo OperationType). O fonte que contém a classe TITBxTreadXGsp é o FINITITGFINIBXTG.prw.

Bloco de código
languagejava
titleBody da requisição de baixa de inclusãotitulo a receber
collapsetrue
	{
    "specversion": "1.0",
    "type": "TITreadXGspBxTreadXGsp",
    "tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
            "CompanyId": "T1",
            "BranchId": "D MG 01",
            "OperationType" : "R",
			"OperationAction" : "IB",
			"E1_NUM":   "10200",
			"E1_PREFIXO": "GES",
			"E1_PARCELA": "A ",
			"E1_TIPO": "NF",
			"E1_NATUREZAUTMOTBX": "REC001NOR",
		    "E1_EMISSAOAUTBANCO":  "19/07/2023001",
			"E1_VENCTOAUTAGENCIA": "20/08/202300001",
			"E1_MOEDAAUTCONTA": 1"0000000001",
			"E1_TXMOEDAAUTDTBAIXA": 0"23/09/2024",
			"E1_CLIENTEAUTDTCREDITO": "00000123/09/2024",
			"E1_LOJAAUTHIST": "01BAIXA TESTE",
            "E1_VALORAUTJUROS": 10500.500,
            "E1_HISTAUTVALREC": "CAMPO LIVRE", 
 700,
            "ID": "ID001",
            "SYSCODE": "ID001" 
         },
          
		     ]
}
Bloco de código
languagejava
titleBody da requisição de cancelamento titulo a receber
collapsetrue
	{
        "specversion": "1.0",
    "CompanyIdtype": "T1BxTreadXGsp",
    "tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "time": "2023-07-19T15:18:08.367574Z",
    "BranchIddata": "D MG 02", [
        {
            "OperationTypeCompanyId" : "PT1",			
	
            "BranchId": "D MG 01",
            "OperationType" : "R",
			"OperationAction" : "IE",
			"E2E1_NUM":   "20200",
			"E2E1_PREFIXO": "GES",
			"E2E1_PARCELA": " ",
			"E2E1_TIPO": "NF",
			"E2_NATUREZ": "PAG001",
		            "E2E1_EMISSAOCLIENTE":  "19/07/2023000001",
			"E2_VENCTO            "E1_LOJA": "20/08/202301",
			"E2_MOEDA            "AUTMOTBX": "2NOR",
			"E2_TXMOEDA    "AUTBANCO": 4.5  "001",
			"E2_FORNECEAUTAGENCIA": "00000100001",
			"E2_LOJAAUTCONTA": "010000000001",
            "E2_VALOR			"AUTDTBAIXA": 1000"23/09/2024",
            "E2_HIST			"AUTDTCREDITO": "23/09/2024",
			"AUTHIST": "TITULO PAGAR MOEDA 2 - TAXA 4.5BAIXA TESTE", 
            "IDAUTJUROS": "ID002"0,
            "AUTVALREC": 700,
            "ID": "ID001",
            "SYSCODE": "ID002ID001" 
         }
     ]
}
Bloco de código
languagejava
titleBody da requisição de baixa de exclusãotitulo a pagar
collapsetrue
	 {
    "specversion": "1.0",
    "type": "TITreadXGspBXTreadXGsp",
    "tenantId": "c6486a57a9e9e39f-3447320e-461d4a15-bcdfa671-d66b94226f69aa3f9145d936",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
            "CompanyId": "T1",
            "BranchId": "D MG 01",
			"E2_FILIAL": "D MG  01",
        "OperationType" : "R",
			"OperationAction" : "E",
			"E1E2_NUM":   "1020241021A",
			"E1            "E2_PREFIXO": "GES",
			"E1            "E2_PARCELA": "A",
			"E1            "E2_TIPO": "NF",
                  "IDE2_FORNECE": "ID001000001",
            "SYSCODE": "ID001" 
         }, "E2_LOJA": "00",
           
		 { "AUTMOTBX":"NOR",
            "CompanyIdAUTBANCO": "T1001",
            "BranchIdAUTAGENCIA": "D MG 0200001",
            "OperationTypeAUTCONTA" : "P0000000001",			
			"OperationAction" : "E",
			"E2_NUM
            "AUTDTBAIXA": "2021/10/2024",
			"E2_PREFIXO            "AUTDTCREDITO": "GES21/10/2024",
			"E2_PARCELA": "",
			"E2_TIPO            "AUTHIST": "NFBAIXA TESTE",
			"E2_FORNECE": "000001",
			"E2_LOJA": "01",
            "ID": "ID002"            "AUTJUROS": 0,
                 "SYSCODEAUTVLRPG": "ID002" 
         }
     ]
}
Bloco de código
languagejava
titleBody da requisição de alteração
collapsetrue
	{
350,
            "specversionOperationType": "1.0P",
       "type": "TITreadXGsp",
    "tenantIdOperationAction": "c6486a57-3447-461d-bcdf-d66b94226f69B",
            "timeSYSCODE": "2023-07-19T15:18:08.367574Z16070",
    "data": [
        {
 "ID": "16070"           "CompanyId": "T1",
         }
   "BranchId":  ]
}
Bloco de código
languagejava
titleBody da requisição de cancelamento titulo a Pagar
collapsetrue
 {
"D MG 01",
            "OperationTypespecversion" : "R1.0",
			"OperationAction"     "type": "ABXTreadXGsp",
			"E1_NUM    "tenantId":   "10a9e9e39f-320e-4a15-a671-aa3f9145d936",
			"E1_PREFIXO    "time": "GES2023-07-19T15:18:08.367574Z",
			"E1_PARCELA    "data": "A",
			"E1_TIPO[
        {
            "CompanyId": "NFT1",
			"E1_NATUREZ            "BranchId": "REC001D MG 01",
		     "E1_EMISSAO":  "19/07/2023",
			"E1_VENCTO": "20/08/2023",
			"E1_MOEDA": 1,
			"E1_TXMOEDA": 0,
			"E1_CLIENTE": "000001",
			"E1_LOJA": "01",
            "E1_VALOR": 10600.50       "E2_NUM":   "20241021A",
            "E2_PREFIXO": "GES",
            "E2_PARCELA": "",
            "E2_TIPO": "NF",
            "E1E2_HISTFORNECE": "CAMPO LIVRE000001", 
            "ID": "ID001",
            "SYSCODEE2_LOJA": "ID00100" ,
         },          
		 {"AUTMOTBX":"NOR",
            "CompanyIdAUTBANCO": "T1001",
            "BranchIdAUTAGENCIA": "D MG 0200001",
            "OperationTypeAUTCONTA" : "P0000000001",			
			"OperationAction" : "A",
			"E2_NUM": "20",
			"E2_PREFIXO": "GES",
			"E2_PARCELA": "",
			"E2_TIPO": "NF",
			"E2_NATUREZ": "PAG001",
		    "E2_EMISSAO":  "19/07/2023",
			"E2_VENCTO": "20/08/2023",
			"E2_MOEDA": "2",
			"E2_TXMOEDA": 4.5,
			"E2_FORNECE": "000001",
			"E2_LOJA": "01",
            "E2_VALOR": 800,
            "E2_HIST": "TITULO PAGAR MOEDA 2 - TAXA 4.5", 
            "ID": "ID002",
            "SYSCODE": "ID002" 
         }
     ]
}

Card documentos
InformacaoPara o processo de alteração ("OperationAction" : "A") os únicos campos que serão atualizados são de Acréscimo e Decréscimo sendo para Pagar (E2_ACRESC, E2_DECRESC) e para Receber (E1_ACRESC, E1_DECRESC).
TituloIMPORTANTE!

03. Outras Informações

a. Principais Campos e Parâmetros


            "AUTDTBAIXA": "21/10/2024",
            "AUTDTCREDITO": "21/10/2024",
            "AUTHIST": "BAIXA TESTE",
            "AUTJUROS": 0,
            "AUTVLRPG": 350,
            "OperationType": "P",
            "OperationAction": "C",
            "SYSCODE": "16070",
            "ID": "16070"            
         }
     ]
}

03. Outras Informações

a. Principais Campos e Parâmetros

CampoDescriçãoTipoTamanho(MAX)ObrigatórioObservação
CompanyIdCódigo do Grupo de EmpresasCaractere2x

Grupo de Empresa do Protheus.

Todos os movimentos da mensagem devem pertencer ao mesmo Grupo de Empresa. Caso existam movimentos de Grupos de Empresa diferentes, deverão ser enviados em mensagens separadas.

BranchIdCódigo da FilialCaractere8x

Filial do Protheus.

Identificação da filial do sistema onde ocorrerá a operação. Em ambientes com Gestão de Empresas o BranchId é composto pela Empresa + Unidade de Negócio + Filial

OperationType

Operação a ser realizada

"P" ou "R"

Caractere1x

"P" = Título a Pagar

"R" = Título a Receber

OperationAction

Ação de integração a ser realizada

Caractere1x

"B" = Baixa

"C" = Cancelamento

E2_FILIAL

Código da Filial

Caractere8x

Filial do Protheus.

CampoDescriçãoTipoTamanho(MAX)ObrigatórioObservação
CompanyIdCódigo do Grupo de EmpresasCaractere2x

Grupo de Empresa do Protheus.

Todos os movimentos da mensagem devem pertencer ao mesmo Grupo de Empresa. Caso existam movimentos de Grupos de Empresa diferentes, deverão ser enviados em mensagens separadas.

BranchIdCódigo da FilialCaractere8x

Filial do Protheus.

Identificação da filial do sistema onde ocorrerá a operação. Em ambientes com Gestão de Empresas o BranchId é composto pela Empresa + Unidade de Negócio + Filial

OperationType

Operação a ser realizada

"P" ou E1_NUM (para OperationType="R")

E2_NUM (para OperationType="P")

Número do documentoCaractere19xSerá complementado com "P" = Título a Pagar

"R" = Título a Receber

OperationAction

Ação de integração a ser realizada

Caractere1x

"I" = Inclusão

"E" = Exclusão

"A" = Alteração

0" (zeros) a esquerda, quando o conteúdo passado for inferior ao tamanho do campo na base de dados.

E1_PREFIXO (para OperationType="R")

E2_PREFIXO (para OperationType="P")

Prefixo de identificação do títuloCaractere3xN/A

E1_PARCELA E1_NUM (para OperationType="R")

E2_NUM PARCELA (para OperationType="P")

Número Parcela do documentotítuloCaractere91xSerá complementado com "0" (zeros) a esquerda, quando o conteúdo passado for inferior ao tamanho do campo na base de dados.Pode ser enviado conteúdo vazio. 

E1_TIPO (E1_PREFIXO (para OperationType="R")

E2_PREFIXO TIPO (para OperationType="P")

Prefixo de identificação do título

Tipo 

Caractere3xN/AConforme tabela SX5 - NF, BOL,  FT,  etc.

E1_PARCELA (para OperationType="R")CLIENTE

E2_PARCELA (para OperationType="P")

Parcela do títuloCaractere1xPode ser enviado conteúdo vazio. 

E1_TIPO (para OperationType="R")

E2_TIPO (para OperationType="P")

FORNECE

Código do Cliente

Código do Fornecedor     

Caractere6X

Campos obrigatórios para efetuar o cancelamento dos títulos

Código do Cliente cadastrado na Tabela SA1

Código do Fornecedor cadastrado na Tabela SA2

E1_LOJA

E2_LOJA

Loja do Cliente

Loja do Fornecedor           

Caractere2X

Campos obrigatórios para efetuar o cancelamento dos títulos

Loja  cadastrada na Tabela SA1 - Clientes

Loja  cadastrada na Tabela SA2 - Fornecedores


AUTMOTBX

Motivo da BaixaTipo Caractere3x

Conforme

tabela SX5 - NF, BOL,  FT,  etc.

E1_NATUREZ (para OperationType="R")

E2_NATUREZ (para OperationType="P")

Natureza financeiraCaractere10Somente para OperationAction igual a "I"N/A

E1_EMISSAO (para OperationType="R")

E2_EMISSAO (para OperationType="P")

Emissão do títuloCaractere10Somente para OperationAction igual a "I"A data deverá ser informada no formato "DD/MM/AAAA".

E2_VENCTO (para OperationType="R")

E2_VENCTO (para OperationType="P")

Vencimento do títuloCaractere10Somente para OperationAction igual a "I"

A data deverá ser informada no formato "DD/MM/AAAA".

Integração irá calcular o vencimento Real conforme a data informada.

E1_MOEDA (para OperationType="R")

E2_MOEDA (para OperationType="P")

MoedaNumérico1N/A

E1_TXMOEDA (para OperationType="R")

E2_TXMOEDA (para OperationType="P")

Taxa da moedaNumérico5Para moeda 1-Real, indicar taxa 0

E1_CLIENTE (para OperationType="R")

E2_FORNECE (para OperationType="P")

Código do Cliente ou Código de FornecedorCaractere6xIndicar código válido de cliente ou fornecedor, conforme operação especificada no OperationType

E1_LOJA (para OperationType="R")

E2_LOJA (para OperationType="P")

Loja do Cliente ou  FornecedorCaractere2xConforme operação especificada no OperationType

E1_VALOR (para OperationType="R")

E2_VALOR (para OperationType="P")

Valor do títuloNumérico16Somente para OperationAction igual a "I"

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

E1_HIST (para OperationType="R")

E2_HIST (para OperationType="P")

HistóricoCaractere40Pode ser enviado conteúdo vazio.ID

Código de Controle Gesplan

CaracterexN/ASYSCODEChave identificadora GesplanCaracterexN/AEspecíficoCampo específico do ERPVariávelVer mais detalhes da utilização de campos específicos no "item b" abaixo.

b. Campo específico/customizado

Existe a possibilidade de enviar qualquer outro campo existente no dicionário de dados da tabela SE1 (Contas a Receber) para OperationType do tipo "R" ou SE2 (Contas a Pagar) para OperationType do tipo "P" do ambiente onde está sendo processada a mensagem.

Esse campo pode ser um campo padrão (não exemplificado na tabela acima) ou um campo customizado (criado especificamente para o ambiente Protheus em que a integração está ativa). Nesse caso, basta que seja inserida uma nova linha no conteúdo da mensagem, com o mesmo formato Chave/Valor, conforme exemplo abaixo, onde inserimos os campos E1_CCUSTO (campo padrão do produto) e E1_XDTCLI (campo específico do ERP do cliente) no movimento com OperationType do tipo "R" e E2_CCUSTO (campo padrão do produto) e E2_XDTCLI (campo específico do ERP do cliente) no movimento com OperationType do tipo "P".

...

languagejava
titleBody da requisição de inclusão com campo específico
collapsetrue

...

Tabela Mot. Baixa

Miscelanea/Arquivos/Tabela Mot. Baixa

exemplo:
NOR - Normal
DEV - Devolução
DAC - Dação
DEB - Débito C/C

AUTBANCO

Código do agente cobradorCaractere3xN/A

AUTAGENCIA

Código da agência do agente cobradorCaractere5x

N/A

AUTCONTA

Número da conta bancária.Caractere10xN/A

AUTDTBAIXA

Data em que foi/será realizada a baixa.Caractere10x

A data deverá ser informada no formato "DD/MM/AAAA".

AUTDTCREDITO

Data do crédito bancário referente à baixa do título.

Caractere10x

A data deverá ser informada no formato "DD/MM/AAAA".


Obs.: Para OperationAction "C" = Cancelamento, data será apenas para posicionamento no título, mas o cancelamento registrado no protheus ficará com data vigente do dia.

AUTHIST

Histórico da baixa.Caractere40xN/A

AUTJUROS

Valor do JurosNumérico

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

AUTMULTA

Valor MultaNumérico

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

AUTDESCONT

Valor DescontoNumérico

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

AUTCM1

Valor Correção monetáriaNumérico

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

AUTPRORATA

Pro RataNumérico

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

AUTVALREC

Valor do título receberNumérico

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

AUTVLRPG

Valor do título pagarNumérico

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

ID

Código de Controle Gesplan

Caractere
xN/A
SYSCODEChave identificadora GesplanCaractere
xN/A
EspecíficoCampo específico do ERPVariável

Ver mais detalhes da utilização de campos específicos no "item b" abaixo.

...


Card documentos
InformacaoOs campos SysCode e ID não serão gravados no ERP, eles são somente informações de controle da Gesplan, que chegará na requisição e serão enviados na resposta do processamento, indicando sucesso ou falha da inclusão desse título. Além dos índices de pesquisas disponíveis, é possível listar os registros gerados através do campo origem, com conteúdo FINITITG.
TituloIMPORTANTE!

...

  • SE1- Títulos a Receber
  • SE2- Títulos a Pagar

05. DEMAIS INFORMAÇÕES

Ponto de Entrada FiTitGsp para permitir a alteração do conteúdo do execauto do FINA040/FINA050        Não há.