Histórico da Página

Aviso

title	Aviso

Produto ainda em fase de piloto.

Fomato de resposta:

CONTEÚDO

Visão Geral
Exemplo de utilização
Dados enviados
1. Principais Campos e Parâmetros
2. Moeda do Movimento Bancário
3. Campo específico/customizado
4. Entidades Contábeis
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.

...

Bloco de código

language	java
title	Json de envio Movimento Bancário
collapse	true

{
	"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_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"
        	},
        	{ 
            "CompanyId":"T1" ,
            "BranchId":  "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" ,
			"E5_DOCUMEN": "DOC ID002",
            "E5_HISTOR": "MOV BANC ENTRADA",
            "SYSCODE": "SYSCODE002",
 			"ID"	: "ID002" 
        	}
			]
}

Fomato de resposta:

Bloco de código

language	java
title	Exemplo Json de respostaenvio Transferência Bancária
collapse	true

{
	"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",
            "SYSCODE": "SYSCODE001", 
		 	"ID"	: "ID001"  			"CBCOORIG":"001",
			"CAGENORIG":"001",
			"CCTAORIG":"001",
			"errorCNATURORI": "Descrição do erro caso houver"       "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"          
			}
			]
}

Bloco de código

language	java
title	Json de envio Estorno Transferência
collapse	true

{
	"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",
			"AUTNRODOC":"2024002",
			"AUTDTMOV":"17/06/2024",
			"AUTBANCO":"001",
			"AUTAGENCIA":"001",
			"AUTCONTA":"001",
			"E5_RECPAG":"X",
			"SYSCODE":"SYSCODE001",
			"ID":"ID001"          
			}
			]
}

Fomato de resposta:

Bloco de código

language	java
title	Exemplo de resposta
collapse	true

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

...

Campo	Descrição	Tipo	Tamanho(MAX)	Obrigatório	Observação
CompanyId	Código do Grupo de Empresas	Caractere	2	X	Grupo de Empresa do Protheus.
BranchId	Código da Filial	Caractere	8	X	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_MOEDA	Numerário	Caractere	2	X	N/A
E5_VALOR	Valor da movimentação	Numérico	16	X	Decimal deve ser enviado com o caractere ponto
E5_DATA	Data da Movimentação	Caractere	10	X	Data enviada em formato caractere ddmmaaaa ex: "08/09/2022"
E5_VENCTO	Data de Vencimento	Caractere	10X		Data enviada em formato caractere ddmmaaaa ex: "08/09/2022"
E5_NATUREZ	Natureza	Caractere	10	X	N/A
E5_BANCO	Código do banco	Caractere	3	X	N/A
E5_AGENCIA	Agencia do banco	Caractere	5	X	N/A
E5_CONTA	Conta corrente no banco	Caractere	10	X	N/A
E5_RECPAG	Recebimento ou Pagamento	Caractere	1	X	Enviar: "S" → Movimento a pagar (saída) "E" → Movimento a receber (entrada)
E5_CCUSTO	Centro de Custo	Caractere	9		N/A
E5_BENEF	Beneficiário	Caractere	30		N/A
E5_DOCUMEN	Número do Documento	Caractere	50		N/A
E5_HISTOR	Histórico do movimento	Caractere	40		N/A
SYSCODE	Chave identificadora Gesplan	Caractere		X	N/A
ID	Código de Controle Gesplan	Caractere		X	N/A
Específico	Campo específico do ERP	Variável			Ver mais detalhes da utilização de campos específicos no "item c" abaixo.

...

N/A

Campo	Descrição	Tipo	Tamanho(MAX)	Obrigatório	Observação
CompanyId	Código do Grupo de Empresas	Caractere	2	X	Grupo de Empresa do Protheus.
BranchId	Código da Filial	Caractere	8	X	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 + FilialEmpresa + Unidade de Negócio + Filial
CBCOORIG	Código do banco origem	Caractere	3	X	N/A
CAGENORIG	Código da agência origem	Caractere	5	X	N/A
CCTAORIG	Conta corrente origem	Caractere	10	X	N/A
CNATURORI	Natureza Origem	Caractere	10	E5_MOEDA	Numerário	Caractere	2	X	N/A
E5_VALOR	Valor da movimentação	Numérico	16	X	Decimal deve ser enviado com o caractere ponto
E5_DATA	Data da Movimentação	Caractere	10	X	Data enviada em formato caractere ddmmaaaa ex: "08/09/2022"
CBCODEST	Código do banco destino	Caractere	3	X	N/A
CAGENDEST	Código da agência destino	Caractere	5	X	N/A
CCTADEST	Conta corrente destino	E5_NATUREZ	Natureza	Caractere	10	X	N/A
CNATURDES	Natureza destino	E5_BANCO	Código do banco	Caractere	310	X	N/A
CTIPOTRAN	Tipo da Transferência	E5_AGENCIA	Agencia do banco	Caractere	56	X	N/A
CDOCTRAN	Número do Documento	E5_CONTA	Conta corrente no banco	Caractere	1015	X	N/A
E5_RECPAG	Recebimento ou Pagamento	Caractere	1	X	Enviar: "S" → Movimento a pagar (saída) "E" → Movimento a receber (entrada)
E5_CCUSTO	Centro de Custo	Caractere	9	N/A

NVALORTRAN	Valor a ser transferido do banco origem para o banco destino.	Numérico	16	X	Decimal deve ser enviado com o caractere ponto
CHIST100	Histórico da transferência	Caractere	40	X	Histórico referente a transferência efetuada.
CBENEF100	Beneficiário	Caractere	30	X	Nome do favorecido para o caso de ser emitido um cheque referente a transferência.
NCTBONLINE	Contabiliza On Line ?	Numérico	1		1=Sim;2=Não
DDATACRED	Data de Crédito	Caractere	10	X	Data enviada em formato caractere ddmmaaaa ex: "08/09/2022".
E5_RECPAG	Recebimento ou Pagamento	Caractere	1	X	Enviar: "T" → Transferência Bancária (saída)
E5_BENEF	Beneficiário	Caractere	30	N/A	E5_DOCUMEN	Número do Documento	Caractere	50	N/A	E5_HISTOR	Histórico do movimento	Caractere	40

SYSCODE	Chave identificadora Gesplan	Caractere		X	N/A
ID	Código de Controle Gesplan	Caractere		X	N/A	Específico	Campo específico do ERP	Variável	Ver mais detalhes da utilização de campos específicos no "item c" abaixo.

a3. Estorno de Transferências

...

Card documentos

Informacao	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.
Titulo	IMPORTANTE!

04. TABELAS UTILIZADAS

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

...

Árvore de páginas

Versões comparadas

Versão antiga 64

Nova versão Atual

Chave

Fomato de resposta:

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

03. DADOS ENVIADOS

04. TABELAS UTILIZADAS