Histórico da Página

CONTEÚDO

Visão Geral
Exemplo de utilização
Tela XXX
1. Outras Ações / Ações relacionadas
Tela XXX
1. Principais Campos e Parâmetros
Descrição Campos da Mensagem
PremissasTabelas utilizadas

01. VISÃO GERAL

Modelo de dados a ser seguido para a integração de movimentos em Conta Corrente do Caixa e Bancos Datasul.

02. EXEMPLO DE UTILIZAÇÃO

Envio de dados deve ser realizado via Smart Link utilizando o Padrão CloudEvents/Modo Estruturado para envio de mensagens no formato Json de acordo com o modelo a seguir :

Bloco de código

title	Json de envio Movimento Conta Corrente

{
    "messageId": "123",
    "audience:": "CMG",
    "messageType": "CMGCheckingAccountMovement",
    "additionalInfo": "",
    "messageContent": {
        "specVersion": "1.0",
        "user": "UserCodeDatasul",
        "company": "CompanyCodeDatasul",
        "productCode": "GFNGFI",
        "idExternal": "123456",
        "movements": [
            {
                "checkingAccount": "341001",
                "movementDate": "2024-10-15",
                "valuemovementValue": "100",
                "transctionType": "TRANSF",
                "flowIndicatorMovement": "ENT",
                "movementType": "RE",
                "bankDocumentCode": "87953361",
                "historyCode": "Pagamento",
                "complementaryHistorydescriptionHistory": "Transferência referente Pagamento xpto",
                "checkingAccountTransfer": "341002",
                "keyCode": "000000001"
            },
			{
                "checkingAccount": "341001",
                "movementDate": "2024-10-15",
                "valuemovementValue": "250",
                "transctionType": "DESP",
                "flowIndicatorMovement": "SAI",
                "movementType": "RE",
                "bankDocumentCode": "900557484",
                "historyCode": "Despesa",
                "complementaryHistorydescriptionHistory": "Despesa Bancária referente a transação xpto",
                "checkingAccountTransfer": "",
                "keyCode": "000000002"
            }
        ]
    }
}

Informações

A propriedade '"movements' " deverá ser enviada no formato array, onde cada item desse array deverá conter os dados do movimento ser lançado na Conta Corrente no Caixa e Bancos Datasul.

Cada linha deverá conter ao menos uma conta corrente para receber o lançamento, podendo ser até duas contas informadas ("checkingAccount" e "checkingAccountTransfer") quando for realizado movimentação de Transferência Bancária.

Bloco de código

title	Exemplo Json de resposta

