Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Revertida da versão 73

 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

TOTVS Gestão de Estoque, Compras e Faturamento

Módulo

Faturamento

Segmento Executor

Construção e Projetos

Projeto1

Integração BackOffice RM x PDV Protheus

IRM1

PCREQ-7769

Requisito1

PCREQ-8877

Subtarefa1

PDR_CP_MOV009-100

Chamado2


Release de Entrega Planejada

12.1.10

Réplica

Não

País

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

(  ) USA  (  ) Colombia   (  ) Outro _____________.

Outros

<Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>.

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

Objetivo

 

 Implementação do adapter de integração via Mensagem Única TOTVS do cadastro de Cupom Fiscal com o PDV PROTHEUS, viabilizando assim o CRUD completo do cadastro por recebimento de mensagem de integração.


Definição da Regra de Negócio

 

Considera-se como escopo deste requisito a implementação do adapter de recebimento de Mensagens Únicas TOTVS para integração do cadastro de Cupom Fiscal, estando o adapter de envio desta mesma mensagem fora do escopo do requisito.

 

 A análise e o desenvolvimento do adapter será efetuado considerando a integração com o PDV Protheus, mas também viabilizará a integração com outras fontes de dados desde que respeitado o layout da mensagem.

 

Rotina

Tipo de Operação

Opção de Menu

Regras de Negócio

Cupom Fiscal

Inclusão/Alteração

RM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Cadastros \ Fiscais\ Mais...\ Cupom Fiscal

-

MovimentoInclusão/AlteraçãoRM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Vendas \ Faturamento\ Movimentação-

 

Tabelas Utilizadas

  • TCUPOMFISCAL – Cupom Fiscal
  • TCUPOMFISCALITM - Itens de Cupom Fiscal
  • TCUPOMFISCALFIN - Pagamentos do Cupom Fiscal
  • TMOV - Movimentos
  • TITMMOV - Itens de Movimento

Entidades de Integração

  • DataServer envolvido
    • MovCupomFiscalData
  • Transformação
    • Id: RetailSales
    • Versão: 21_007001
  • SourceCode (Evento)
    • GUID: 1efe6424-027b-44af-8dd3-ef18a527d6b6

Regras de Integridade:

Ao receber mensagem de Cupom Fiscal serão realizadas as seguintes ações para os campos abaixo:

Cupom Fiscal:

  • COO: será utilizado o mesmo campo que o número.
  • CRO: será obtido a partir do default do cadastro de Estação no RM, sendo assim é necessário ao cadastrar o Ponto de Venda informar este campo.
  • Redução Z: deve ser preenchido após a integração do cupom fiscal, não sendo então integrado.

  • Acréscimo: No Protheus o acréscimo é por cupom, com rateio para os itens. No RM esta informação será preenchido no campo VALORDESP que é a soma das despesas dos itens ou despesa aplicada ao cupom, NÃO irá incluir itens CANCELADOS. Caso não seja enviado acréscimo, será considerado como valor default o valor 0 (zero).
  • Valor Líquido: a fórmula de cálculo para obter o valor líquido é:  VALORLIQUIDO = ( ∑ ( Preço item X Quantidade item) - Desconto + Acréscimo total ). Não deve ser considerado Itens Cancelados. Caso não seja enviado o valor líquido será considerado como valor default o valor 0 (zero).
  • Valor Recebido: será preenchido com o mesmo valor do campo Valor Líquido.
  • Desconto: No RM o campo que armazena esta informação é VALORDESC. Este campo é soma dos descontos dos itens ou desconto aplicado ao cupom, NÃO inclui itens CANCELADOS! Caso não seja enviado o valor líquido será considerado como valor default o valor 0 (zero). Sempre será lido o valor líquido e as despesas do valor original enviado. Mas os descontos, serão recalculados para evitar erro no arredondamento.
    Observação: no Protheus o desconto pode ser por item, por cupom, ou ambos. 
  • CNPJ Adquirente: esta informação será gravada no RM somente se for enviado na mensagem.

  • Nome Adquirente: esta informação será gravada no RM somente se for enviado na mensagem.

Item do Cupom Fiscal:

  • Preço unitário: O preço unitário enviado pelo Protheus será o preço do produto.
  • Natureza da Operação: Obtida a partir da Tributação.
  • Alíquota: Obtida a partir da Tributação.

  • CST: Obtida a partir da Tributação.

Lista de Pagamentos:

  • Débito/Crédito: fixo crédito (não será trafegado).


Cupom Fiscal - SAT / NFC-e:

Serão aplicadas as mesmas regras listadas acima para Cupom Fiscal, porém este tipo de Cupom irá criar um Movimento, ou seja, não será gerado o registro na tabela de Cupom Fiscal.

O tipo de movimento de venda que será utilizado é o definido no cadastro de Ponto de Venda. Neste tipo de movimento na etapa Fis - Escrituração 1/2, deve ser informado o um Tipo de Documento:SAT que possui Código do Modelo 59 - CUPOM FISCAL ELETRÔNICO – SAT (CF-E-SAT).NFC-e: Código do Modelo 65 - Nota Fiscal Eletrônica ao Consumidor Final.


Movimento associado ao Cupom Fiscal

O serviço de inclusão de Cupom Fiscal também realiza a inclusão de um movimento e associa este movimento ao Cupom. Sendo assim torna-se necessário informar no cadastro de Ponto de Venda qual será o Tipo de Movimento de Venda que será utilizado. Este tipo de movimento deve possuir as seguintes configurações mínimas:

EtapaCampoValorObservação
Mov - IdentificaçãoCódigo2.X.XXTipo de movimento utilizado para NFC-e deve começar como 2.2.XX.
Edita NumeraçãoEdita ou Mostra
Mov - Datas 1/2Edição da Data de EmissãoEdita ou Mostra
Mov - Valores Financeiros 1/4DescontoMarcado
Tipo de DescontoValor
DespesaMarcado
Tipo de DespesaValor
Item - Valores Financeiros 1/2Utilizar DescontoMarcado
Nome do DescontoDesconto
Afeta Desconto do MovimentoDesmarcado
Tipo do DescontoValor
Utilizar DespesaMarcado
Nome da DespesaDespesa
Tipo de DespesaValor
Afeta Despesa do MovimentoDesmarcado
Fin - Condições de PagamentoUtiliza edição de Meios de PagamentoMarcado
Fis - DadosEmite Cupom FiscalMarcadoPara Cupom Fiscal Tipo SAT este parâmetro deve ficar desmarcado.
Fis - Escrituração 1/2Código Default Tipo Documento EscrituraçãoInformar Código do Tipo de DocumentoPara Cupom Fiscal Tipo SAT o Tipo de Documento informado deve possui Código Modelo do Documento 59 - CUPOM FISCAL ELETRÔNICO – SAT (CF-E-SAT).

Para Cupom Fiscal Tipo NFC-e o Tipo de Documento informado deve possui Código Modelo do Documento 65 - Nota Fiscal Eletrônica ao Consumidor Final.

Fis - NF-eNFC-eInformar o Tipo de EnvioPara Cupom Fiscal Tipo NFC-e este campo deve estar selecionado como Integrado por Terceiro.


Restrições e Ponto de Atenção

  • Cadastros necessários
    Para integrar o Cupom Fiscal é necessário realizar o cadastro e/ou carga inicial dos seguintes cadastros:
    • Envio de Unidade de Medida;

    • Envio de Produto / Códigos de Barras; 

    • Envio de Ponto de Venda; 

    • Envio de Vendedor.

  • Número do Caixa
    Na integração entre Protheus e RM sem mensagem única, é gravado neste campo o mesmo valor informado para o código do Ponto de Venda (F2_PDV). Como o Número do Caixa do Cupom Fiscal no RM é do tipo inteiro e no Protheus este campo é do tipo texto, na integração atual via mensagem única esta informação será desconsiderada. Caso seja necessário realizar/ajustar algum relatório relacionado a esta informação, deve-se considerar do código do Ponto de Venda.

  • Lista de Taxas
    A lista de taxas (ListOfTaxesType) que serão aplicadas na Venda devem ser definidas no Tipo de Movimento uma vez que estas informações são desconsideradas no recebimento da mensagem e os valores de tributação são recalculados no RM.


  • Aplicação de Desconto/Acréscimo no Movimento
    Para que o Desconto e Acréscimo seja corretamente aplicada no Movimento é obrigatório que o tipo de movimento esteja parametrizado como utilizado por "Valor" para estas duas informações, para o Movimento e para os Itens de Movimento. Caso contrário pode haver diferenças no arredondamento e assim gerar erros na inclusão.
     
  • Rateio de Desconto/Acréscimo
    O rateio de desconto e acréscimo dos itens é calculado sempre que existir desconto e acréscimo informado por Cupom. Como no Protheus o desconto pode ser por item, por cupom ou ambos, ao receber um Cupom o RM irá recalcular o rateio de desconto dos itens para evitar erro no arredondamento. 

  • Cupom Fiscal - SAT
    Esta integração está disponível a partir do release 12.1.14.
  • Cupom Fiscal - NFC-e
    Esta integração está disponível a partir do release 12.1.22.



