Layout de Integracao 029 WSOPaf

Manual de Integração OPaf
Layout de integração WSOPaf
Layout de Integração 029
Aplicável à versão 6.2 e demais releases da suíte de aplicativos Opaf (SAT / NFCe)*Versão Futura
Aplicável à versão 8.1 e demais releases da suíte de aplicativos OPaf (ECF)
OPaf ® é marca registrada da ID Brasil Sistemas Ltda

Olá! Este é o seu manual...
Este manual visa orientar a execução de serviços destinados a integração do software OPaf, de propriedade da ID Brasil
Sistemas Ltda, com o sistema de gestão (SG) do Parceiro Integrador.
A comunicação entre os sistemas é um processo relativamente simples, todavia, mudanças nos detalhes podem levar a
resultados inesperados. Assim é fundamental que todas as orientações desse manual sejam seguidas à risca para evitar
transtornos e situações inesperadas.
Sugestões de melhoria para esse manual podem ser enviadas por meio de ticket que pode ser cadastrado em nossa
Central de Atendimento no site da ID Brasil – www.idbrasil.com. Suas sugestões serão bem vindas e nos auxiliam a deixar
o nosso material cada vez melhor.
Este manual é parte integrante do Software OPaf, e sua utilização para fins não autorizados sujeita o Parceiro Integrador
às responsabilidades previstas em lei.
Índice
Layout de integração WSOPaf .............................................................................................................................................. 1
Olá! Este é o seu manual... ................................................................................................................................................... 2
Índice .................................................................................................................................................................................... 3
O que é o projeto WSOPaf? ................................................................................................................................................. 5
Termos técnicos utilizados neste manual ............................................................................................................................ 6
Informações necessárias para a integração ......................................................................................................................... 7
Efetuando os downloads e instalando as aplicações necessárias.................................................................................... 7
Verificação do sistema operacional ................................................................................................................................. 7
O processo de integração para remessas ............................................................................................................................ 8

Como funciona o processo de integração? ...................................................................................................................... 8
Exemplificando o arquivo XML ...........................................................................................................................................10

Efetuando os ajustes finais.................................................................................................................................................11
Executando o WSOPaf.jar ..............................................................................................................................................11
Testando o funcionamento do WSOPaf.jar....................................................................................................................11
Especificidades do processo ...............................................................................................................................................12

Campos obrigatórios, validações e vínculos...................................................................................................................12
Truncando os valores do documento.............................................................................................................................14
Calculando descontos.....................................................................................................................................................14
Calculando valor total de DAVs e pré-vendas seguindo o padrão OPaf ........................................................................15
Formato dos campos ..........................................................................................................................................................16

Finalidade dos registros de integração ..............................................................................................................................16
Layout dos arquivos de integração ....................................................................................................................................18
A – ARQUIVO XML ..........................................................................................................................................................18
B – INFORMAÇÕES DO ESTABELECIMENTO ...................................................................................................................18
C – INFORMAÇÕES DO DAV ...........................................................................................................................................18
D – ATUALIZAÇÃO DE DAV .............................................................................................................................................19
E – DAV – OS ...................................................................................................................................................................20
F – PRÉ-VENDA / CONTA DE CLIENTE .............................................................................................................................21
G – PRODUTOS (Para lançamento de DAV e Pré-Venda) ...............................................................................................22
H – ITENS VENDIDOS (Para lançamento de DAV e Pré-Venda) ......................................................................................22

