Árvore de páginas

Aviso

Produto ainda em fase de piloto. 

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 envio de dados deve ser realizado via SmartLink utilizando o Padrão CloudEvents para envio de mensagens no formato Json.

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.

O atributo type indica o evento a ser executado no ERP. O job FWTotvsLinkJob identifica uma nova mensagem e excuta a classe MOVreadXGsp, responsável pela inclusão do Movimento Bancário (FINA100) via rotina automática. O fonte que contém a classe MOVreadXGsp é o FINI100G.prw.

Json de envio Movimento Bancário
{
	"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_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"
        	},
        	{ 
            "CompanyId":"T1" ,
            "BranchId":  "D MG 02",
            "E5_VALOR":  200 ,
            "E5_MOEDA":"M1" ,
            "E5_DATA":"08/11/2022" ,
            "E5_NATUREZ":"AUT0000001" ,
			"E5_CCUSTO": "CTBXATUC"
            "E5_BANCO":"004" ,
            "E5_AGENCIA":"001" ,
            "E5_CONTA":"04001" ,        
	        "E5_RECPAG": "E",
			"E5_BENEF":"001" ,
			"E5_DOCUMEN": "DOC ID002",
            "E5_HISTOR": "MOV BANC ENTRADA",
            "SYSCODE": "SYSCODE002",
 			"ID"	: "ID002" 
        	}
			]
}


Fomato de resposta:

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

03. DADOS ENVIADOS

a. Principais Campos e Parâmetros

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

Grupo de Empresa do Protheus.

BranchIdCódigo da FilialCaractere8X

Filial do Protheus.

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

E5_MOEDANumerário   Caractere2XN/A
E5_VALORValor da movimentação    Numérico16XDecimal deve ser enviado com o caractere ponto
E5_DATAData da Movimentação     Caractere10XData enviada em formato caractere ddmmaaaa ex: "08/09/2022"
E5_NATUREZNatureza  Caractere10XN/A
E5_BANCOCódigo do banco          Caractere3XN/A
E5_AGENCIAAgencia do banco          Caractere5XN/A
E5_CONTAConta corrente no banco  Caractere10XN/A
E5_RECPAGRecebimento ou Pagamento Caractere1X

Enviar:

"S" → Movimento a pagar (saída)

"E" → Movimento a receber (entrada)

E5_CCUSTOCentro de Custo  Caractere9

N/A

E5_BENEFBeneficiário             Caractere30
N/A
E5_DOCUMENNúmero do DocumentoCaractere50
N/A
E5_HISTORHistórico do movimentoCaractere40
N/A

SYSCODE

Chave identificadora GesplanCaractere
XN/A
IDCódigo de Controle GesplanCaractere
XN/A
EspecíficoCampo específico do ERPVariável

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


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

Campos específicos
{
	"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     


IMPORTANTE!

Os 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 Movimento Bancário. Além dos índices de pesquisas disponíveis, é possível listar os registros gerados através do campo origem, com conteúdo FINI100G.


04. TABELAS UTILIZADAS

  • SE5- Movimentação Bancária
  • FK5- Movimentos Bancários
  • FK8- Dados Contábeis