Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.

  

Informações Gerais


Especificação

Produto

Datasul

Módulo

ACR - Contas a Receber

Segmento Executor

Manufatura

Projeto

MANFIN01

EPIC

MANFIN01-891

Story

MANFIN01-1029

Subtarefa

MANFIN01-1109

País

(  ) Brasil  (  ) Argentina  (  ) Mexico  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colombia   (  ) Outro _____________.

Outros




Objetivo

 

Criar uma API de Negócio do Datasul responsável em receber informações referente a uma Fatura proveniente do TMS Protheus. A partir desta Fatura, serão gerados Títulos no Conta a Receber do Datasul.

Este documento descrevem as Regras de Negócio envolvidas na integração e os tratamentos dentro do Contas a Receber. A integração será realizar através do EAI utilizando o conceito de Mensagem Única TOTVS. Os detalhes da criação da Mensagem XML e o Adapter estão descritos no documento: http://tdn.totvs.com/display/LDT/ER_MANFIN01-1030_ELLECE-TMSxACR-Mensagem_Recebimento_Fatura_Adapter


Definição da Regra de Negócio


Geração de Faturas


No TMS são registrados os Conhecimentos de Transportes, ou CT-e’s, que são a representação legal do transporte realizado. É através deste documento, que a Empresa realiza a cobrança contra o Cliente.

Esta cobrança é realizada através de uma Fatura, que pode conter um ou mais Conhecimentos dependendo da configuração de cada Cliente.

No processo de Geração de Faturas no TMS Protheus será realizada uma integração com o Contas a Receber do Datasul para geração de Títulos. Para cada Fatura, poderão ser gerados um ou mais Títulos no Contas a Receber, dependendo da Condição de Pagamento do Cliente e se o Sistema permitir o parcelamento (este será um parâmetro novo).

Juntamente com as informações da Fatura, o TMS também irá enviar ao Datasul a Lista de Conhecimentos pertencentes a ela. Esta lista, será incluída no Histórico do Título, para que seja possível consultar diretamente no financeiro. Além da Chave do Conhecimento, também será enviado o Tipo dele, para que seja possível diferenciar sua origem, desta forma, podendo gerar Títulos no Contas a Receber com características diferentes, por exemplo, outra espécie.

Após a Geração do Título, o Datasul irá devolver as informações dele, para posterior consulta no TMS. Além disto, também serão devolvidas as informações de Cobrança (Juros, Desconto, Banco, etc...), para que seja possível gerar o DOCCOB através do TMS.


Informações da Faturas


Ao realizar a integração, o TMS irá enviar as seguintes informações ao Datasul:

Informação

Descrição

Operação

Indica a ação realizada, podendo ser:

Informações da Fatura

Empresa, Estabelecimento, Código da Fatura, Estabelecimento de Débito, Informações de Cliente, Data de Emissão, Data de Vencimento, Valor e Moeda.

Observação: O Título será criado no Estabelecimento de Débito da Fatura, caso ele não tenha sido informado, será considerado o Estabelecimento de Geração da Fatura.

Lista de Conhecimentos da Fatura

Informações do Conhecimento: Estabelecimento, Número, Série e Tipo.



Devolução das Informações


Após a criação dos Títulos no Contas a Receber, o Datasul irá retornar as seguintes informações ao TMS:

Informação

Descrição

Informações do Título

Empresa, Estabelecimento, Espécie, Série, Número, Parcela, Cliente, Moeda, Valor Bruto, Valor Líquido, Saldo, Data de Emissão e Data de Vencimento

Informações de Cobrança

Carteira Bancária, Valor de Juros por Dia de Atraso, Data limite para Desconto, Valor de Desconto, Banco, Agência e Conta Corrente. Ver detalhes de como será a busca das informações em Devolução das Informações de Cobrança


Tradução das Informações


Algumas das informações enviadas na Fatura, estarão relacionadas a Cadastros que não serão replicados entre os produtos, por possuírem algum conceito, ou formato diferente. Neste caso será feito um processo de Tradução das Informações, conforme abaixo:

Informação

Descrição

Empresa e Estabelecimento

Ao receber a Mensagem de Fatura, será realizado a tradução destas informações através do conceito “de-para” do EAI. Que irá traduzir a informação do Aplicativo Externo (TMS Protheus), para o equivalente no Foundation do Datasul.

Este tratamento será realizado no Adapter da Mensagem, detalhado no documento: http://tdn.totvs.com/display/LDT/ER_MANFIN01-1030_ELLECE-TMSxACR-Mensagem_Recebimento_Fatura_Adapter

