Árvore de páginas

Versões comparadas

Chave

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

...

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

Bloco de código
languagejava
titleBody da requisição de baixa de inclusãotitulo a receber
collapsetrue
	{
    "specversion": "1.0",
    "type": "BxTreadXGsp",
    "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":   "200",
			"E1_PREFIXO": "GES",
			"E1_PARCELA": " ",
			"E1_TIPO": "NF",
			"AUTMOTBX": "NOR",
		    "AUTBANCO":  "001",
			"AUTAGENCIA": "00001",
			"AUTCONTA": "0000000001",
			"AUTDTBAIXA": "23/09/2024",
			"AUTDTCREDITO": "23/09/2024",
			"AUTHIST": "BAIXA TESTE",
            "AUTJUROS": 0,
            "AUTVALREC": 700, 
            "ID": "ID001",
            "SYSCODE": "ID001" 
         }
     ]
}
Bloco de código
languagejava
titleBody da requisição de cancelamento titulo a receber
collapsetrue
	{
    "specversion": "1.0",
    "type": "BxTreadXGsp",
    "tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
            "CompanyId": "T1",
            "BranchId": "D MG 01",
            "OperationType" : "R",
			"OperationAction" : "E",  			
			"E1_NUM":   "200",
			"E1_PREFIXO": "GES",
			"E1_PARCELA": " ",
			"E1_TIPO": "NF",
			"AUTMOTBX": "NOR",
		            "AUTBANCOE1_CLIENTE":  "001000001",
			"AUTAGENCIA": "00001",
			"AUTCONTA            "E1_LOJA": "01",
            "AUTMOTBX": "0000000001NOR",
			"AUTDTBAIXA    "AUTBANCO":  "23/09/2024001",
			"AUTDTCREDITOAUTAGENCIA": "23/00001",
			"AUTCONTA": "0000000001",
			"AUTDTBAIXA": "23/09/2024",
			"AUTDTCREDITO": "23/09/2024",
			"AUTHIST": "BAIXA TESTE",
            "AUTJUROS": 0,
            "AUTVALREC": 700,
                  "ID": "ID001",
            "SYSCODE": "ID001" 
         }
     ]
}

03. Outras Informações

a. Principais Campos e Parâmetros

...

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.

...

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

...

Operação a ser realizada

"P" ou "R"

...

"P" = Título a Pagar

"R" = Título a Receber

...

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

...

"I" = Inclusão

"E" = Exclusão

"A" = Alteração

...

E1_NUM (para OperationType="R")

E2_NUM (para OperationType="P")

...

E1_PREFIXO (para OperationType="R")

E2_PREFIXO (para OperationType="P")

...

E1_PARCELA (para OperationType="R")

E2_PARCELA (para OperationType="P")

...

E1_TIPO (para OperationType="R")

E2_TIPO (para OperationType="P")

...

Tipo 

...

E1_NATUREZ (para OperationType="R")

E2_NATUREZ (para OperationType="P")

...

E1_EMISSAO (para OperationType="R")

E2_EMISSAO (para OperationType="P")

...

E2_VENCTO (para OperationType="R")

E2_VENCTO (para OperationType="P")

...

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

...

E1_TXMOEDA (para OperationType="R")

E2_TXMOEDA (para OperationType="P")

...

