Histórico da Página

CONTEÚDO

1. Visão Geral
2. Configurações
3. Exemplo de utilização
4. Outras Informações Principais Campos e ParâmetrosDemais Informações
5. Tabelas utilizadas

01. VISÃO GERAL

Modelo de dados a ser seguido para Esse documento apresenta os passos necessários para ativação e consumo da API Balancete Modelo1 (CTBR040CTR040S) 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

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.

{
     "specversion": "1.0",
     "type": "CT2readXGsp",  /// obs: type a definir de acordo com a configuração da fila e método de leitura do fonte ADVPLPrtBalanRead",
     "tenantId": "c6486a57d87804f9-3447xxxx-461dxxxx-bcdf9393-d66b94226f69fe9ef0d13c10", /// tenant do cliente   
     "timegeneratedOn": "2021-06-08T15:18:08.367574Z",
	"id": "CODIGO IDENTIFICADOR      DA MENSAGEM",
     "data": {
  
	      "GRUPO_EMPRESACNPJ":"T153113791",
        	"DATA_INICIAL": "01/01/2023",
     	   "DATA_FINAL": "2731/0912/2023", 
    }
}

{
    	"CONTA_INICIALspecversion": "CTBXATUC1.0",
    	"CONTA_FINALtime": "CTBXATUD2022-10-18T11:04:03-03:00",
    	"FILIALtype": "D MG 02 PrtBalanResp",
        
	"COD_PLANO_REFtenantId": "000001",
    	"PLANO_REF_ENTIDADEd87804f9-xxxx-xxxx-9393-fe9ef0d13c10", /// tenant do cliente  
 	"id": "00"
	}
}

OBS: Parâmetros da propriedade "data" deveram ser enviados conforme a documentação API modelo1.

Fomato de resposta:

CODIGO IDENTIFICADOR DA MENSAGEM",
    "data": {
    	"specversionitems": "1.0",
[
        	{
            	"timeconta": "2022-10-18T11:04:03-03:00CTBXATUC",
    "type        	"condicao_normal": "CT2respXGsp2",
     "tenantId       	"superior": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "data        	"classe": ["2",
        {
			"ID    	"natureza": "127101",
			"EST":"REV"	            	"descricao": "REAL",
            	"CODsaldo_EMPanterior": "T1"0,
            	"CT2_FILIALdebito": "D MG 01"0,
            	"credito": 1600.6,
            	"CT2saldo_DOCatual": 1600.6,
   "000004"         	"movimento": 1600.6,
            	"CT2conta_KEYreferencial": "ITEM 1",
            	"errordescricao_referencial": ""
        	}
    	],
    "hasNext": false,
    "remainingRecords": 0,
    "po_sync_date": "2023-09-29T19:13:15Z"
} }

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

...

retornada ex:

{
    "specversion": "1.0",
    "time": "2022-10-18T11:04:03-03:00",
    "type": "PrtBalanResp",
	"tenantId": "d87804f9-xxxx-xxxx-9393-fe9ef0d13c10", /// tenant do cliente   
 	"id": "CODIGO IDENTIFICADOR DA MENSAGEM",
    "data": {
		"error":"Host not found."
    } 
}

04. DEMAIS INFORMAÇÕES

Schedule - Como agendar a execução de rotinas

Configuração REST

API - Balancete Modelo 1

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.

04. TABELAS UTILIZADAS

• CT2- Lançamentos Contábeis
• CT1- Plano de Contas
• CTT- Centro de Custo
• CTH- Classe de Valor
• CTD - Item Contábil