Modelo de dados a ser seguido para a integração de movimentos em Conta Corrente do Caixa e Bancos Datasul.
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 :
{
"messageId": "123",
"audience:": "",
"messageType": "CMGCheckingAccountMovement",
"additionalInfo": "",
"messageContent": {
"specVersion": "1.0",
"user": "UserCodeDatasul",
"company": "CompanyCodeDatasul",
"productCode": "GFI",
"idExternal": "123456",
"movements": [
{
"checkingAccount": "341001",
"movementDate": "2024-10-15",
"movementValue": 100,
"transctionType": "TRANSF",
"flowIndicatorMovement": "ENT",
"movementType": "RE",
"bankDocumentCode": "87953361",
"historyCode": "Pagamento",
"descriptionHistory": "Transferência referente Pagamento xpto",
"checkingAccountTransfer": "341002",
"keyCode": "000000001"
},
{
"checkingAccount": "341001",
"movementDate": "2024-10-15",
"movementValue": 250,
"transctionType": "DESP",
"flowIndicatorMovement": "SAI",
"movementType": "RE",
"bankDocumentCode": "900557484",
"historyCode": "Despesa",
"descriptionHistory": "Despesa Bancária referente a transação xpto",
"checkingAccountTransfer": "",
"keyCode": "000000002"
}
]
}
}
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.
[
{
"keyCode": "000000001",
"sequenceNumber": "10",
"messageType": "CMGCheckingAccountMovementResponse",
"idExternal": "123456",
"checkingAccount": "",
"movementDate": "",
"movementSequence": "",
"company": "10",
"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!"
}
]
},
{
"keyCode": "000000003",
"sequenceNumber": "20",
"messageType": "CMGCheckingAccountMovementResponse",
"idExternal": "1111",
"checkingAccount": "123345",
"movementDate": "2025-01-26",
"movementSequence": "14",
"company": "10",
"error": ""
}
}
]
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.
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:
Para maiores informações sobre cadastro de módulos, acessar: Manutenção de Módulo(MEN004AA).