Bloco de código
languagejava
titleBody da requisição de baixa de titulo a pagar
collapsetrue
 {
    "specversion": "1.0",
    "type": "BXTreadXGsp",
    "tenantId": "a9e9e39f-320e-4a15-a671-aa3f9145d936",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
            "CompanyId": "T1",
            "BranchId": "D MG 01",
			"E2_FILIAL": "D MG 01",
            "E2_NUM":   "20241021A",
            "E2_PREFIXO": "GES",
            "E2_PARCELA": "",
            "E2_TIPO": "NF",
            "E2_FORNECE": "000001",
            "E2_LOJA": "00",
            "AUTMOTBX":"NOR",
            "AUTBANCO":"001",
            "AUTAGENCIA": "00001",
            "AUTCONTA": "0000000001",
            "AUTDTBAIXA": "21/10/2024",
            "AUTDTCREDITO": "21/10/2024",
            "AUTHIST": "BAIXA TESTE",
            "AUTJUROS": 0,
            "AUTVLRPG": 350,
            "OperationType": "P",
            "OperationAction": "B",
            "SYSCODE": "16070",
            "ID": "16070"            
         }
     ]
}
Bloco de código
languagejava
titleBody da requisição de cancelamento titulo a Pagar
collapsetrue
 {
    "specversion": "1.0",
    "type": "BXTreadXGsp",
    "tenantId": "a9e9e39f-320e-4a15-a671-aa3f9145d936",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
            "CompanyId": "T1",
            "BranchId": "D MG 01",

...

E1_CLIENTE (para OperationType="R")

E2_FORNECE (para OperationType="P")

...

E1_LOJA (para OperationType="R")

E2_LOJA (para OperationType="P")

...

E1_VALOR (para OperationType="R")

E2_VALOR (para OperationType="P")

...

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

Ex: 1234.56

...

E1_HIST (para OperationType="R")

E2_HIST (para OperationType="P")

...

Código de Controle Gesplan

...

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

Bloco de código
languagejava
titleBody da requisição de inclusão com campo específico
collapsetrue
	{
    "specversion": "1.0",
    "type": "TITreadXGsp",
    "tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
             "CompanyIdE2_NUM":   "T120241021A",
            "BranchIdE2_PREFIXO": "D MG 01GES",
            "OperationTypeE2_PARCELA" : "R",
			"OperationAction"             "E2_TIPO": "INF",
			"E1_NUM":            "10",
			"E1_PREFIXOE2_FORNECE": "GES000001",
			"E1_PARCELA            "E2_LOJA": "A00",
			"E1_TIPO": "NF",
			"E1_NATUREZ": "REC001",
		    "E1_EMISSAO":  "19/07/2023",
			"E1_VENCTO": "20/08/2023",
			"E1_MOEDA": 1,
			"E1_TXMOEDA": 0,
			"E1_CLIENTE": "000001",
			"E1_LOJA": "01",
            "E1_VALOR": 10500.50            "AUTMOTBX":"NOR",
            "AUTBANCO":"001",
            "AUTAGENCIA": "00001",
            "AUTCONTA": "0000000001",
            "AUTDTBAIXA": "21/10/2024",
            "AUTDTCREDITO": "21/10/2024",
            "AUTHIST": "BAIXA TESTE",
            "AUTJUROS": 0,
            "E1_HISTAUTVLRPG": "CAMPO LIVRE"350,
            "E1_CCUSTOOperationType": "CC001P",
            "E1_XDTCLIOperationAction": "01/07/2023C",
                 "IDSYSCODE": "ID00116070",
                 "SYSCODEID": "ID001" 
         },16070"             
		 {
            "CompanyId": "T1",}
            "BranchId": "D MG 02",
            "OperationType" : "P",			
			"OperationAction" : "I",
			"E1_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": 1000,
            "E2_HIST": "TITULO PAGAR MOEDA 2 - TAXA 4.5",
            "E2_CCUSTO": "CC001",
            "E2_XDTCLI": "01/07/2023",
            "ID": "ID002",
            "SYSCODE": "ID002" 
         }
     ]
}]
}

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.

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

E1_NUM (para OperationType="R")

E2_NUM (para OperationType="P")

Número do documentoCaractere9xSerá complementado com "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 (para OperationType="R")

E2_PARCELA (para OperationType="P")

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

E1_TIPO (para OperationType="R")

E2_TIPO (para OperationType="P")

Tipo 

Caractere3xConforme tabela SX5 - NF, BOL,  FT,  etc.

E1_CLIENTE

E2_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 BaixaCaractere3x

Conforme 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á.