Depois, estas informações serão novamente traduzidas do Foundation para o Financeiro do Datasul. Isto será realizado através da Matriz de Tradução Organização Externa. A matriz de Tradução utilizada, será a que estiver parametrizada no cadastro “Parâmetros de Integração Operador Logístico/Transportes” descrito no documento: http://tdn.totvs.com/display/LDT/ER_MANFIN01-1045_ELLECE-CAD-Parametros_Gerais

Caso a Matriz não tenha sido informada nos Parâmetros, será utilizada a matriz chamada “EMS2”.

Moeda

Esta informação será traduzida através da Matriz de Tradução de Finalidade Externa. A matriz de Tradução utilizada, será a que estiver parametrizada na Matriz de Tradução Organização Externa para a Empresa enviada na Fatura, conforme regras de tradução descritas acima para “Empresa”.

Cliente

A regra para a relação entre o Cadastro do TMS e do Datasul desta informação, está descrita no documento: http://tdn.totvs.com/display/LDT/ER_MANFIN01-1045_ELLECE-CAD-Mensagem_Receb_Cliente_Fornecedor_XML_API

Observação: A nova API criada para integração, estará preparada para receber também os códigos internos do Datasul para as informações descritas acima. Caso o código interno seja enviado, será considerado diretamente ele, caso contrário, será realizada a tradução das informações conforme as regras descritas acima.


Validações