I – VENDEDOR (Para lançamento de DAV e Pré-Venda) ................................................................................................23
J – Cadastro de Clientes..................................................................................................................................................24
K – Cadastro de Clientes .................................................................................................................................................24
L – Cliente (Para lançamento de DAV e Pré-Venda).......................................................................................................24
M – Dados do cliente (Para lançamento de DAV / Pré-Venda e Cadastros de Clientes) ...............................................24
N – FINANCEIRO (Para Lançamento de DAV e Pré-Venda .............................................................................................25
O – PARCELAS DO FINANCEIRO (Para lançamento de DAV e Pré-Venda)......................................................................26
P – Cadastro de Produtos ...............................................................................................................................................26
Q – Cadastro de Produtos ..............................................................................................................................................26
R – Cadastro de Referência Vinculada ...........................................................................................................................27
S – Cadastro de Referência Vinculada ............................................................................................................................28
T –Cadastro de Preço do Produto ..................................................................................................................................28
U –Cadastro de Preço do Produto..................................................................................................................................28
V –PREÇO DO PRODUTO ................................................................................................................................................28

O que é o projeto WSOPaf?
O WSOPaf é uma solução utilizada na integração de sistemas e na comunicação entre aplicações diferentes. Com esta
tecnologia é possível que o seu ERP possa interagir com o OPaf e que mesmo sistemas desenvolvidos em plataformas
diferentes sejam compatíveis. O WSOPaf é um componente que permitem às aplicações de retaguarda enviar e receber
dados em formato XML. Cada aplicação pode ter a sua própria "linguagem", que é traduzida para uma linguagem
universal, o formato XML.
Para as empresas parceiras, o WSOPaf pode trazer agilidade para os processos e eficiência na comunicação entre os
sistemas, integrando o processo de DAV e Pré-Venda através de uma homologação híbrida. Toda e qualquer
comunicação entre sistemas passa a ser dinâmica e principalmente segura, pois não há intervenção humana.
Termos técnicos utilizados neste manual
TERMO DESCRIÇÃO
ID Abreviatura da TAG
Campo Nome do campo
Descrição Descrição para a TAG em questão
TAG Pai Qual TAG é a origem deste registro
Verifique tabela OCORRÊNCIA abaixo
Exemplo:
Ocor.
0 – 1 – Não é obrigatória
1 – 1 – TAG obrigatória
Min. – Max Representa o número mínimo e o número máximo de ocorrências em relação

(Referente à Ocor.) a tag Pai do campo e a sua obrigatoriedade.
Tipo de informação utilizado no campo
Tipo
(vide tabela TIPOS)
Tam. Tamanho destinado aos caracteres
Dec. Quantidade de decimais
Observação Observações reservada ao TAG
Informações necessárias para a integração
Para proceder à integração dos sistemas, é necessário saber previamente algumas configurações feitas para criar o
ambiente necessário para a integração dos dados.
Efetuando os downloads e instalando as aplicações necessárias

O primeiro passo será efetuar os downloads necessários e realizar as verificações de ambiente para que o processo seja
efetuado de forma coesa.
Efetue o download do aplicativo Java (Java SE Runtime Environment), disponível através do link direto para download
da softwarehouse da aplicação (Oracle) http://www.oracle.com/technetwork/java/javase/downloads/jre-7u2-
download-1377135.html selecionando a plataforma correta do seu sistema operacional.
Após efetuar o download, instale o aplicativo do modo padrão proposto pela da software house da aplicação (Oracle).
Verificação do sistema operacional

É muito importante que sejam realizadas verificações no Sistema Operacional de seu cliente seguindo as instruções do
item mencionado abaixo antes de instalar o OPaf, pois estas verificações e parametrização assegurarão que o OPaf não
terá nenhum problema em sua execução é um passo obrigatório.
Para isto, verifique o Item 4.3.1 - Sistemas Operacionais. Escolha o sistema operacional correspondente ao utilizado
pelo seu cliente e efetue as configurações e verificações necessárias.
O processo de integração para remessas
(Envio de dados de DAVs e PVs do SG para o OPaf)
Como funciona o processo de integração?

O WSOPaf funcionará em um layout específico, onde a empresa parceira deverá ter um aplicativo separado do seu ERP
para emissão de DAVs e Pré-Vendas que será homologado em conjunto com o OPaf (Homologação híbrida).
Nesta ilustração, demonstra-se o processo sendo efetuado e retornando um status válido.
O usuário utilizará o SOFTWARE INTEGRAÇÃO,

que gerará um arquivo XML contendo os dados
referentes à DAV ou PV, que será capturado pelo
WEBSERVICE, será realizada a VALIDAÇÃO DE
XML para verificar a integridade dos dados.
Após a validação do XML, se o retorno for positivo

e o XML ACEITO, o webservice gerará um
RETORNO DE INFORMAÇÃO ao software
integração afirmando que o processo foi aceito,
simultaneamente, o WEBSERVICE adicionará os
dados ao banco de dados do OPaf, que já estarão
disponíveis para utilização.
Nesta ilustração, demonstra-se o

processo sendo efetuado e
retornando um status recusado.
O usuário utilizará o SOFTWARE INTEGRAÇÃO,
que gerará um arquivo XML contendo os dados
referentes à DAV ou PV, que será capturado
pelo WEBSERVICE, será realizada a VALIDAÇÃO
DE XML para verificar a integridade dos dados.
Após a validação do XML, se o retorno for

negativo e o XML RECUSADO, o webservice
gerará um RETORNO DE INFORMAÇÃO ao
software integração afirmando que o processo
foi recusado, simultaneamente, o WEBSERVICE
retornará os software integração para ajustes
no documento.
Exemplificando o arquivo XML
Neste tópico iremos exemplificar um arquivo XML básico, para maiores verificações, entre em contato com o suporte e
execute o download dos arquivos de exemplo.
<xml.ArquivoXml>
<estabelecimento>
<cnpj>04625063000194</cnpj>
<versaoXml>029</versaoXml>
</estabelecimento>
<dav>
<idDocSg>152</idDocSg>
<titulo>PEDIDO</titulo>
<valor>90.00</valor>
<tabelaPreco>A VISTA</tabelaPreco>
<observacao1>observacao1</observacao1>
<cpfNaNota>S</cpfNaNota>
<tipo>D</tipo>
<desconto>10.00</desconto>
<operador>CAIXA</operador>
<operadorAutorizouDesconto>SUPORTE</operadorAutorizouDesconto>
<operadorAutorizouClienteInativo></operadorAutorizouClienteInativo>
<faturamentoAutomatico>S</faturamentoAutomatico>
<produtos>
<xml.ProdutoXml>
<idProduto>01</idProduto>
<ordem>1</ordem>
<quantidade>10.000</quantidade>
<status></status>
<acrescimo>0.00</acrescimo>
</xml.ProdutoXml>
<xml.ProdutoXml>
<idProduto>02</idProduto>
<ordem>2</ordem>
<quantidade>2.000</quantidade>
<status>C</status>
<operadorAutorizouCancelamento>SUPORTE</operadorAutorizouCancelamento>
<acrescimo>0.00</acrescimo>
</xml.ProdutoXml>
</produtos>
<cliente>
<id>01</id>
</cliente>
<vendedor>
<id>003</id>
</vendedor>
<financeiro>
<xml.ParcelaXml>
<idForma>1</idForma>
<ordem>1</ordem>
<dataVencimento>01/01/2018</dataVencimento>
</xml.ParcelaXml>
<xml.ParcelaXml>
<idForma>2</idForma>
<ordem>2</ordem>
<dataVencimento>01/01/2018</dataVencimento>
</xml.ParcelaXml>
</financeiro>
</dav>
</xml.ArquivoXml>
Efetuando os ajustes finais
Para terminar o processo, precisamos efetuar alguns ajustes para que o funcionamento do WSOPaf seja efetuado
normalmente e sem erros. Efetue as verificações abaixo.
Executando o WSOPaf.jar
Execute o WSOPaf.jar clicando 02 vezes sobre o arquivo e configure o IP do serviço com o IP da máquina e
portaServico=8080 (pode ser 8080 ou outra definida no cliente) onde o OPaf estiver instalado e irá realizar o
faturamento dos cupons fiscais.
Testando o funcionamento do WSOPaf.jar

Testar no navegador se o serviço (JAVA) está rodando na máquina utilizando o seguinte endereço
“ip_da_máquina:8080/WSOPaf?wsdl”, onde o ip_da_máquina deverá ser o IP da máquina onde o OPaf estiver
instalado conforme parametrizado no tópico anterior. Após este passo, teste a comunicação diretamente pelo
aplicativo.
Especificidades do processo
Para que o processo esteja realmente alinhado, temos algumas especificidades para que o funcionamento do WSOPaf
seja efetuado normalmente e sem erros. Efetue as verificações abaixo.
Campos obrigatórios, validações e vínculos

O SOFTWARE INTEGRADOR deverá executar o truncamento dos valores a fim de não gerar divergência nos valores.
 A01 - Arquivo obrigatório e deverá ter um valor válido, seguindo o padrão estabelecido no layout
 B01 - Arquivo obrigatório e deverá ter um valor válido, seguindo o padrão estabelecido no layout
 B02 - Deverá ser o mesmo CNPJ cadastrado no ECF (o mesmo presente no BD do OPaf), seguindo o padrão
estabelecido no layout
 B03 - Deverá, por padrão, ser 029, seguindo o padrão estabelecido no layout
 C02 - Se presente C01, é obrigatório e deverá ser um número sequencial, não poderá utilizar a mesma
numeração pois é um PK e deverá seguir o padrão estabelecido no layout
 C03 - Se presente C01, é obrigatório e deverá ser o mesmo título da DAV informado no configurador na aba
Concentrador > DAV/PV > Títulos para o DAV, seguindo o padrão estabelecido no layout
 C04 - Se presente C01, é obrigatório e deverá ter um valor válido, seguindo o padrão estabelecido no layout
 C05 - Se presente C01, é obrigatório e deverá ser a mesma tabela de preços informada no configurador na aba
PAF > Tabelas de preços > Tabela de preços padrão, seguindo o padrão estabelecido no layout
(atentar-se aos itens TRUNCANDO OS VALORES DO DOCUMENTO, CALCULANDO DESCONTOS e CALCULANDO
VALOR TOTAL DE DAVS E PRÉ-VENDAS SEGUINDO O PADRÃO OPAF contidos neste mesmo item do nosso
manual)
 C14 - Se presente C01, é obrigatório e deverá ter um valor válido, atentando-se de que o operador deverá ser o
mesmo logado no OPaf, seguindo o padrão estabelecido no layout
 E01 - Se C12 for igual à "S", este registro é obrigatório
 E02 - Se presente E01, é obrigatório e deverá ter um valor válido, seguindo o padrão estabelecido no layout
 F02 - Deverá ser a PK informada ao documento pelo OPaf e deverá seguir o padrão estabelecido no layout
 F03 - Se presente F01, é obrigatório e deverá ser um número sequencial, não poderá utilizar a mesma
numeração pois é um PK e deverá seguir o padrão estabelecido no layout
 F04 - Se presente F01, é obrigatório e deve seguir o padrão estabelecido no layout
 F05 - Se presente F01, é obrigatório e deverá ser a mesma tabela de preços informada no configurador na aba
PAF > Tabelas de preços > Tabela de preços padrão, seguindo o padrão estabelecido no layout
 F09 - Se presente F01, é obrigatório e deverá ter um valor válido, atentando-se de que o operador deverá ser o
mesmo logado no OPaf, seguindo o padrão estabelecido no layout
 F12 - Se presente F01, é obrigatório e deverá ter um valor válido, seguindo o padrão estabelecido no layout
VALOR TOTAL DE DAVS E PRÉ-VENDAS SEGUINDO O PADRÃO OPAF contidos neste mesmo item)
 G01 - Se presente C01 ou F01, é obrigatório e deve seguir o padrão estabelecido no layout
 H01 - Se presente G01, é obrigatório e deve seguir o padrão estabelecido no layout
 H02 - Se presente G01, é obrigatório, deverá possuir um código de produto válido, ser informada de forma
