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/Exclusão | RM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Cadastros \ Fiscais\ Mais...\ Cupom Fiscal | - |
Tabelas Utilizadas
- TCUPOMFISCAL – Cupom Fiscal
- TCUPOMFISCALITM - Itens de Cupom Fiscal
- TCUPOMFISCALFIN - Pagamentos do Cupom Fiscal
Entidades de Integração
- DataServer envolvido
- MovCupomFiscalData
- Transformação
- Id: RetailSales
- Versão: 1_001
- SourceCode (Evento)
- GUID:
- GUID:
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.
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á 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/Fornecedor.
Nome Adquirente: desnecessário em integração com o Protheus pois sempre haverá um Cliente/Fornecedor.
Item do Cupom Fiscal:
- Preço unitário: O preço unitário enviado pelo Protheus é o valor unitário líquido obtido a partir da seguinte fórmula: (valor unit. - desconto + acréscimo).
- 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).
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>.
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|NUMERO |
| ||||
SellerInternalId | InternalId do Vendedor | TPONTOVENDA | CODVEN1 | Buscar o código do vendedor no cadastro de Estação PDV | ||||
ComissionPercent | Percentual da Comissão | |||||||
CustomerVendorInternalId | InternalId do Código do Cliente | TCUPOMFISCAL | CODCOLCFO|CODCFO | |||||
TotalPrice | Valor Total da Venda | TCUPOMFISCAL | VALORRECEBIDO | |||||
DiscountValue | Valor Total de Desconto | TCUPOMFISCAL | DESCONTO | |||||
IncreaseValue | Valor de Acréscimo | TCUPOMFISCAL | ACRESCIMO | |||||
NetPrice | Valor Líquido da Venda | TCUPOMFISCAL | VALORLIQUIDO | |||||
CashValue | Valor Pago em Dinheiro | |||||||
ChecksValue | Valor Pago em Cheques | |||||||
CardsValue | Valor Pago em Cartões de Crédito | |||||||
DebitValue | Valor Pago em Cartões de Débito | |||||||
CovenantValue | Valor Pago com Convênio | |||||||
VouchersValue | Valor Pago com Vales | |||||||
FinancedValue | Valor Pago com Financiamento | |||||||
OthersValue | Valor Pago com Outras Formas | |||||||
InputValue | Valor de Entrada | |||||||
IssueDateDocument | Data de Emissão da Venda | |||||||
IssueDateDocument | Data de Emissão da Venda | TCUPOMFISCAL | DATAEMISSAO | |||||
DocumentCode | Numero do Documento | TCUPOMFISCAL | NUMERO | Consistir tamanho do campo: PROTHEUS: string tamanho 9 | ||||
SerieCode | Serie do Documento | TPONTOVENDA | SERIE | |||||
GrossPrice | Valor Bruto da Venda | TCUPOMFISCAL | VALORRECEBIDO | Repetir ou desconsiderar? | ||||
CommodityPrice | Valor Total da Mercadoria | |||||||
DiscountPercent | Percentual de Desconto da Venda | |||||||
OperatorCode | Codigo do Operador | |||||||
CurrencyRate | Taxa da Moeda | |||||||
Change | Valor do Troco na Venda | |||||||
StationCode | Código da Estação | |||||||
DiscountPaymentTerm | Desconto Financeiro na Venda | |||||||
CreditValue | Valor de Crédito da Venda | |||||||
KindOfDocument | Tipo do Documento | |||||||
Md5 | Código Md5 NewHotel | |||||||
ElectronicInvoiceComplement | Informações Complementares NFCe | |||||||
PersonalIdentification | CPF/CGC do Cliente | TCUPOMFISCAL | CNPJCPFADQUIRENTE | |||||
IsCanceled | Informa se venda esta cancelada | TCUPOMFISCAL | CANCELADO | |||||
ListOfSaleItem\ListOfSaleItemType | Lista de Itens da Venda | |||||||
ListOfSaleCondition\ListOfTaxesType | Lista de Impostos da Venda | |||||||
StationSalePointCode | Código Ponto de Venda | TPONTOVENDA | PONTOVENDA | |||||
StationSalePointInternalId | InternalId do Ponto de Venda | TPONTOVENDA | CODCOLIGADA|PONTOVENDA | |||||
ListOfSaleItemType | Lista de Itens da Venda | |||||||
---|---|---|---|---|---|---|---|---|
SaleItem\SaleItemType | Itens | |||||||
InternalId | InternalId do Item da Venda | TCUPOMFISCALITM | CODCOLIGADA | IDCUPOM | NUMEROITEM | |||||
ItemInternalId | InternalId do Produto | TCUPOMFISCALITM | CODCOLIGADA|IDPRD | |||||
ItemCode | Código do Produto | TPRODUTO | CODIGOPRD | No RM campo tem tamanho 30 e na mensagem está definido com tamanho 15 | ||||
ItemOrder | Ordem do Item | TCUPOMFISCALITM | NUMEROITEM | No RM este campo é inteiro de tamanho 4. | ||||
Quantity | Quantidade do Item | TCUPOMFISCALITM | QUANTIDADE | |||||
UnitPrice | Preço Unitário do Item | TCUPOMFISCALITM | PRECOUNITARIO | |||||
ItemPrice | Valor do Item | TCUPOMFISCALITM | VALORBRUTO | |||||
DiscountPercentage | Percentual de Desconto do Item | Não utilizado no RM. | ||||||
DiscountAmount | Valor do Desconto do Item | TCUPOMFISCALITM | DESCONTO | |||||
OperationCode | Código Fiscal de Operações e Prestações | DCFOP | CODNAT | |||||
ListOfTaxes | Lista de Impostos do Item | Ver ListOfTaxesType | ||||||
Increase | Valor de Acréscimo do Item | TCUPOMFISCALITM | ACRESCIMO | |||||
Lodging | Produto é Diaria | Não utilizado no RM. | ||||||
IsCanceled | Informa se o item esta cancelado | TCUPOMFISCALITM | CANCELADO | |||||
WarehouseCode | Código do Local de Estoque(Armazém) | TPONTOVENDA | CODLOC | |||||
WarehouseInternalId | Id de integração do Local de Estoque(Armazém) | TPONTOVENDA | CODCOLIGADA|CODFILIAL|CODLOC | |||||
ECFTaxingCode | Código da Tributação ECF | TCUPOMFISCALITM | TRIBUTACAOECF | |||||
ListOfTaxesType \ Tax | Lista de Impostos da Venda | Tipo 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"ver TaxesType | ||||||
ListOfSaleConditionType \ SaleCondition | Condições de Pagamento da Venda | ver SaleConditionType | ||||||
SaleConditionType | ||||||||
AccountReceivableDocumentInternalId | InternalId do RA do cliente | |||||||
DateOfPayment | Data de Vencimento da Parcela | TCUPOMFISCALFIN | DATAVENCIMENTO | |||||
PaymentValue | Valor do Pagamento | TCUPOMFISCALFIN | VALOR | |||||
PaymentMethodCode | Forma de Pagamento | TCUPOMFISCALFINTFORMAPAGTO | IDFORMAPAGTOCODFORMAPAGTO | |||||
PaymentMethodInternalId | Chave de Integração de Forma de Pagamento | TCUPOMFISCALFIN | CODCOLIGADA|IDFORMAPAGTO | |||||
FinancialManagerCode | Código da Administradora Financeira | |||||||
CardNumber | Numeração do Cheque | TCUPOMFISCALFIN | CHEQUE | |||||
SerieCheck | Série do Cheque | Não utilizado no RM | ||||||
BankCheck | Banco do Cheque | TCUPOMFISCALFIN | BANCO | |||||
AgencyCheck | Agência Bancária do Cheque | TCUPOMFISCALFIN | AGENCIA | |||||
AccountCheck | Número da Conta do Cheque | TCUPOMFISCALFIN | CC | |||||
DocumentOfIdentification | Documento de Identidade do Cliente - Cheque | Não utilizado no RM | ||||||
PhoneNumber | Telefone do Cliente - Cheque | TCUPOMFISCALFIN | TELEMITENTE | |||||
EftDate | Data do Pagamento - TEF | |||||||
EftDocument | Documento de Identificação TEF | |||||||
EftAutorization | Código de Autorização TEF | |||||||
EftCancellationDate | Data de Cancelamento TEF | |||||||
EftCancellationDocument | Número do Cancelamento TEF | |||||||
EftInstitute | Código do Instituto TEF | |||||||
UniqueSerialNumber | Código NSU - TEF | |||||||
EftParcel | Parcelamento TEF |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|