Histórico da Página
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 | - | ||
Movimento | Inclusão/Alteração | RM \ 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: 1_0012.009
- SourceCode (Evento)
- GUID: 1efe6424-027b-44af-8dd3-ef18a527d6b6
- 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, sempre virá já rateado para os itens (Campo F2_VALACRS). 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. O campo do Protheus referente ao valor líquido é o F2_VALBRUT. 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: desnecessário em integração com o Protheus pois sempre haverá um Cliente/Fornecedoresta informação será gravada no RM somente se for enviado na mensagem.
Nome Adquirente: desnecessário em integração com o Protheus pois sempre haverá um Cliente/Fornecedoresta 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 é o valor unitário líquido obtido será o preço do produto.
- Natureza da Operação: Obtida a partir da seguinte fórmula: (valor unit. - desconto + acréscimo).
- Natureza da Operação: Obtida a partir da Tributação.
- Tributação.
Alíquota: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).
Movimento associado ao Cupom Fiscal
O serviço de inclusão de Cupom Fiscal também realizar 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:
Etapa | Campo | Valor |
---|---|---|
Mov - Identificação | Numeração | 2.X.XX |
Mov - Datas 1/2 | Edição da Data de Emissão | Edita ou Mostra |
Mov - Valores Financeiros 1/4 | Desconto | Marcado |
Tipo de Desconto | Valor | |
Despesa | Marcado | |
Tipo de Despesa | Valor | |
Item - Valores Financeiros 1/2 | Utilizar Desconto | Marcado |
Nome do Desconto | Desconto | |
Afeta Desconto do Movimento | Marcado | |
Tipo do Desconto | Valor | |
Utilizar Despesa | Marcado | |
Nome da Despesa | Despesa | |
Tipo de Despesa | Valor | |
Fin - Condições de Pagamento | Utiliza edição de Meios de Pagamento | Marcado |
Fis - Dados | Emite Cupom Fiscal | Marcado |
Opcional
Fluxo do Processo
<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>.
- 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 Tipo de Documento:
SAT: 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:
Etapa | Campo | Valor | Observação |
---|---|---|---|
Mov - Identificação | Código | 2.X.XX | Tipo de movimento utilizado para NFC-e deve começar como 2.2.XX. |
Edita Numeração | Edita ou Mostra | ||
Mov - Datas 1/2 | Edição da Data de Emissão | Edita ou Mostra | |
Mov - Valores Financeiros 1/4 | Desconto | Marcado | |
Tipo de Desconto | Valor | ||
Despesa | Marcado | ||
Tipo de Despesa | Valor | ||
Item - Valores Financeiros 1/2 | Utilizar Desconto | Marcado | |
Nome do Desconto | Desconto | ||
Afeta Desconto do Movimento | Desmarcado | ||
Tipo do Desconto | Valor | ||
Utilizar Despesa | Marcado | ||
Nome da Despesa | Despesa | ||
Tipo de Despesa | Valor | ||
Afeta Despesa do Movimento | Desmarcado | ||
Fin - Condições de Pagamento | Utiliza edição de Meios de Pagamento | Marcado | |
Fis - Dados | Emite Cupom Fiscal | Marcado | Para Cupom Fiscal Tipo SAT este parâmetro deve ficar desmarcado. |
Fis - Escrituração 1/2 | Código Default Tipo Documento Escrituração | Informar Código do Tipo de Documento | Para 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-e | NFC-e | Informar o Tipo de Envio | Para 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.23.
CUPOM FISCAL ELETRÔNICO – SAT / NFC-e
Fluxo do Processo
Mapeamento de Campos
Mensagem: RetailSales
Mapeamento de Campos
Mensagem: RetailSales 1.001
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|NUMEROSellerInternalIdInternalId 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 VendaTCUPOMFISCALVALORRECEBIDO DiscountValueValor Total de DescontoTCUPOMFISCALDESCONTO IncreaseValueValor de AcréscimoTCUPOMFISCALACRESCIMO NetPriceValor Líquido da VendaTCUPOMFISCALVALORLIQUIDO 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 Venda IssueDateDocumentData de Emissão da VendaTCUPOMFISCALDATAEMISSAO DocumentCodeNumero do DocumentoTCUPOMFISCALNUMEROConsistir tamanho do campo:
RM: inteiro tamanho 4
PROTHEUS: string tamanho 9
SerieCodeSerie do DocumentoTPONTOVENDASERIE GrossPriceValor Bruto da VendaTCUPOMFISCALVALORRECEBIDORepetir ou desconsiderar?CommodityPriceValor Total da Mercadoria DiscountPercentPercentual de Desconto da Venda OperatorCodeCodigo 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 Documento Md5Código Md5 NewHotel ElectronicInvoiceComplementInformações Complementares NFCe PersonalIdentificationCPF/CGC do ClienteTCUPOMFISCALCNPJCPFADQUIRENTE IsCanceledInforma se venda esta canceladaTCUPOMFISCALCANCELADO ListOfSaleItem\ListOfSaleItemTypeLista de Itens da Venda ListOfSaleCondition\ListOfTaxesTypeLista de Impostos da Venda StationSalePointCodeCódigo Ponto de VendaTPONTOVENDAPONTOVENDA StationSalePointInternalIdInternalId do Ponto de VendaTPONTOVENDACODCOLIGADA|PONTOVENDA ListOfSaleItemTypeLista de Itens da VendaSaleItem\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 15ItemOrderOrdem do ItemTCUPOMFISCALITMNUMEROITEMNo RM este campo é inteiro de tamanho 4.QuantityQuantidade do ItemTCUPOMFISCALITMQUANTIDADE UnitPricePreço Unitário do ItemTCUPOMFISCALITMPRECOUNITARIO ItemPriceValor do ItemTCUPOMFISCALITMVALORBRUTO 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 ListOfTaxesTypeIncreaseValor 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 VendaTipo responsável por trafegar os impostos:ITF, COFINS, CSLL, FABOV, FACS, INSS-PF, INSS-PJ, INSS-RUR, IOF, IR-CARRETEIRO, IR-PF, IR-PJ, IRRF–PF, IRRF–PJ, ISS, ISS-ARQ-ELET, PIS, PIS/COFINS/CSLL, PIS/COFINS-CRED, PIS/COFINS-PROD, SEST/SENAT,ICM, IPI, II.
Arquivo: "Tax_1_002.xsd"
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|