{
 [
        {     "parentUUID": "00000001",
    "audience:": "CMG",

       "messageType": "CMGCheckingAccountMovementResponse",
    "additionalInfokeyCode": "000000001",
    "messageContent   
			"sequenceNumber": ["10",
            "messageType": "CMGCheckingAccountMovementResponse", {           
                   "idExternal": "123456", 
              "keyCodecheckingAccount": "000000001",
			"sequenceNumbermovementDate": "10",
			"checkingAccountmovementSequence": "",             
			"movementDatecompany": "10",
			"movementSequence": "",
                   "error": [
                {
                    "code": "21474",
                    "description": "Tipo de Transação de Caixa TRANSF inexistente!",
                    "help": "O Tipo de transação de Caixa TRANSF informado nos Parâmetros de Controle do Caixa é Inexistente!"
                }
            ]
        },
	    {           
	            "idExternalkeyCode": "123456000000003",
    	        "keyCode": "000000002",
			"sequenceNumber": "10",
			"checkingAccount": "341001",
			"movementDate": "2024-10-1520",
			"movementSequence": "2",
            "errormessageType": [
"CMGCheckingAccountMovementResponse",	                {

	          "idExternal": "1111",
	          "codecheckingAccount": "1123345",
	        "movementDate": "2025-01-26",
			"movementSequence": "14",
               "descriptioncompany": "Processamento efetuado com sucesso.10",
	                    "help"error": "O Movimento foi processado com sucesso no Caixa e Bancos Datasul."
                  }
          }
     ]
        }
    ]
}

03.

...

Outras Ações / Ações relacionadas

...

04. TELA XXXXX

Principais Campos e Parâmetros

...

Card documentos

Informacao	Use esse box para destacar informações relevantes e/ou de destaque.
Titulo	IMPORTANTE!

...

DESCRIÇÃO CAMPOS DA MENSAGEM

Abaixo a descrição dos campos da mensagem a ser recebida para Inclusão de Movimentos em Conta Corrente no Datasul.

Dados Cabeçalho Movimentos da Conta Corrente

Campo	Descrição	Tipo	Tamanho	Obrigatório	Observação
specVersion	Versão da Mensagem	Caractere	3	X	Hoje a versão disponível é apenas 1.0
user	Código do usuário	Caractere	12		Código do usuário cadastrado no produto Datasul
company	Código da empresa	Caractere	3	X	Código da empresa
productCode	Código Módulo/Produto Origem	Caractere	3		Código Módulo/Produto de Origem cadastrado no Datasul. Caso não seja informado, a origem será CMG.
idExternal	ID Externo do Registro	Caractere	10		Esta informação identifica a processo /rotina/programa de origem, e será retornado após processamento via Mensagem Resposta

Movimentação Conta Corrente (propriedade: Movements)

Campo	Descrição	Tipo	Tamanho	Obrigatório	Observação
checkingAccount	Conta Corrente	Caractere	10	X	Conta Corrente que irá receber lançamento
movementDate	Data Movimento	Caractere	10	X	Data do Movimento Conta Corrente
movementValue	Valor Movimento	Numérico	18	X	Valor do Movimento Conta Corrente
transctionType	Tipo Transação	Caractere	8	X	Tipo de Transação Caixa do Movimento
flowIndicatorMovement	Indicador Fluxo	Caractere	18	X	Indicador Fluxo da Movimentação: ENT - Entrada SAI - Saída
movementType	Tipo Movimento	Caractere	2	X	Tipo de Movimento: NR - Não Realizado RE - Realizado
bankDocumentCode	Código Documento	Caractere	20	X	Código do Documento no Movimento da Conta no Banco
historyCode	Código do Histórico	Caractere	8	*	Histórico Padrão
descriptionHistory	Descrição do Histórico	Caractere	2000	**	Descrição do histórico do Movimento
checkingAccountTransfer	Conta Corrente Destino	Caractere	10		Somente deve ser informada Conta Corrente Destino quando for movimento de Transferência entre contas correntes da empresa.
keyCode	Chave Identificação Origem	Caractere	200	X	Chave de Identificação do Registro do Movimento no sistema de Origem

Observações:

* Essa informação se torna obrigatória quando não informado a Descrição do Histórico ( "descriptionHistory" ).

** Essa informação se torna obrigatória quando não informado o Código do Histórico ( "historyCode" ).

Mensagem Resposta de Processamento

Campo	Descrição	Tipo	Observação
keyCode	Chave Registro Origem	Caractere	Chave de Identificação do Registro do Movimento no sistema de Origem.
sequenceNumber	Sequencial Mensagem Retorno	Numérico	Quando for gerar uma movimentação de transferência, o sistema acaba gerando uma saída numa conta corrente e uma entrada em outra conta ou vice e versa. Neste caso o Datasul devolve mais de um registro por KeyCode (Registro Origem). Este campo sequencial serve para indicar a sequencia de retornos que irão apontar através dos campos checkingAccount, movementDate e movementSequence o registro criado.
idExternal	ID Externo do Registro	Caractere	Esta informação identifica a processo /rotina/programa de origem, e será retornado após processamento via Mensagem Resposta
checkingAccount	Conta Corrente	Caractere	Conta Corrente que irá receber lançamento
movementDate	Data Movimento Conta Corrente	Caractere	Data do Movimento Conta Corrente
movementSequence	Sequencia Movimento Conta Corrente	Numérico	Sequencia Movimento Conta Corrente
company	Código da empresa	Caractere	Código Empresa Datasul

Observações: A chave de identificação do registro criado no Datasul será composta pelos campos checkingAccount, movementDate e movementSequence.

04. PREMISSAS

Para que a integração entre o Sistema de Origem e o Caixa e Bancos ocorra, no ERP Datasul deverá ser criado o módulo/produto de Origem com o objetivo de facilitar a identificação e consulta dos movimentos através dos Relatórios, Consulta e Rotinas do Caixa e Bancos.

Efetue o cadastro através do programa bas_modul_dtsul - Manutenção de Módulos e inclua o código do módulo e a descrição do mesmo conforme exemplo abaixo:

Image Added

Para maiores informações sobre cadastro de módulos, acessar: Manutenção de Módulo(MEN004AA).

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave