Histórico da Página
CONTEÚDO
- Visão Geral
- Configurações
- Exemplo de utilização
- Outras Informações Principais Campos e ParâmetrosDemais Informações
- Tabelas utilizadas
01. VISÃO GERAL
Modelo de dados a ser seguido para a integração de lançamentos contábeis enviados do sistema Gesplan para Protheus.
02. EXEMPLO DE UTILIZAÇÃO
...
Esse documento apresenta os passos necessários para ativação e consumo da API Balancete Modelo1 (CTR040S) via Smartlink .
Essa integração prevê a leitura de mensagens enviadas ao SmartLink, através de uma rotina configurada no Schedule do ambiente do cliente. As mensagens serão consumidas pelo ERP, que fará o processamento do Balancete conforme parâmetros solicitados.
A partir dos dados recebidos pelo ERP, haverá a chamada de uma API dentro do próprio ERP, que estará disponível para consumo através das configurações REST citadas abaixo. Após o consumo dessa API, uma mensagem de retorno será enviada ao SmartLink com os dados do Balancete.
Será necessária a atualização do ambiente seguindo a ordem descrita nos tópicos abaixo.
02. CONFIGURAÇÕES
Expandir | ||
---|---|---|
| ||
1) Release Protheus a partir da 12.1.2210 2) Aplicação das atualizações CTB, com data superior a 29/05/2024 e conforme release do ambiente. |
Expandir | |||||
---|---|---|---|---|---|
| |||||
Configurar a comunicação com SmartLink, inserindo as credenciais do cliente (clientId e clientSecret) na rotina FwSgdpParm - Comunicação SmartLink
|
Expandir | ||
---|---|---|
| ||
|
Expandir | ||
---|---|---|
| ||
O sistema irá chamar a api com base nos parâmetros configurados no arquivo appserver.ini conforme modelo abaixo: Para o modelo acima a requisição será direcionada para o endereço : http://localhost:9090/api/ctb/balance/model1 Inserir também a chamada do serviço REST na seção ON START: Observações:
Documentação completa das configurações REST/Server |
03. EXEMPLO DE UTILIZAÇÃO
Abaixo temos o modelo de mensagem enviada ao Smartlink, que ficará disponível para consumo através do Job schedulado no ERP.
O atributo type indica o evento a ser executado no ERP.
O job FWTOTVSLINKJOB identifica uma nova mensagem e faz a chamada à classe PrtBalanRead (CTR040S), responsável pela chamada da API que fará o processamento do Balancete.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "specversion": "1.0", "type": "CT2readXGspPrtBalanRead", "tenantId": "c6486a57d87804f9-3447xxxx-461dxxxx-bcdf9393-d66b94226f69fe9ef0d13c10", /// tenant do cliente "timegeneratedOn": "2021-06-08T15:18:08.367574Z", "data":[{ "COD_EMPid":"T1" , "CT2_FILIAL": "D MG 01"CODIGO IDENTIFICADOR DA MENSAGEM", "CT2_DATA":"15/04/2023" , "ID": "1271", "EST":"REV", "ITENS":[{ "CT2_DC" : "3", "CT2_CREDIT": "CTBXATUC", "data": { "CT2_DEBITOCNPJ": "CTBXATUD", "CT2_VALOR": 1500.60 , "CT2_HIST": "PARTIDA DOBRADA VALOR COM DECIMAL E CONTINUACAO DE HISTORICO", "CT2_KEY": "IDENTIFICADOR UNICO GESPLAN", 53113791", "DATA_INICIAL": "01/01/2023", "CT2DATA_ROTINAFINAL": "WFNCASH", "CT2_EMPORI": "T2", "CT2_FILORI": "M PR 02", "CT2_CONVER": "1" }, 31/12/2023", } } |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "CT2_MOEDLC"specversion": "011.0", "CT2_DC" : "2"time": "2022-10-18T11:04:03-03:00", "CT2_CREDIT"type": "CTBXATUCPrtBalanResp", "CT2_KEY "tenantId": "ITEM 1d87804f9-xxxx-xxxx-9393-fe9ef0d13c10", /// tenant do cliente "CT2_TPSALD "id": "1CODIGO IDENTIFICADOR DA MENSAGEM", "CT2_ROTINA"data": "WFNCASH",{ "CT2_VALOR "items": 3000 ,[ "CT2_HIST": "MSEXECCT2 ITEM1 ", { "CT2_EMPORIconta": "T2CTBXATUC", "CT2condicao_FILORInormal": "M PR 02" }, { 2", "CT2_MOEDLCsuperior": "01", "CT2_DCclasse" : "12", "CT2_DEBITOnatureza": "CTBXATUD01", "CT2_KEYdescricao": "ITEM 2REAL", "CT2saldo_TPSALDanterior": "1"0, "CT2_ROTINAdebito": "WFNCASH"0, "CT2_VALORcredito": 3000 1600.6, "CT2saldo_HISTatual": "MSEXECCT2 ITEM2 "1600.6, "CT2_EMPORImovimento": "T2"1600.6, "CT2conta_FILORIreferencial": "M PR 02", }] }, { "COD_EMP":"T1" , "CT2_FILIAL": "M SP 01", "descricao_referencial": "" "CT2_DATA":"15/04/2023" , "ID": "1271", "EST":"REV" , "ITENS":[{ "CT2_DC" : "3", "CT2_CREDIT": "CTBXATUC", "CT2_DEBITO": "CTBXATUD", "CT2_VALOR": 5000.50 , "CT2_HIST": "PARTIDA DOBRADA ", "CT2_KEY": "IDENTIFICADOR UNICO" } ], "hasNext": false, "remainingRecords": 0, "CT2_ROTINA": "WFNCASH", "CT2_EMPORI": "T2", "CT2_FILORI": "M PR 02", "CT2_CONVER": "1" }] }] } |
OBS: propriedade "data" deverá ser enviado formato array onde cada item desse array deverá conter os dados do lançamento contábil a ser cadastrado.
"po_sync_date": "2023-09-29T19:13:15Z"
} } |
OBS: Caso houver algum erro a propriedade "error" será retornada exFomato de resposta:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "specversion": "1.0", "time": "2022-10-18T11:04:03-03:00", "type": "CT2respXGspPrtBalanResp", "tenantId": "c6486a57d87804f9-3447xxxx-461dxxxx-bcdf9393-d66b94226f69fe9ef0d13c10", /// tenant "data": [ do cliente { "ID": "1271" "ESTid":"REV" "COD_EMP": "T1", "CT2_FILIAL": "D MG 01""CODIGO IDENTIFICADOR DA MENSAGEM", "CT2_DOC"data": "000004", "CT2_KEY": "ITEM 1", "error": ""{ "error":"Host not found." } ] } |
OBS: Caso houver algum erro a propriedade "error" será preenchida informando o motivo do erro no cadastro, nesses casos a propriedade "CT2_DOC" retornará em branco pois o lançamento não foi cadastrado.
03. Outras Informações_
Principais Campos e Parâmetros
Capa do Lote
...
OBS: O código do Lote reservado para os lançamentos contábeis oriundos do Sistema Gesplan para o Protheus é 008950.
Itens do Lote
...
** tamanho Default no Protheus 40
...
Aviso | ||
---|---|---|
| ||
04. DEMAIS INFORMAÇÕES
Schedule - Como agendar a execução de rotinas
05. TABELAS UTILIZADAS
- CT1- Plano de Contas
- CQ0- Saldo por Conta no Mês
- CQ1- Saldo por Conta no Dia
- CVN - Plano de Contas Referencial
- CVD - Plano de Contas Referenciais
- CTG - Calendário Contábil
...
OBS: Para cada capa de lote deve ser enviado 1 ou mais itens.
Card documentos | ||||
---|---|---|---|---|
|
04. TABELAS UTILIZADAS
- CT2- Lançamentos Contábeis
- CT1- Plano de Contas
- CTT- Centro de Custo
- CTH- Classe de Valor
- CTD - Item Contábil