Neste processo, serão feitas as validações abaixo e se ocorrer algum dos problemas descritos, a integração de Fatura não será realizada:

  • As traduções de Empresa e Estabelecimento devem ser realizadas corretamente pelo Adapter da mensagem (ver regras em: http://tdn.totvs.com/display/LDT/ER_MANFIN01-1030_ELLECE-TMSxACR-Mensagem_Recebimento_Fatura_Adapter);
  • Para todas as informações de Empresa e Estabelecimento enviadas na Fatura, deverá existir uma Tradução na Matriz de Tradução Organização Externa;
  • Deverá existir uma Tradução para a Moeda da Fatura, parametrizada na Matriz de Tradução de Finalidade Externa;
  • Deverá existir um Cliente cadastrado no Datasul relacionado o Cliente do TMS enviado na Fatura. E este Cliente deverá ter o cadastro de Cliente Financeiro criado.


Âncora
Geração de Títulos no Contas a Receber
Geração de Títulos no Contas a Receber
Geração de Títulos no Contas a Receber


Sempre que for enviada uma Fatura ao Contas a Receber, será verificado se aquela Fatura já foi alguma vez integrada. Caso afirmativo, os Títulos relacionados a Fatura, serão estornados utilizando as mesmas regras do Cancelamento de Fatura (Ver detalhes em: Estorno de Títulos e Estorno de Substituição) e será gerada uma nova Faturaserão gerados novos Títulos, utilizando as novas informações enviadasda Fatura, conforme regras descritas abaixo. Caso, pelas regras definição a chave do Título fique a mesma, será incrementada a Parcela.

Os Títulos poderão ser gerados de duas formas no Contas a Receber, através de uma Inclusão ou uma Substituição, isto será determinado conforme a integração dos Conhecimentos de Transporte com o Módulo de Faturamento do Datasul.

Para cada Conhecimento registrado no TMS, será realizada uma integração com o Módulo de Faturamento do Datasul, para geração de uma Nota Fiscal. A Natureza de Operação desta Nota Fiscal poderá estar parametrizada para gerar ou não Financeiro (Parâmetro: “Emite Duplicata”). Caso a Natureza esteja parametrizada para emitir duplicada, será gerado um Título no Contas a Receber, que irá representar o Conhecimento de Transporte. Para esta integração do Faturamento com o Contas a Receber, serão utilizadas as mesmas regras já existentes hoje, no que diz respeito as informações para criação do Título (Espécie, Série, Rateio Contábil, etc...).

No momento da Integração da Fatura como o Contas a Receber, será verificado se os Conhecimentos da Fatura possuem um Títulos relacionados (títulos gerados a partir da Nota Fiscal). Caso afirmativo, os Títulos de Conhecimentos serão baixado através de uma Substituição, para geração de um novo Título que irá representar a Fatura. Caso os Conhecimentos não tenham Títulos relacionados, será gerado o Título de Fatura através de uma inclusão normal.


Validações

Neste processo, serão feitas as validações abaixo e se ocorrer algum dos problemas descritos, a integração de Fatura não será realizada:

  • A Fatura deve ter no mínimo um Conhecimento;
  • Em uma mesma Fatura, não podem existir Conhecimentos que estejam relacionados a Notas Fiscais com parametrização diferente (que atualizam ou não o Financeiro);
  • Para todos os Conhecimentos enviados na Fatura, deve existir uma Nota Fiscal relacionada no Módulo de Faturamento do Datasul;
  • Se a Nota Fiscal relacionada ao Conhecimento possuir uma Natureza de Operação que atualiza o Financeiro (“Emite Duplicata = Sim”), deverá existir um Título no Contas a Receber relacionado a Nota Fiscal.


Âncora
Inclusão de Títulos
Inclusão de Títulos
Inclusão de Títulos


Para determinar as informações que serão utilizadas para criação do Títulos, serão utilizados os seguintes cadastros:

Serão verificadas as informações abaixo no Cadastro de Seleção de Recebimento Padrão, para determinar qual Recebimento Padrão será utilizado na Inclusão do Título:

Informação

Valor

Transação

Fixo: “Fatura de Transporte”

Código da Transação

Tipo do Conhecimento

Estabelecimento

Estabelecimento de Débito da Fatura

Cliente

Cliente da Fatura

Detalhes das regras que serão utilizadas para achar o Recebimento Padrão, estão descritos no seguinte documento: http://tdn.totvs.com/display/LDT/ER_MANFIN01-1033_ELLECE-TMSxACR-Selecao_Recebimento_Padrao_API

Para inclusão do Título, será utilizada a última versão da API de Implantação de Títulos ACR900ZI, passando as informações conforme descrito a abaixo.


Informações do Títulos

Segue abaixo as informações que serão utilizadas para criação do Título no Contas a Receber:

Informação

Valor

Empresa

Empresa de Geração da Fatura conforme tradução.

Estabelecimento

Estabelecimento de Débito da Fatura conforme tradução. Caso o Estabelecimento de Débito não seja informado, será utilizado o Estabelecimento de Geração da Fatura conforme tradução.

Origem

TMS

Referência

Automática, baseada na data da atual.

Cliente

Cliente da Fatura conforme tradução.

Espécie

Espécie do Recebimento Padrão.

Série

Série do Recebimento Padrão.

Nr. Documento

Código da Fatura.

Parcela

Sequencial conforme número de Parcelas da Condição de Pagamento.

Moeda

Moeda da Fatura conforme tradução.

Data de Transação

Data de Geração da Fatura. Se não for enviada, será considerada a Data Atual.

Data de Emissão

Data de Emissão da Fatura.

Data de Vencimento

Para a primeira Parcela, será considera a Data de Vencimento da Fatura, as demais, serão calculadas conforme a Condição de Pagamento. Caso não seja informada, será calculada conforme a Condição de Pagamento a partir da Data de Emissão.

Valor

Será o Valor da Fatura. Caso a Condição de Pagamento possua mais de uma parcela, o valor será rateado entre as parcelas, conforme percentual parametrizado na Condição de Pagamento.

Portador / Carteira

Conforme Recebimento Padrão. Caso não tenham sido informados no Recebimento Padrão, serão utilizadas as informações do Cliente Financeiro.

Condição de Cobrança

Conforme Recebimento Padrão.

Motivo de Movimento

Conforme Recebimento Padrão.

Informações de Desconto

Conforme Condição de Cobrança.

Informações de Juros

Conforme Condição de Cobrança.

Informações de Multa

Conforme Condição de Cobrança.

Rateio Financeiro/Contábil

Conforme Motivo de Movimento.

Histórico

Será a lista de Conhecimentos da Fatura, conforme exemplo abaixo:

Conhecimentos:

Estab: XXXXX / Série: XXXXX / Número: XXXXXXXXX

Estab: XXXXX / Série: XXXXX / Número: XXXXXXXXX

Observação: Caso o Cliente não tenha Condição de Pagamento parametrizada, será considerado a Condição de Pagamento do Grupo de Cliente.


Validações

Neste processo, serão feitas as validações abaixo e se ocorrer algum dos problemas descritos, a integração de Fatura não será realizada:

  • Todos os Cadastros devem ser Traduzidos corretamente, conforme regras de tradução descritas anteriormente;
  • O Cliente ou o Grupo de Cliente, deve ter uma Condição de Pagamento parametrizada;
  • Se a Condição de Pagamento do Cliente possuir mais de uma parcela, o Datasul deve estar parametrizado para permitir parcelamento. Observação: Este parâmetro está disponível nos “Parâmetros de Integração Operador Logístico/Transportes”, mas inicialmente ele não estará na tela e não poderá ser alterado, sendo sempre igual a “Não”. Ele somente será disponibilizado para alteração, quando o TMS for preparado para receber mais de um Título para a mesma Fatura;
  • Deverá existir uma Parametrização de “Seleção de Recebimento Padrão” que retorno um Recebimento Padrão, conforme a Transação, Código de Transação, Estabelecimento e Cliente da Fatura;
  • Para o Motivo de Movimento parametrizado no Recebimento Padrão selecionado, deve existir um Rateio Contábil/Financeiro cadastrado;
  • Em uma mesma Fatura, não poderão existir Conhecimentos de Tipos diferentes que apontem para Recebimentos Padrões diferentes;
  • Demais validações realizadas atualmente pela API de Implantação de Títulos.


Relacionamento Fatura x Títulos

Para cada Título que for criado, será salvou o relacionamento dele com a Fatura em uma nova tabela chamada “fatur_acr_integr”, gravando a Chave da Fatura e a Chave do Título.


Alteração na API de Implantação de Títulos (ACR900ZI)

Atualmente a API de Implantação de Títulos permite que seja enviada a Condição de Cobrança, desta forma, as informações de Juros e Multa serão buscadas de lá. Mas, mesmo passando a Condição de Cobrança, ele não utiliza as informações de Desconto cadastras nela. Sendo necessário passar estas informações para a API.

Em virtude disto, a API será alterada para receber um novo parâmetro indicando se deve ou não buscas as informações de Desconto da Condição de Cobrança.

Se o parâmetro for igual a “Não”, considera a regra existente hoje, mas se ele for “Sim”, a Condição tenha sido informada e as informações de Desconto não tenham sido enviadas para a API, serão consideradas as informações cadastradas na Condição de Cobrança.

No caso da Integração do TMS com o Contas a Receber, este parâmetro será sempre passado como “Sim”.


Âncora
Substituição de Títulos
Substituição de Títulos
Substituição de Títulos


Títulos Origem

Os Títulos Origem da Substituição serão os Títulos gerados a partir da Nota Fiscal que foi gerada a partir dos Conhecimentos relacionados a Fatura.

Para cada Conhecimento da Fatura, será encontrada a Nota Fiscal equivalente, considerando a chave do Conhecimento como a mesma da Nota Fiscal (Estabelecimento - conforme regras de Tradução, Série e Número). Após encontrar a Nota Fiscal, será buscado o Título gerado a partir dela, conforme regras de relacionamento já existentes no produto.


Títulos Destino

Para geração dos Títulos de Destino serão utilizadas as mesmas Regras da Inclusão de Títulos descritas anteriormente, utilizando os Cadastros de Seleção e Recebimento Padrão.

As informações do Título também serão atualizadas seguindo as mesmas regras da inclusão, com as seguintes diferenças:

  • Não será considerando o Motivo de Movimento pois, para Substituição é utilizado o mesmo Rateio Financeiro/Contábil dos Títulos de Origem;
  • As informações de Desconto não serão consideras, pois a substituição na trata estas informações.

Para realizar a Substituição dos Títulos, será utilizada a última versão da API de Substituição de Títulos ACR902ZC.


Validações

Neste processo, serão feitas as validações abaixo e se ocorrer algum dos problemas descritos, a integração de Fatura não será realizada:

  • Deverá ser possível encontrar os Títulos gerados a partir das Notas Fiscais geradas a partir dos Conhecimentos;
  • Mesmas regras da Inclusão Títulos descritas anteriormente, com exceção da validação de Rateio do Motivo de Movimento, que não é necessário;
  • Demais validações realizadas atualmente pela API de Substituição de Títulos.


Âncora
Estorno de Títulos
Estorno de Títulos
Estorno de Títulos


Ao cancelar uma Fatura no TMS, todos os Títulos gerados a partir dela no Contas a Receber serão estornado.

Para o estorno dos Títulos, será utilizada a última versão da API de Estorno de Títulos ACR715ZB.

Para encontrar os Títulos relacionados a Fatura, será verificado a tabela de Relacionamento Fatura x Títulos (fatur_acr_integr) utilizando a chave da Fatura. Se o estorno for bem sucedido, esta tabela de relacionamento será eliminada.

A referência desta Transação, será gerada automaticamente baseada na data atual.

Para data de Estorno, será considerado a Data de Transação do Título, caso esta Data esteja em um período já fechado na Contabilidade, será considerado a data em que está sendo realizado o Cancelamento da Fatura.


Validações

Neste processo, serão feitas as validações abaixo e se ocorrer algum dos problemas descritos, o estorno não será realizado:

  • Deverá ser possível encontrar os Títulos relacionados a Fatura;
  • Deverá ser possível estornar todos os Títulos relacionados a Fatura de uma só vez. Por exemplo, se existirem dois títulos relacionados e um deles apresentar problemas, nenhum será estornado;
  • Demais validações realizadas pela API de Estorno de Títulos.


Âncora
Estorno de Substituição
Estorno de Substituição
Estorno de Substituição


Caso os Títulos tenham sido gerados a partir de uma Substituição, ela será estornada e os Títulos Origem (Títulos de Conhecimento) terão seu saldo restaurado.

Para o estorno da Substituição, será utilizada a última versão da API de Estorno de Substituição ACR718ZA.

Para encontrar os Títulos relacionados a Fatura e calcular a Referência e a data de Estorno, serão utilizadas as mesmas regras do Estorno de Título, descritas anteriormente.


Validações

Neste processo, serão feitas as validações abaixo e se ocorrer algum dos problemas descritos, o estorno não será realizado:

  • Mesmas regras realizadas no Estorno de Títulos;
  • Demais validações realizadas pela API de Estorno de Substituição.


Âncora
Devolução das Informações de Cobrança
Devolução das Informações de Cobrança
Devolução das Informações de Cobrança


Após a criação dos Títulos no Contas a Receber, além das principais informações, o Datasul também irá devolver ao TMS as informações de Cobrança, que serão encontradas conforme abaixo:

Informação

Descrição

Carteira Bancária

Carteira Bancária do Título.

Valor de Juros por Dia de Atraso

Percentual de Juros por Dia de Atraso do Título, multiplicado pelo Valor Original do Título.

Data limite para Desconto

Data de Desconto do Título.

Valor de Desconto

Percentual de Desconto do Título, multiplicado pelo valor Original do Título.

Banco, Agência e Conta Corrente

Informações Bancárias da Conta Corrente parametrizada no Cadastro de Finalidade Econômica x Portador, conforme Estabelecimento, Portador, Carteira e Finalidade Econômica do Título.

OBS: Para Agência e Conta Corrente será acrescentado o dígito verificador.



Protótipo de Tela

Não há.

 

Fluxo do Processo

 



Dicionário de Dados


Âncora
fatur_acr_integr
fatur_acr_integr
Integração Fatura x ACR

   

Tabela

Descrição

Banco

Módulo

fatur_acr_integr

Integração Fatura x Contas a Receber

movfin

ACR

Campo

Tipo

Tamanho

Valor Inicial

Mandatório

Título

Abrev

Picture

Help de Campo

cod_estab_faturCHAR5
SimEstab FaturaEst Faturx(5)Código Estabelecimento Fatura
cod_faturCHAR16
SimFaturaFaturax(16)Código da Fatura
cod_parcelaCHAR2
SimParcelaParcx(02)Parcela
cod_estab_titCHAR5
SimEstabelec TituloEstab Titulox(5)Código Estabelecimento Titulo
cod_espec_doctoCHAR3
SimEspécie DocumentoEspéciex(3)Código Espécie Documento
cod_ser_doctoCHAR5
SimSérie DocumentoSériex(5)Código Série Documento
cod_tit_acrCHAR16
SimTítuloTítulox(16)Código Título Contas a Receber

Livres Padrões









Índice

Tipo

Chave

idPrimário / Únicocod_estab_fatur + cod_fatur + cod_parcela
titulo
cod_estab_tit + cod_espec_docto + cod_ser_docto + cod_tit_acr + cod_parcela

 

Relacionamento entre as Tabelas

Tabela Pai

Campo do Pai

Tabela Filho

Campo do Filho

tit_acrcod_estabfatur_acr_integrcod_estab_tit
tit_acrcod_espec_doctofatur_acr_integrcod_espec_docto
tit_acrcod_ser_doctofatur_acr_integrcod_ser_docto

tit_acr

cod_tit_acrfatur_acr_integrcod_tit_acr
tit_acrcod_parcelafatur_acr_integrcod_parcela



Grupo de Perguntas

Não há. 


Consulta Padrão

Não há.

 

Estrutura de Menu

Não há. 


...