Histórico da Página

Fomato de resposta:

CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Dados enviados
   1. Principais Campos e Parâmetros
      
   2. Moeda do Movimento Bancário
   3. Campo específico/customizado
   4. Entidades Contábeis
4. Tabelas utilizadas

01. VISÃO GERAL

Modelo a ser seguido para a integração de Movimentos Bancários enviados do sistema Gesplan para o Protheus.

...

O job FwTotvsLinkJob deve ser configurado no schedule, ele é responsável pela leitura das mensagens recebidas na fila do SmartLink.

02. EXEMPLO DE UTILIZAÇÃO

Abaixo temos o modelo de mensagem enviada pela Gesplan.

...

{
	"specversion": "1.0",
	"type": "MOVreadXGsp",
	"tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
	"time": "2022-11-08T15:18:08.367574Z",
	"data": [
			{ 
           	"COD_EMPCompanyId":"T1" ,
       		"E5_FILIALBranchId":  "D MG 01",
            "E5_VALOR":  100 ,
            "E5_MOEDA":"M1" ,
            "E5_DATA":"08/11/2022" ,
            "E5_VENCTO":"08/11/2022" ,
            "E5_NATUREZ":"AUT0000001" ,
			"E5_CCUSTO": "CTBXATUC"
            "E5_BANCO":"004" ,
            "E5_AGENCIA":"001" ,
            "E5_CONTA":"04001" ,        
            "E5_RECPAG": "S",
 			"E5_BENEF":"001" ,
 			"E5_DOCUMEN": "DOC ID002", 
              "E5_HISTOR": "MOV BANC PAGAR", 
            "SYSCODE": "SYSCODE001",
			"ID"	: "ID001"
        	},
        	{ 
            "COD_EMPCompanyId":"T1" ,
            "E5_FILIALBranchId":  "D MG 02",
            "E5_VALOR":  200 ,
            "E5_MOEDA":"M1" ,
            "E5_DATA":"08/11/2022" ,
            "E5_VENCTO":"08/11/2022" ,
            "E5_NATUREZ":"AUT0000001" ,
			"E5_CCUSTO": "CTBXATUC"
            "E5_BANCO":"004" ,
            "E5_AGENCIA":"001" ,
            "E5_CONTA":"04001" ,        
	        "E5_RECPAG": "E",
			"E5_BENEF":"001" ,
			"fabio - inserir E5_DOCUMENT <<<<<<<<<<<<<<<<<<<<<<<<"DOCUMEN": "DOC ID002",
            "E5_HISTOR": "MOV BANC ENTRADA",
            "SYSCODE": "SYSCODE002",
 			"ID"	: "ID002" 
        	}
			]
}

...

{
	"specversion": "1.0",
	"type": "MOVreadXGsp",
	"tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
	"time": "2024-06-17T13:18:08.367577Z",
	"data": [
			{              
			"CompanyId":"T1" ,
			"BranchId":"D MG 01",
			"CBCOORIG":"001",
			"CAGENORIG":"001",
			"CCTAORIG":"001",
			"CNATURORI":"VIN001",
			"CBCODEST":"SMS",
			"CAGENDEST":"001",
			"CCTADEST":"001",
			"CNATURDES":"VND001",
			"CTIPOTRAN":"CH",
			"CDOCTRAN":"2024002", 
			"NVALORTRAN":99.99 ,
			"CHIST100":"TRANSFERENCIA CONTA",
			"CBENEF100":"TOTVS",
			"DDATACRED":"17/06/2024",
			"NCTBONLINE":2,
			"E5_RECPAG":"T",
			"SYSCODE":"SYSCODE001",
			"ID":"ID001"          
			}
			]
}

{
	"specversion": "1.0",
	"type": "MOVrespXGspMOVreadXGsp",
	"tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
	"time": "20222024-1106-08T1517T13:18:08.367574Z367577Z",
	"data": [
			{  
			"CompanyId":"T1" ,
			"BranchId":"D MG 01",
			"AUTNRODOC":"2024002",
			"AUTDTMOV":"17/06/2024",
			"AUTBANCO":"001",
			"AUTAGENCIA":"001",
			"AUTCONTA":"001",
			"E5_RECPAG":"X",
			"SYSCODE":"SYSCODE001",
			"ID":"ID001"          
			}
			]
}

Fomato de resposta:

{
	"specversion": "1.0",
	"type": "MOVrespXGsp",
	"tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
	"time": "2022-11-08T15:18:08.367574Z",
	"data": [
			{  
   		 "COD_EMP   "CompanyId":"T1" ,
       		"E5_FILIALBranchId":  "D MG 01",
            "SYSCODE": "SYSCODE001", 
		 	"ID"	: "ID001"  ,
			"error": "Descrição do erro caso houver"       
			}
			]
}

03.

...

DADOS ENVIADOS

a. Principais Campos e Parâmetros

a1. Movimento Bancário a Pagar ou Receber

...

...

...

...

...

...

...

...

a2. Transferência Bancária

a3. Estorno de Transferências

b. Moeda do Movimento Bancário

O Movimento Bancário será gerado na moeda do banco informado. Sendo assim, quando apresentado em relatórios e consultas, somente terá seu valor convertido se a moeda solicitada nos parâmetros for diferente da moeda do cadastro do banco.

c. Campo específico/customizado

Existe a possibilidade de enviar qualquer outro campo existente no dicionário de dados da tabela SE5 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 E5_DEBITO (campo padrão do produto) e E5_XDTCLI (campo específico do ERP do cliente). 

{
	"specversion": "1.0",
	"type": "MOVreadXGsp",
	"tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
	"time": "2022-11-08T15:18:08.367574Z",
	"data": [
			{ 
           	"CompanyId":"T1" ,
       		"BranchId":  "D MG 01",
            "E5_VALOR":  100 ,
            "E5_MOEDA":"M1" ,
            "E5_DATA":"08/11/2022" ,
            "E5_NATUREZ":"AUT0000001" ,
            "E5_BANCO":"004" ,
            "E5_AGENCIA":"001" ,
            "E5_CONTA":"04001" ,        
            "E5_RECPAG": "S",
			"E5_DEBITO": "DEB000001"
			"E5_XDTCLI ": "09/11/2022",
			"E5_RECPAG": "S",
            "SYSCODE": "SYSCODE001",
			"ID"	: "ID001"
        	}
			]
}

d. Entidades Contábeis

Abaixo os principais campos representando as entidades contábeis que podem ser utilizadas para classificação do movimento.

• E5_DEBITO - Conta Débito             
• E5_CREDITO - Conta Crédito            
• E5_CCD - Centro de Custo Débito   
• E5_CCC - Centro de Custo Crédito  
• E5_ITEMD - Item Contábil Débito     
• E5_ITEMC - Item Contábil Crédito     
• E5_CLVLDB - Classe Valor Débito      
• E5_CLVLCR - Classe Valor Crédito     

04. TABELAS UTILIZADAS

• SE5- Movimentação Bancária (não utilizada explicitamente na integração)
• FK5- Movimentos Bancários
• FK8- Dados Contábeis

...