CUPOM FISCAL ELETRÔNICO – SAT / NFC-eSAT (CF-E-SAT) - Modelo 59

Fluxo do Processo

 


Mapeamento de Campos

 

Mensagem: RetailSales 21.007001

 

Mensagem Padrão

Descrição

RM

Tabela

Campo

Observação

CompanyId

Código da empresa.

TCUPOMFISCAL

CODCOLIGADA

Código da Coligada é obtido a partir do De-Para de Filial.

BranchId

Código da filial



CompanyInternalId

InternalId da chave completa de empresa do produto



InternalId

InternalId de Integração

TCUPOMFISCAL

CODCOLIGADA|PONTOVENDA|CRO|NUMERO


SellerInternalIdInternalId do VendedorTPONTOVENDACODVEN1Buscar o código do vendedor no cadastro de Estação PDV

ComissionPercent

Percentual da Comissão


CustomerVendorInternalIdInternalId do Código do ClienteTCUPOMFISCALCODCOLCFO|CODCFO
TotalPriceValor Total da Venda


DiscountValueValor Total de DescontoTCUPOMFISCALDESCONTO
IncreaseValueValor de AcréscimoTCUPOMFISCALACRESCIMO
NetPriceValor Líquido da VendaTCUPOMFISCALVALORLIQUIDO e VALORRECEBIDO
CashValueValor Pago em Dinheiro


ChecksValueValor Pago em Cheques


CardsValueValor Pago em Cartões de Crédito


DebitValueValor Pago em Cartões de Débito


CovenantValueValor Pago com Convênio


VouchersValueValor Pago com Vales


FinancedValueValor Pago com Financiamento


OthersValueValor Pago com Outras Formas


InputValueValor de Entrada


IssueDateDocumentData de Emissão da VendaTCUPOMFISCALDATAEMISSAO
DocumentCodeNumero do DocumentoTCUPOMFISCALNUMERO

Consistir tamanho do campo:
RM: inteiro tamanho 4

PROTHEUS: string tamanho 9 

SerieCodeSerie do DocumentoTPONTOVENDASERIE
GrossPriceValor Bruto da VendaTCUPOMFISCALVALORRECEBIDO
CommodityPriceValor Total da Mercadoria


DiscountPercentPercentual de Desconto da Venda


OperatorCodeCódigo do Operador


CurrencyRateTaxa da Moeda


ChangeValor do Troco na Venda


StationCodeCódigo da Estação


DiscountPaymentTermDesconto Financeiro na Venda


CreditValueValor de Crédito da Venda


KindOfDocumentTipo do DocumentoTCUPOMFISCALTIPOCampo interno no DataServer para definir tipo do Cupom Fiscal. Possui os seguintes valores:
  • CF - Cupom Fiscal de Venda
  • SATCE - SAT
  • NFCE - NFC-e



Md5Código Md5 NewHotel


ElectronicInvoiceComplementInformações Complementares NFCe


PersonalIdentificationCPF/CGC do ClienteTCUPOMFISCALCNPJCPFADQUIRENTE
PurchaserNameNome do AdquirenteTCUPOMFISCALNOMEADQUIRENTE
IsCanceledInforma se venda esta canceladaTCUPOMFISCALCANCELADO
ListOfSaleItem\ListOfSaleItemTypeLista de Itens da VendaVer ListOfSaleItemType
ListOfTaxesTypeLista de Impostos da VendaNão há necessidade de integrar valores de tributação pois será recalculado no RM.
StationSalePointCodeCódigo Ponto de VendaTPONTOVENDAPONTOVENDA
StationSalePointInternalIdInternalId do Ponto de VendaTPONTOVENDACODCOLIGADA|PONTOVENDA
SerialNumberSATEquipamentNúmero de Série do equipamento SATTMOVFISCALNROSAT
SaleTypeTipo de vendaTCUPOMFISCALTIPO

Campo interno no DataServer para definir tipo do Cupom Fiscal. Possui os seguintes valores:

  • V - Cupom Fiscal de Venda
  • S - SAT
