Aviso
Produto ainda em fase de piloto.
Fomato de resposta:
CONTEÚDO
- Visão Geral
- Exemplo de utilização
- Dados enviados
- Principais Campos e Parâmetros
- Moeda do Movimento Bancário
- Campo específico/customizado
- Entidades Contábeis
- Principais Campos e Parâmetros
- 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 envio de dados deve ser realizado via SmartLink utilizando o Padrão CloudEvents para envio de mensagens no formato Json.
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.
O atributo type indica o evento a ser executado no ERP. O job FWTotvsLinkJob identifica uma nova mensagem e excuta a classe MOVreadXGsp, responsável pela inclusão do Movimento Bancário (FINA100) via rotina automática. O fonte que contém a classe MOVreadXGsp é o FINI100G.prw.
Fomato de resposta:
03. DADOS ENVIADOS
a. Principais Campos e Parâmetros
a1. Movimento Bancário a Pagar ou Receber
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_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. |
a2. Transferência Bancária
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 |
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 | X | N/A |
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 | Caractere | 10 | X | N/A |
CNATURDES | Natureza destino | Caractere | 10 | X | N/A |
CTIPOTRAN | Tipo da Transferência | Caractere | 6 | X | N/A |
CDOCTRAN | Número do Documento | Caractere | 15 | X | 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) |
SYSCODE | Chave identificadora Gesplan | Caractere | X | N/A | |
ID | Código de Controle Gesplan | Caractere | X | N/A |
a3. Estorno de Transferências
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 |
AUTNRODOC | Número do Documento | Caractere | 15 | X | N/A |
AUTDTMOV | Data da Movimentação | Caractere | 10 | X | Data enviada em formato caractere ddmmaaaa ex: "08/09/2022" |
AUTBANCO | Código do banco | Caractere | 3 | X | Código do banco que se refere o documento a ser estornado |
AUTAGENCIA | Agência do banco | Caractere | 5 | X | Agência do banco que se refere o documento a ser estornado |
AUTCONTA | Conta corrente no banco | Caractere | 10 | X | Conta a que se refere o documento a ser estornado |
E5_RECPAG | Tipo de Movimento | Caractere | 1 | X | Enviar: "X" → Estorno da Transferência |
SYSCODE | Chave identificadora Gesplan | Caractere | X | N/A | |
ID | Código de Controle Gesplan | Caractere | X | N/A |
b. Moeda do Movimento Bancário
O Movimento Bancário será gerado na moeda do banco informado. Sendo assim, quando apresentado em relatórios e consultas, somente terá seu valor convertido se a moeda solicitada nos parâmetros for diferente da moeda do cadastro do banco.
c. Campo específico/customizado
Existe a possibilidade de enviar qualquer outro campo existente no dicionário de dados da tabela SE5 do ambiente onde está sendo processada a mensagem. Esse campo pode ser um campo padrão (não exemplificado na tabela acima) ou um campo customizado (criado especificamente para o ambiente Protheus em que a integração está ativa). Nesse caso, basta que seja inserida uma nova linha no conteúdo da mensagem, com o mesmo formato Chave/Valor, conforme exemplo abaixo, onde inserimos os campos E5_DEBITO (campo padrão do produto) e E5_XDTCLI (campo específico do ERP do cliente).
d. Entidades Contábeis
Abaixo os principais campos representando as entidades contábeis que podem ser utilizadas para classificação do movimento.
- E5_DEBITO - Conta Débito
- E5_CREDITO - Conta Crédito
- E5_CCD - Centro de Custo Débito
- E5_CCC - Centro de Custo Crédito
- E5_ITEMD - Item Contábil Débito
- E5_ITEMC - Item Contábil Crédito
- E5_CLVLDB - Classe Valor Débito
- E5_CLVLCR - Classe Valor Crédito
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.IMPORTANTE!
04. TABELAS UTILIZADAS
- SE5- Movimentação Bancária
- FK5- Movimentos Bancários
- FK8- Dados Contábeis