ordenada e sequencial (para mais de 01 (um) produto) e que conste no banco de dados do OPaf, e deve seguir
o padrão estabelecido no layout
 H03 - Se presente G01, é obrigatório, deverá seguir uma ordenação, não poderá se repetir e deve seguir o padrão
 H10 - Se presente G01, é obrigatório e deverá ter um valor válido, seguindo o padrão estabelecido no layout
 H11 - Se presente G01, é obrigatório e deverá ter um valor válido, seguindo o padrão estabelecido no layout
(atentar-se aos itens TRUNCANDO OS VALORES DO DOCUMENTO, CALCULANDO ACRÉSCIMO e CALCULANDO
 J01 - Se presente C01, F01 ou L01, é obrigatório e deve seguir o padrão estabelecido no layout
 M02 - Se presente M01, não é obrigatório, mas poderá ser utilizado ser o cliente informado constar no banco
de dados do OPaf (Se informar esta TAG, não será necessário informar as TAGs M03 à M12) e deve seguir o
padrão estabelecido no layout
 M03 - Se presente M01, é obrigatório e deve seguir o padrão estabelecido no layout
 M04 - Se presente M01, é obrigatório, deve seguir o padrão estabelecido no layout e conter uma numeração
válida para o documento em questão
 O01 - Se presente N01, é obrigatório, deve ser informada de forma ordenada e sequencial (para mais de 01
(uma) forma de pagamento) e deve seguir o padrão estabelecido no layout
 O02 - Se presente N01, é obrigatório, deverá seguir o mesmo padrão das formas de pagamento cadastradas no
banco de dados do OPaf e também seguir o padrão estabelecido no layout
 O03- Se presente N01, é obrigatório, deve ser informada de forma ordenada e sequencial e deve seguir o padrão
 O04 - Se presente N01, é obrigatório e deve seguir o padrão estabelecido no layout
 O05 - Se presente N01, é obrigatório e deve seguir o padrão estabelecido no layout
Truncando os valores do documento

O SOFTWARE INTEGRADOR deverá executar o truncamento dos valores a fim de não gerar divergência nos valores.
Exemplo:
Produto A
Quantidade = 2,660
Valor unitário do produto = R$ 2,17
Valor total do produto = R$ 5,7722 (2,66 * R$ 2,17 = quantidade * valor unitário do produto)
Valor total do produto com truncamento = R$ 5,77 (considera-se somente as 02 (duas) casas decimais)
Calculando descontos
O SOFTWARE INTEGRADOR deverá efetuar o cálculo de desconto conforme descrito abaixo à fim de não gerar
divergência nos valores.
Exemplo:
Produto A
Quantidade = 2,660
Valor total do produto com truncamento = R$ 5,77 (considera-se somente as 02 (duas) casas decimais)
Desconto Unitário = R$ 0,12
Valor total do desconto = R$ 0,3192 (2,66 * R$ 0,12 = quantidade * desconto unitário)

Valor total do desconto com truncamento = R$ 0,31 (considera-se somente as 02 (duas) casas decimais)
Valor líquido do produto = R$5,453 (5,7722 – 0,3192 = Valor total do produto – Valor total do desconto)
Valor líquido do produto com truncamento = R$5,46 (5,77 – 0,31 = Valor total do produto com truncamento – Valor total do desconto com
truncamento)
Calculando valor total de DAVs e pré-vendas seguindo o padrão OPaf
O SOFTWARE INTEGRADOR deverá efetuar o cálculo de total de DAVs e pré-vendas conforme descrito abaixo à fim de
não gerar divergência nos valores.
CALCULO SEM TRUNCAMENTO
Produto A
Quantidade = 2,660
Valor líquido do produto = R$5,453 (R$ 5,7722 –R$ 0,3192 = Valor total do produto – Valor total do desconto)
Produto B
Quantidade = 1,880
Valor líquido do produto = R$1,0152 (R$ 1,0904 –R$ 0,0752 = Valor total do produto – Valor total do desconto)
Total do documento
Valor total do documento = R$ 6,4682 (R$ 5,453 + R$ 1,0152 = valor líquido do produto A + valor líquido do produto B)
CALCULO COM TRUNCAMENTO – PADRÃO DE UTILIZAÇÃO OPAF

Produto A
Quantidade = 2,660
Valor líquido do produto = R$5,46 (R$ 5,77 – R$ 0,31 = Valor total do produto – Valor total do desconto)
Produto B
Quantidade = 1,880
Valor líquido do produto = R$1,02 (R$ 1,09 – R$ 0,07 = Valor total do produto – Valor total do desconto)
Total do documento
Valor total do documento = R$ 6,48 (R$ 5,77 + R$ 1,02 = valor líquido do produto A + valor líquido do produto B)
Formato dos campos
Todos os campos seguem uma orientação rígida sobre os formatos que devem ser utilizados na geração dos arquivos de
integração.
Formato Descrição Exemplo
Composição de números (0 a 9) sem caracteres de “79467903920 ”
C
formatação. “0462506300094”
Composição de caracteres alfanuméricos, podendo ser letras,
X Rua Jose Alencar, 1025 apto 18
números e espaços.
C02 <idDocSg>: (tamanho 13 sem
decimal) = 1 (documento nº 1)
Composição de números (0 a 9), em casos de decimais,
N C04 <valor>: (tamanho 13 com 2
separar por ponto.
decimais) = 78.25 (Valor do
documento R$78,25)
Composição de números que identifica uma data, sem
divisão por qualquer tipo de caractere.
• DD = dia da data com 2 dígitos;
• MM = mês da data com 2 dígitos;
D • AAAA = ano da data com 4 dígitos; Ex: 01/09/2012 13:12:07
• HH = hora do envio com 2 dígitos;
• MM = minuto do envio com 2 dígitos;
• SS = segundos relacionados ao envio com 4 dígitos;
• Não enviar valores inválidos (ex: 30/02/1990 25:00:00);
G Grupos de TAGs Pai Ex: C01
Finalidade dos registros de integração
REGISTRO TIPO
ARQUIVO XML
A Informação obrigatória em todo arquivo XML enviado,
nele estará contido o TAG raiz da exportação.
INFORMAÇÕES DO ESTABELECIMENTO
B Informação obrigatória em todo arquivo XML enviado,
nele estará contido o grupo de informações do estabelecimento.
INFORMAÇÕES DO DAV
C Não é obrigatória (desde que enviado pré-venda ou atualização de DAV)
e reunirá as informações referentes à DAV.
ATUALIZAÇÃO DE DAV
D Não é obrigatória, reunirá as informações referentes à possíveis atualizações
efetuadas em DAVs e deverá ser informada dentro do bloco <dav>.
DAV-OS
E Não é obrigatória e reunirá as informações referentes à DAV-OS
e deverá ser informada dentro do bloco <dav>.
PRÉ-VENDA / CONTA DE CLIENTE
F Não é obrigatória (desde que enviado DAV ou atualização de DAV)
e reunirá as informações referentes à pré-venda.
PRODUTOS
Não é obrigatória (desde que enviado atualização de DAV), reunirá as
G
Informações referentes aos produtos adicionados nos documentos emitidos
e deverá ser informado dentro dos blocos <dav> ou <pv>.
ITENS VENDIDOS
Não é obrigatória (desde que não seja enviado <produtos>), reunirá as
H
informações referentes aos produtos adicionados aos documentos emitidos
e deverá ser informado dentro do bloco <produtos>.
VENDEDOR
Não é obrigatória, reunirá as informações referentes ao vendedor
I
vinculado aos documentos emitidos e deverá ser informado
dentro dos blocos <dav> ou <pv>.
CLIENTE
Informação obrigatória (desde que enviados os blocos <dav> ou <pv>),
J
reunirá as informações referentes ao cliente vinculado aos documentos
emitidos e deverá ser informado dentro dos blocos <dav> ou <pv>.
FINANCEIRO
Não é obrigatória, reunirá as informações referentes às formas de
K
pagamento vinculadas aos documentos emitidos e deverá
ser informado dentro do bloco <dav>.
PARCELAS DO FINANCEIRO
Não é obrigatória (desde que não seja enviado o bloco <financeiro>,
L reunirá as informações referentes às formas de pagamento vinculadas
aos documentos emitidos e deverá ser informado dentro
do bloco <dav>.
Layout dos arquivos de integração
A – ARQUIVO XML
ID Campo Descrição TAG Pai Ocor. Tipo Tam. Dec. Observação
TAG mestre dos

A01 xml.ArquivoXml - 1–1 G - - TAG raiz da exportação
registros
Campo obrigatório e sempre deverá constar no arquivo.
B – INFORMAÇÕES DO ESTABELECIMENTO
Grupo de informações Grupo de informações do

B01 estabelecimento A01 1–1 G - -
do estabelecimento estabelecimento
CPF/CNPJ do
B02 cnpj B01 1–1 C 14 - Somente números
estabelecimento
Versão do Layout de Versão do layout de integração
B03 versaoXml B01 1–1 X 3 -
Integração – deverá ser utilizado o 029
C – INFORMAÇÕES DO DAV
Grupo de informações
C01 dav A01 0–1 G - - Grupo de informações do DAV
do DAV
C02 idDocSg Número do Dav no SG C01 1–1 N 10 - Número do DAV no SG
Identifica o tipo da operação
realizada. EX. "Orçamento"
C03 titulo Título do DAV C01 1–1 X 16 - Para DAV-OS,
obrigatoriamente será
"ORDEM DE SERVIÇO"
C04 valor Valor do DAV C01 1–1 N 13 2 Valor total do DAV (Valor dos
produtos - Valor desconto)
Informar a tabela de preço. A
C05 tabelaPreco Tabela de preço C01 1–1 X 10 - tabela deve estar cadastrada
no Opaf
C06 observacao1 Observação 1 C01 0–1 X 40 - Observação 1
C11 idDavOrigem ID do Dav de Origem C01 0–1 N 13 - Número do DAV de Origem
Tipo do DAV. Informar:
C12 tipo Tipo do DAV C01 1–1 X 1 - “D” – DAV
“S” – DAV – OS
Desconto no total do
C13 desconto C01 1–1 N 13 2 Valor do desconto do DAV
DAV
Operador ativo do OPaf que
C14 operador Operador do OPaf C01 1–1 X 15 -
emitiu o DAV
Operador que autorizou
operadorAutorizouDe Operador que autorizou
C15 C01 0–1 X 15 - desconto excedente do Dav,
sconto desconto antes definida como
operadorAutorizou
Operador que liberou a
operadorAutorizouCli Operador que liberou a venda
C16 venda para cliente C01 0–1 X 15 -
enteInativo para cliente inativo
inativo
Realizar faturamento
Realizar faturamento:
faturamentoAutomati automático C01 0–1 X 1 - "S" - Sim
C17
co
Observação 1 do final da
C18 observacaoCupom1 C01 0-1 X 25 -
venda
Observação 2 do final da
C19 observacaoCupom2 C01 0-1 X 25 -
venda
CPF do cliente deve ser
enviado no
faturamento?
C01 0-1 X 1 - Valores ("S" - Sim ) ou
C20 cpfNaNota OBS: Só se aplica para (“N” – Não)
versão PDV (NFC-e e
SAT)
PDV onde deve ser
pdvFaturamentoAuto faturado o Dav no C01 0-1 N 3 -
C21 Número do PDV
matico faturamento
automático
C01 0–1 N 13 2 Valor do acréscimo do total do
C22 acrescimo Valor do acréscimo
DAV
imprimirComprovant Imprimir comprovante C01 0–1 X 1 - Imprimir comprovante:
C23
ePresente de presente "S" - Sim
D – ATUALIZAÇÃO DE DAV
As tags abaixo deverão ser

Este bloco deverá ser informado para atualizar
D01 C01 0–1 - - - informadas dentro do bloco
um registro de DAV <dav>, somente com os
atributos abaixo
D02 id ID do DAV no Opaf D01 1–1 N 13 - ID da DAV retornado pelo Opaf
Data de hora que a impressão
Data de impressão do
D03 dataImpressao D01 1–1 D - - foi realizada. Formato:
DAV
dd/mm/yyyy hh:mm:ss
Operador ativo do Paf que
realizou a impressão do
DavOperador que autorizou
D04 Operador Operador do Opaf D01 1-1 X 15 - alteração no Dav não
impresso, quando
parâmetrizado como
obrigatório
alteração no Dav não
operadorAutorizouAlt Operador que autorizou impresso, quando
D05 D01 0-1 X 15 -
erarDav alteração no Dav parâmetrizado como
obrigatório
faturamentoAutomati Realizar faturamento Realizar faturamento:

D06 D01 0-1 X 1 -
co automatico "S" - Sim
PDV onde deve ser
pdvFaturamentoAuto faturado o Dav no
D07 D01 0-1 N 3 - Número do PDV
matico faturamento
automático
As tags acima deverão ser informadas dentro do bloco <dav> somente com os campos estipulados
E – DAV – OS
Bloco de informações
E01 davOs C01 0–1 G - - referente às informações do
do DAV-OS
DAV – OS
Código de fabricação do
E02 idFabricacao Código de Fabricação E01 1–1 X 20 -
vaículo
E03 anoFabricacao Ano de fabricação E01 1–1 N 4 - Ano de fabricação do veículo
E04 placa Placa E01 1–1 X 10 - Placa do veículo
E05 renavam Renavan E01 1–1 X 10 - Renavam do veículo
E06 marca Marca E01 1–1 X 20 - Marca do veículo
E07 modelo Modelo E01 1–1 X 20 - Modelo do veículo
E08 Km Quilometragem E01 0–1 N 13 1 Quilometragem do veículo
Estas TAGs deverão ser enviadas somente se a C12 estiver marcada como “S” e deverão ser informadas dentro do bloco <dav>
F – PRÉ-VENDA / CONTA DE CLIENTE
Informações da pré- Grupo de informações da Pré

F01 pv A01 0–1 G - -
Venda/Conta de cliente Venda
Este campo deverá ser
ID da Pré-Venda no
F02 id F01 0–1 N 13 - informado caso seja realizada
OPaf
alguma alteração na pré-venda
Número da pré-Venda Número da pré-Venda/Conta
F03 idDocSg F01 1–1 N 15 -
no SG de cliente no SG
Identificação do Identificação:
F04 identificacao F01 1–1 X 15 -
documento - MESA 1
F05 tabelaPreco Tabela de preço F01 1–1 X 10 - Informar a tabela de preço
Número de pessoas na mesa -
F06 numeroPessoas Número de pessoas F01 0–1 N 4 - Somente para Clientes
restaurantes
Tipo da pré-Venda:
" P" - Padrão
F07 tipoPrevenda Tipo da Pré-Venda F01 1–1 X 1 - "M" - Mesa
"F" - Ficha
"B" - Balcão
"E" - Entrega
Taxa de serviço - Somente
F08 taxaServico Taxa de Serviço F01 0–1 N 13 2
para clientes restaurantes
Operador ativo do OPaf que
F09 operador Operador do OPaf F01 1–1 X 15
emitiu a PV / CC
operadorAutorizouDesc Operador que autorizou Operador que autorizou
F10 F01 0–1 X 15
onto desconto desconto exced. da PV / CC
Valor Líquido da PV / CC (Valor
F11 valor Valor Líquido da PV / CC F01 1–1 N 13 2
produtos - Valor desconto)
Valor do desconto no total da
F12 desconto Valor do desconto F01 1–1 N 13 2
PV / CC
F13 observacao1 Observação 1 F01 0-1 X 40 - Observação 1
operadorAutorizouClien Operador que autorizou venda
venda pra cliente
F18 F01 0-1 X 15 - pra cliente inativo
teInativo inativo
F19 observacaoCupom1 Observação 1 do final F01 0-1 X 25 -

da venda
F20 observacaoCupom2 Observação 2 do final F01 0-1 X 25 -
da venda
CPF do cliente deve ser Valores ("S" - Sim ) ou
F21 cpfNaNota enviado no F01 0-1 X 1 - (“N” – Não)
faturamento?
OBS: Só se aplica para
versão PDV (NFC-e e
SAT)
Valor do acréscimo no total da
F22 acrescimo Valor odo Acréscimo F01 1-1 N 13 2 PV/CC
faturamentoAutomatic Realizar faturamento

F23 F01 0-1 X 1 - Realizar faturamento: “S” - Sim
o automatico
PDV onde deve ser
pdvFaturamentoAutom faturado o Dav no
F24 F01 0-1 N 3 - Numero do PDV
atico faturamento
automatico
imprimirComprovanteP Imprimir comprovante Imprimir comprovante:
F25 F01 0-1 X 1 -
resente de presente "S" - Sim
Quando Tipo “tipoPrevenda” for igual "M" – Mesa (As Tags “faturamentoAutomatico” Igual “S” e “financeiro” (N – FINANCEIRO) só podem ser
enviada na Alteração da Mesa).
Quando tem mais de um PDV no cliente enviar a tag: ”pdvFaturamentoAutomatico” contendo o número do PDV para faturar, caso não enviar o
número será faturado no concentrador. Caso envie um número de PDV errado o mesmo não será faturado em nenhum pdv, ficará pendente na
consulta.
G – PRODUTOS (Para lançamento de DAV e Pré-Venda)

Reunirá os dados referentes

G01 produtos C01/F01 1–1 G - - aos itens das DAVs ou pré-
de produto
vendas
A tag deverá ser informada dentro dos blocos <dav> ou <pv>.
H – ITENS VENDIDOS (Para lançamento de DAV e Pré-Venda)

1– Reunirá os dados referentes

H01 xml.ProdutoXml Itens vendidos G01 G - -
999 aos itens
Código do produto disposto no
H02 idProduto Código do produto H01 1–1 X 20 -
DAV ou PV
H03 ordem Ordem do item H01 1–1 N 4 - Ordem do item na DAV ou PV
H04 quantidade Quantidade H01 1–1 N 13 3 Quantidade do item
H05 valor Valor unitário H01 1–1 N 13 2 Valor unitário do produto
H06 agrupamento Grupo H01 0–1 X 20 - Grupo
H07 status Status H01 1–1 X 1 - Status – “” = Normal
“C” = Cancelado
H08 atendente Atendente H01 0–1 X 15 - Atendente / Vendedor
dataHoraLancamento Data e Hora do
H09 H01 0–1 D - -
Lançamento
Valor do desconto
H10 desconto H01 1–1 N 13 2 Valor do desconto unitário
unitário
Valor do acréscimo
H11 acrescimo H01 1–1 N 13 2 Valor do acréscimo unitário
unitário
Operador que liberou o
operadorAutorizouDe Operador que autorizou desconto do produto, antes
H12 H01 0–1 X 15 -
sconto desconto definida como
operadorAutorizou
operadorAutorizouCa Operador que autorizou cancelamento do item, caso
H13 H01 0-1 X 15 -
ncelamento cancelamento do item sistema esteja parâmetrizado
como obrigatório
acréscimo do item, caso
operadorAutorizouAc Operador que autorizou sistema esteja parâmetrizado
H14 H01 0-1 X 15 -
rescimo acréscimo do item como
obrigatóriooperadorAutorizou
Cancelamento
As tags abaixo deverão ser informadas dentro do bloco <DAV / Pré-Venda>, somente com os atributos selecionados.
I – VENDEDOR (Para lançamento de DAV e Pré-Venda)

Bloco de informações Reunirá os dados referentes

I01 vendedor C01/F01 0-1 G - -
do vendedor ao vendedor vinculado
I02 id Código do vendedor I01 1-1 X 10 - Informe o vendedor
J – Cadastro de Clientes
Grupo com a lista de

J01 clientes clientes a serem A01 1-1 G - -
cadastrados
A tag deverá ser informada se desejar enviar cadastro de cliente via Wsopaf.
K – Cadastro de Clientes
Bloco de
K01 modelo.cliente informações do J01 1-1 G - -
cliente a serem
cadastradas
A tag deverá ser informada dentro do bloco <Clientes>
L – Cliente (Para lançamento de DAV e Pré-Venda)

Bloco de informações
L01 cliente C01/F01 1-1 G - -
do cliente
M – Dados do cliente (Para lançamento de DAV / Pré-Venda e Cadastros de Clientes)

M01 id Código do cliente K01/L01 0-1 X 15 - Caso o id(M01) seja informado,

M02 nome Nome do cliente K01/L01 1–1 X 60 - serão utilizados os dados do
cadastro, não sendo necessário
M03 cpf CPF/CNPJ 1-1 C 14 -
K01/L01 o envio das tags M03 A M12.
Informar o número separado
M04 Endereço Endereço 0-1 X 60 - por vírgula. ex:
K01/L01 Rua xv de novembro, 1543
M05 Bairro Bairro K01/L01 0-1 X 60 - Informe o bairro do cliente
M06 Cidade Cidade K01/L01 0-1 X 30 - Informe a cidade do cliente
M07 Uf UF K01/L01 0-1 X 2 - Informe UF (estado) do cliente
M08 telefone Telefone K01/L01 0-1 C 15 - Informe o telefone do cliente
M09 complemento1 Complemento 1 K01/L01 0-1 X 20 - Informe complemento 01
M12 complemento4 Complemento 4 K01/L01 0-1 X 40 - Informe o complemento 04
Código do IBGE da
M13 codigoIBGECidade 0-1 X 7 - Código do IBGE da cidade
cidade K01/L01
M14 Email Email do Cliente K01/L01 0-1 X 60 - Email do cliente
Inscrição Estadual caso de
pessoa juridica ou RG no caso
M15 inscricaoEstadualRG Inscrição Estadual ou RG 0-1 X 14 -
mde pessoa física, sem
K01/L01 formatação.
Cep do cliente sem formatação
M16 cep Cep 0-1 N 8 -
K01/L01
complementoEnderec Complemento do
M17 0-1 X 60 - Complemento do endereço
o Endereço K01/L01
Inscrição SUFRAMA do cliente
Inscrição SUFRAMA
M18 inscricaoSuframa 0-1 X 9 - quando existir
K01/L01
Email dos destinatários para
emailsDestinatariosNf Email dos destinatários
NFE separado por o símbolo
M19 para NFE 0-1 X 300 -
e de adição (+)
K01/L01
Total de crédito que o Total de crédito que o cliente

limiteCredito possui para operações do tipo
M20 cliente possui. 0-1 N 13 2
crediário. 0 (Zero) não valida
K01/L01
saldo
Descrição do motivo da
motivoInativacao Motivo da inativação
M21 0-1 X 25 - inativação
K01/L01
M22 0-1 X 1 Cliente é fidelidade:

fidelidade Cliente é fidelidade? K01/L01
"S" - Sim "N" - Não
M23 Data de nascimento do 0-1 D -
nascimento K01/L01 Formato: DD/MM/YYYY
cliente
M24 Aniversario do cliente 0-1 X 5
aniversario K01/L01 Formato: DD/MM
(Dia/Mês)
M25 Observação referente 0-1 X 200
observacao K01/L01
ao cliente
A tag abaixo deverá ser informada dentro dos blocos <dav> <pv> ou <cliente>, com os atributos selecionados.
N – FINANCEIRO (Para Lançamento de DAV e Pré-Venda

Grupo de informações Reunirá os dados referentes às

N01 financeiro das formas de C01/F01 0-1 G - - formas de pagamento
pagamento vinculadas
A tag abaixo deverá ser informada dentro do bloco <dav> ou <pv> com os atributos selecionados.
O – PARCELAS DO FINANCEIRO (Para lançamento de DAV e Pré-Venda)
Reunirá os dados referentes às

0-
O01 xml.ParcelaXml Parcelas do financeiro N01 G - - formas de pagamento
999
vinculadas
Código da forma de Código válido de forma de
O02 idForma O01 1-1 N 2 -
pagamento pagamento
Ordem da forma de
pagamento, para mais de 01
O03 ordem Ordem da forma O01 1-1 N 4 -
(uma) forma de pagamento
utilizada
Valor efetuado pela forma de
O04 valor Valor da forma O01 1-1 N 13 2
pagamento
Data do vencimento da
O05 dataVencimento O01 1-1 D - - Formato: DD/MM/YYYY
parcela
A tag abaixo deverá ser informada dentro do bloco <financeiro>, com os atributos selecionados.
P – Cadastro de Produtos
Grupo onde contém a

lista de produtos a
P01 produtos A01 0-1 G - -
serem cadastrados
A tag abaixo deverá ser informada dentro do bloco <PRODUTOS> com os atributos selecionados.
Q – Cadastro de Produtos
ID Campo Descrição TAG Pai Ocor. Tipo Tam Dec. Observação
Q01 P01 0 - 999 G - -

modelo.Produto produto
Q02 Q01 1-1 X 20 -
id Código do produto
Q03 descricao Descrição do produto Q01 1-1 X 40 -
Q04 unidade Unidade do produto Q01 1-1 X 3 -
Complemento do
Q01 -
Q05 complemento1 produto 1-1 X 30
Complemento do
Q01 -
Complemento do
Q01 -
Q08 status Status do produto Q01 0-1 X 1 -
Situação tributária do
Q01 -
Q09 situacaoTributaria produto 1-1 X 3
Q10 tributacao Q01 1-1 X 1 -
Tributário do produto
Q11 aliquota Alíquota do produto Q01 X 1 -
1-1
Q12 ippt Índice produção (IPPT) Q01 1-1 X 1 -
Q13 precoCusto Preço de custo Q01 1-1 N 13 2
Q14 tipoComercializacao Produto pesável Q01 1-1 X 1 -
Q15 tipoProduto Tipo do produto Q01 0-1 X 1 -
Serviço: identifica se o produto é
Q01 -
Q16 tipoServico Serviço 0-1 X 1 serviço “S” ou Não “ “.
Q17 Origem Q01 0-1 X 1 -

Origem
Q18 tributacaoISSQN Tributação ISSQN Q01 0-1 X 1 -
Q19 tipoKit Produto é Kit Q01 0-1 X 1 -
Q20 codigoNCM Código NCM/NBS Q01 1-1 X 10 -
Código exceção
Q01 -
Q21 codigoExcecaoFiscal NCM/TIF 0-1 N 2
permiteQuantidadeFr Produto permite venda "S" se permite que na venda do
Q01 - produto seja usado quantidade
Q22 acionada fracionada 0-1 X 1 fracionada ou "N" para não
Participa do programa
Q01 -
Q23 descontoFidelidade fidelidade N 13
0-0
Q24 CEST Q01 0-1 N 7 -
cest
Informar 0 desativa a validação
Q01 - deste campo.
Q25 multiplo Multiplo da quantidade 0-1 N 4
Informa o valor ou percentual do
limite de desconto a ser aplicado.
Parâmetro no configurador define
Q01 - se deve descontos superiores
devem ser bloqueados ou exigir
Limite de desconto para
liberação de supervisor.
Q26 descontoDiferenciado o produto 0-1 N 4
R – Cadastro de Referência Vinculada

Grupo de referências
R01 referencias A01 1-1 G - -
A tag abaixo deverá ser informada dentro do bloco <referencias> com os atributos selecionados.
S – Cadastro de Referência Vinculada
S01 modelo.ReferenciaVincul Grupo de informações R01 - -

1-1 G
ada da referência
S02 idProduto Código do produto S01 1-1 X 20 -
S03 referenciaVinculada Referência Vinculada S01 1-1 X 20 -
Se deve realizar a Realizar faturamento:
S04 realizarExclusao S01 0-1 X 1 -
exclusão "S" - Sim
Estoque da referência
S05 S01
estoque vinculada 0-1 N 13 3
S06 observacao Observação S01 0-1 X 200 -
A tag abaixo deverá ser informada dentro do bloco <referencias> com os atributos selecionados.
T –Cadastro de Preço do Produto

T01 precos Grupo de preços A01 1-1 G - -
U –Cadastro de Preço do Produto

U01 modelo.TabelaDePreco 1-1 G - -
da tabela preço T01
U02 valor Valor U01 1-1 N 13 3
V –PREÇO DO PRODUTO
V01 Identificadores da 1-1 G - -

id U01
tabela preço
V02 idProduto V01 1-1 X 20 -
Código do produto
V03 Identificador da tabela V01 1-1 X 10 -
tabelaPreco
de preço

Layout de Integracao 029 WSOPaf

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Layout de Integracao 029 WSOPaf

Enviado por

Direitos autorais:

Formatos disponíveis

Manual de Integração OPaf

Layout de integração WSOPaf

Layout de Integração 029

OPaf ® é marca registrada da ID Brasil Sistemas Ltda

Verificação do sistema operacional ................................................................................................................................. 7

O processo de integração para remessas ............................................................................................................................ 8

Exemplificando o arquivo XML ...........................................................................................................................................10

Testando o funcionamento do WSOPaf.jar....................................................................................................................11

Especificidades do processo ...............................................................................................................................................12

Truncando os valores do documento.............................................................................................................................14

Calculando valor total de DAVs e pré-vendas seguindo o padrão OPaf ........................................................................15

Formato dos campos ..........................................................................................................................................................16

B – INFORMAÇÕES DO ESTABELECIMENTO ...................................................................................................................18

C – INFORMAÇÕES DO DAV ...........................................................................................................................................18

D – ATUALIZAÇÃO DE DAV .............................................................................................................................................19

F – PRÉ-VENDA / CONTA DE CLIENTE .............................................................................................................................21

G – PRODUTOS (Para lançamento de DAV e Pré-Venda) ...............................................................................................22

H – ITENS VENDIDOS (Para lançamento de DAV e Pré-Venda) ......................................................................................22

K – Cadastro de Clientes .................................................................................................................................................24

L – Cliente (Para lançamento de DAV e Pré-Venda).......................................................................................................24

M – Dados do cliente (Para lançamento de DAV / Pré-Venda e Cadastros de Clientes) ...............................................24

N – FINANCEIRO (Para Lançamento de DAV e Pré-Venda .............................................................................................25

O – PARCELAS DO FINANCEIRO (Para lançamento de DAV e Pré-Venda)......................................................................26

P – Cadastro de Produtos ...............................................................................................................................................26

Q – Cadastro de Produtos ..............................................................................................................................................26

R – Cadastro de Referência Vinculada ...........................................................................................................................27

S – Cadastro de Referência Vinculada ............................................................................................................................28

T –Cadastro de Preço do Produto ..................................................................................................................................28

U –Cadastro de Preço do Produto..................................................................................................................................28

V –PREÇO DO PRODUTO ................................................................................................................................................28

Min. – Max Representa o número mínimo e o número máximo de ocorrências em relação

Efetuando os downloads e instalando as aplicações necessárias

Verificação do sistema operacional

Como funciona o processo de integração?

Nesta ilustração, demonstra-se o processo sendo efetuado e retornando um status válido.

O usuário utilizará o SOFTWARE INTEGRAÇÃO,

Após a validação do XML, se o retorno for positivo

Nesta ilustração, demonstra-se o

Após a validação do XML, se o retorno for

Efetuando os ajustes finais

Testando o funcionamento do WSOPaf.jar

Campos obrigatórios, validações e vínculos

Truncando os valores do documento

Valor total do desconto = R$ 0,3192 (2,66 * R$ 0,12 = quantidade * desconto unitário)

CALCULO COM TRUNCAMENTO – PADRÃO DE UTILIZAÇÃO OPAF

Finalidade dos registros de integração

TAG mestre dos

Grupo de informações Grupo de informações do

As tags abaixo deverão ser

faturamentoAutomati Realizar faturamento Realizar faturamento:

Informações da pré- Grupo de informações da Pré

F19 observacaoCupom1 Observação 1 do final F01 0-1 X 25 -

faturamentoAutomatic Realizar faturamento

G – PRODUTOS (Para lançamento de DAV e Pré-Venda)

Reunirá os dados referentes

H – ITENS VENDIDOS (Para lançamento de DAV e Pré-Venda)

1– Reunirá os dados referentes

I – VENDEDOR (Para lançamento de DAV e Pré-Venda)

Bloco de informações Reunirá os dados referentes

Grupo com a lista de

L – Cliente (Para lançamento de DAV e Pré-Venda)

M – Dados do cliente (Para lançamento de DAV / Pré-Venda e Cadastros de Clientes)

M01 id Código do cliente K01/L01 0-1 X 15 - Caso o id(M01) seja informado,