Observação: Este campo não deve ser utilizado a partir da versão 12.1.22, e sim o campo KindOfDocument.
KeyAcessNFeChave de acesso NFeTMOVCHAVEACESSONFEEste campo será exibido no Movimento quando Código Tipo de Documento for CUPOM FISCAL ELETRÔNICO – SAT (CF-E-SAT) - Modelo 59 ou Nota Fiscal Eletrônica ao Consumidor Final - Modelo 65.
ListOfSaleItemTypeLista de Itens da Venda
SaleItem\SaleItemTypeItens


InternalIdInternalId do Item da VendaTCUPOMFISCALITMCODCOLIGADA | IDCUPOM | NUMEROITEM
ItemInternalIdInternalId do ProdutoTCUPOMFISCALITMCODCOLIGADA|IDPRD
ItemCodeCódigo do ProdutoTPRODUTOCODIGOPRDNo RM campo tem tamanho 30 e na mensagem está definido com tamanho 15
ItemOrderOrdem do ItemTCUPOMFISCALITMNUMEROITEMNo RM este campo é inteiro de tamanho 4.
QuantityQuantidade do ItemTCUPOMFISCALITMQUANTIDADE
UnitPricePreço Unitário do ItemTCUPOMFISCALITMPRECOUNITARIO
ItemPriceValor do ItemTCUPOMFISCALITMVALORLIQUIDO
DiscountPercentagePercentual de Desconto do Item

Não utilizado no RM.
DiscountAmountValor do Desconto do ItemTCUPOMFISCALITMDESCONTO
OperationCodeCódigo Fiscal de Operações e PrestaçõesDCFOPCODNAT
ListOfTaxesLista de Impostos do ItemVer ListOfTaxesType
IncreaseValor de Acréscimo do ItemTCUPOMFISCALITMACRESCIMO
LodgingProduto é Diaria

Não utilizado no RM.
IsCanceledInforma se o item esta canceladoTCUPOMFISCALITMCANCELADO
WarehouseCodeCódigo do Local de Estoque(Armazém)TPONTOVENDACODLOC
WarehouseInternalIdId de integração do Local de Estoque(Armazém)TPONTOVENDACODCOLIGADA|CODFILIAL|CODLOC
ECFTaxingCodeCódigo da Tributação ECFTCUPOMFISCALITMTRIBUTACAOECF
ListOfTaxesTypeLista de Impostos da VendaNão há necessidade de integrar valores de tributação pois será recalculado no RM.
ListOfSaleConditionType \ SaleConditionCondições de Pagamento da Vendaver SaleConditionType
SaleConditionType
AccountReceivableDocumentInternalIdInternalId do RA do cliente


DateOfPaymentData de Vencimento da ParcelaTCUPOMFISCALFINDATAVENCIMENTO
PaymentValueValor do PagamentoTCUPOMFISCALFINVALOR
PaymentMethodCodeForma de PagamentoTFORMAPAGTOCODFORMAPAGTONo RM o campo possui tamanho 10 e no xsd está definido como 15.  
PaymentMethodInternalIdChave de Integração de Forma de PagamentoTCUPOMFISCALFINCODCOLIGADA|IDFORMAPAGTO
FinancialManagerCodeCódigo da Administradora Financeira

Não utilizado no RM.
CardNumberNumeração do ChequeTCUPOMFISCALFINCHEQUENo RM o campo possui tamanho 20 caracteres. Criar consistência para quando receber valor maior que 20, uma vez que no XSD da mensagem está definido tamanho 30 caracteres.
SerieCheckSérie do Cheque

Não utilizado no RM
BankCheckBanco do ChequeTCUPOMFISCALFINBANCO
AgencyCheckAgência Bancária do ChequeTCUPOMFISCALFINAGENCIANo RM campo possui tamanho de 20 caracteres e no XSD está definido tamanho 8 caracteres. Não teremos problemas no Recebimento, mas se for enviar esta mensagem talvez seja necessário alterar o tamanho do campo.
AccountCheckNúmero da Conta do ChequeTCUPOMFISCALFINCC
DocumentOfIdentificationDocumento de Identidade do Cliente - Cheque

Não utilizado no RM
PhoneNumberTelefone do Cliente - ChequeTCUPOMFISCALFINTELEMITENTE
EftDateData do Pagamento - TEF


EftDocumentDocumento de Identificação TEF


EftAutorizationCódigo de Autorização TEF


EftCancellationDateData de Cancelamento TEF


EftCancellationDocumentNúmero do Cancelamento TEF


EftInstituteCódigo do Instituto TEF


UniqueSerialNumberCódigo NSU - TEF


EftParcelParcelamento TEF


  • Somente os campos marcados em negrito são tratados no Adapter.




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