You are on page 1of 40

SOLUO OOBJ-NFE

PADRO DE INTEGRAO TXT


Verso 3 - Novembro/2009

E-Sales Solues de integrao


Avenida Frana, 1162 Porto Alegre, RS
Fone: (51) 3325-8100
(62) 3211-1279
http://www.esales.com.br

PADRO DE INTEGRAO TXT


Informao de Uso Interno

SUMRIO
1

INTRODUO ..................................................................................................... 3
1.1

OBJETIVOS ..................................................................................................... 3

1.2

RESPONSABILIDADES ....................................................................................... 3

1.3

REFERNCIAS ................................................................................................. 4

ARQUITETURA ................................................................................................... 4

INTEGRAO COM SISTEMA DE FATURAMENTO ........................................ 6

3.1

COMUNICAO ................................................................................................ 6

3.2

NOMENCLATURA ARQUIVOS DE ENVIO DE LOTE ................................................. 6

3.3

INFORMAES DE ENVIO DA NF-E PARA A SEFAZ ............................................. 7

3.4

INFORMAES DE RETORNO DA NF-E ENVIADA ................................................. 8

3.5

INFORMAES DE STATUS DA NF-E .................................................................. 9

FORMATO DAS MENSAGENS .......................................................................... 9


4.1

LOTE PROCESSADO PELA SEFAZ ................................................................... 10

4.2

DANFES EMITIDOS EM FORMULRIO DE SEGURANA ....................................... 10

4.3

NOTAS EMITIDAS AO SCAN COM MUDANA DE SRIE ....................................... 11

4.4

LOTE COM ESTRUTURA INVLIDA ..................................................................... 11

4.5

LOTE COM CONTEDO INVLIDO ...................................................................... 12

4.6

LOTE NO PDE SER ENVIADO ........................................................................ 13

5 PADRO DE INTEGRAO PARA SERVIO DE CANCELAMENTO E


INUTILIZAO DE NF-E .......................................................................................... 14
5.1
5.1.1
5.1.2

5.2
5.2.1
5.2.2

- ARQUIVOS DE ENVIO E RESPOSTA DE CANCELAMENTO .................................... 14


Contedo arquivo de cancelamento ............................................................................................. 14
Contedo arquivo de resposta de cancelamento .......................................................................... 15

ARQUIVOS DE ENVIO E RESPOSTA DE INUTILIZAO .......................................... 16


Contedo arquivo inutilizao ..................................................................................................... 16
Contedo arquivo de resposta de inutilizao ............................................................................. 17

ANEXO I - CDIGOS DE ERRO DO OOBJ-NFE ............................................. 19

ANEXO II - LAYOUT DAS MENSAGENS ......................................................... 21

ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

ANEXO III - LAYOUT DAS MENSAGENS DE RETORNO ............................... 25


8.1

LOTE PROCESSADO PELA SEFAZ .................................................................... 25

8.2

DANFES EMITIDOS EM FORMULRIO DE SEGURANA ....................................... 25

8.3

NOTAS EMITIDAS AO SCAN COM MUDANA DE SRIE ....................................... 25

8.4

LOTE COM ESTRUTURA INVLIDA ..................................................................... 25

8.5

LOTE COM CONTEDO INVLIDO ...................................................................... 25

8.6

LOTE NO PDE SER ENVIADO ........................................................................ 25

ANEXO IV - LAYOUT DA MENSAGEM DE ENVIO NF-E TXT ......................... 26

2
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

1 INTRODUO
1.1

Objetivos

O Documento de Integrao tem por objetivo estabelecer um padro tcnico de


comunicao entre o software de faturamento previamente existente no cliente e o
Oobj-NFE, sistema emissor de Nota Fiscal Eletrnica.
So tambm objetivos da estratgia de integrao definida neste documento:

Remover o mximo possvel da complexidade tecnolgica utilizada no


processamento de NFE para o sistema de faturamento;

Abstrair aspectos negociais do ciclo de vida da NFE, de modo a simplificar a


operao do sistema de faturamento;

Minimizar a freqncia e o impacto de eventuais falhas de comunicao ao


sistema de faturamento;

Proteger o sistema de faturamento das freqentes alteraes na estrutura da


NFE.

1.2

Responsabilidades

Ao produtor do software de faturamento cabe, custa do cliente, realizar as


modificaes necessrias para interagir com o Oobj-NFE da maneira especificada
neste documento.
Oobj, por sua vez, cabe oferecer ao software de faturamento as interfaces de
comunicao conforme estabelecido neste documento.

3
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

1.3

Referncias

Tabela 1 Documentos Referenciados


Documento

Data
Criao

Origem

Template de MAPEAMENTO_XML_TXT_Envio.xls

11/08/2008

Documentao
E-Sales

2 ARQUITETURA
A soluo Oobj-NFE se divide em trs mdulos: o Mdulo Central, o Mdulo
Perifrico e o Painel Gerencial.
O Mdulo Central fica fisicamente alocado em uma mquina servidora nica que
processa as operaes de todos os estabelecimentos, e responsvel por toda a
comunicao com a Secretaria de Fazenda. Ele executa as operaes de envio,
cancelamento, inutilizao e consultas de NFE.
O Mdulo Perifrico fica instalado em cada estao em que roda o sistema de
faturamento, e se presta a servir de ponte entre o sistema de faturamento e o
Mdulo Central. Deste modo, toda a interao do sistema de faturamento feita
diretamente com o Mdulo Perifrico. Outra incumbncia do Mdulo Perifrico o
controle das impresses do DANFE e do DANFE-FS (DANFE em formulrio de
segurana).
O Painel Gerencial oferece funes administrativas como configurao do
funcionamento do sistema, backups, listagem das NFE emitidas e operaes
posteriores sobre elas, como cancelamento, reimpresso de DANFE, etc. Ele
acessado de qualquer estao de trabalho atravs de um browser e pode ser
instalado no servidor onde est o Mdulo Central. O Painel Gerencial no depende
de integrao com o sistema de faturamento e, portanto, no objeto de discusso
deste documento.
A Figura 1 ilustra a distribuio dos componentes e a comunicao entre eles:
4
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

Figure 1 - Arquitetura Oobj NF-e


5
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

3 INTEGRAO COM SISTEMA DE FATURAMENTO


3.1

Comunicao

A comunicao entre o sistema de faturamento e o mdulo perifrico se dar atravs


de troca de arquivos no disco rgido que compartilham. Dessa forma, sero definidas
duas pastas, uma chamada Pasta de Envio e outra chamada Pasta de Respostas.
O sistema de faturamento gravar suas mensagens na Pasta de Envio, que sero
ento consumidas pelo Mdulo Perifrico. Este, por sua vez, gravar as respostas
na Pasta de Respostas. A Figura 2 um quadro-resumo destes papis:

Pasta de Envio

Pasta de Respostas

grava

grava

Sistema de Faturamento
Mdulo Perifrico
Figure 2 - Pasta de Envio

Tanto o sistema de faturamento como o Mdulo Perifrico devem disponibilizar os


arquivos nas respectivas pastas somente quando estes estiverem prontos para
leitura pela outra parte. Para garantir isso, recomenda-se que o arquivo seja formado
em uma pasta temporria, e em seguida movido para a pasta de destino.

3.2

Nomenclatura Arquivos de Envio de Lote

Os arquivos de envio de lote e as respectivas respostas obedecero seguinte


nomenclatura:

Padro de Nomenclatura

Exemplo

Entrada

lote-<id-lote>.txt

lote-12345.txt

Sada

respLote-<id-lote>.txt

respLote-12345.txt

Figure 3 - Nomenclatura dos Arquivos de Envio de Lote


6
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

O Id do lote, informado nos arquivos de entrada e sada, um nmero inteiro gerado


pelo sistema de faturamento com o nico propsito de identificar um lote por ele
enviado. O nome do arquivo de respostas, alm de conter o Id do lote, contm o
cdigo do resultado do processamento daquele lote (o cdigo 104 significa Lote
processado, o que indica que foi enviado com sucesso SEFAZ e suas notas foram
processadas).
O cdigo de processamento pode ter sido gerado pela SEFAZ ou pelo SCAN, em
cujos casos correspondem a um cdigo da Tabela de cdigos de erros e descries
de mensagens de erros presente no Manual do Contribuinte. Pode ter sido,
tambm, gerado pelo Oobj-NFE, e neste caso corresponde a um dos cdigos
presentes no ANEXO I deste documento.

3.3

Informaes de Envio da NF-e para a SEFAZ

O Sistema de Faturamento do cliente deve dispoinibilizar as informaes para a


emisso da NF-e de acordo com o layout definido no ANEXO I do Manual de
Integrao Contribuinte, disponibilizado pela SEFAZ, e no ANEXOIII deste
documento.
O mapeamento das informaes necessrias para a emisso da NF-e esto
descritas

no

template

MAPEAMENTO_XML_Envio.xls

da

metodologia

de

implantao Oobj NF-e da E-Sales.

7
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

3.4

Informaes de Retorno da NF-e Enviada

Aps o envio e processamento da NF-e pela SEFAZ, a base de dados do Sistema


de Faturamento do cliente deve estar preparado para receber as informaes de
retorno descritas na tabela abaixo.
Tabela 2 - Informaes de Retorno da NF-e Enviada
TAG

Tamanho

chNFe

44 dgitos - Chave de Acesso da NF-e Chave de acesso contendo 44


composta por Cdigo da UF + AAMM da dgitos, que a identificao
emisso + CNPJ do Emitente + Modelo, da NF-e na SEFAZ.
Srie e Nmero da NFe + Cdigo
Numrico + DV.

origemResp 1 digito

Observaes

Originador da resposta
SEFAZ; O: Oobj-NFE).

(S:

serie

2 dgitos (pode ser que a srie atribuda Srie da NF-e


no ERP, pode ser alterada p/ emisso
pelo SCAN - 900 999), por isso so
importantes gravar essa informao.

nNF

8 digitos

Numero da NF-e

dhRecbto

Formato data (AAAA-MM-DD)

Data da autorizao da NF-e


no formato ano(4)-ms(2)dia(2) (ex : 2008-08-10)

cStat

3 digitos

Cdigo do status da NF-e, so


cdigos que esto definidos no
manual de integrao da
SEFAZ.

xMotivo

255 digitos

Descrio do motivo do status


da NF-e

8
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

3.5

Informaes de Status da NF-e

A base de dados do Sistema de Faturamento do cliente deve ter um campo de


status da NF-e com a seguinte especificao:
Tabela 3 - Campo Status da NF-e no Sistema de Faturamento
Campo

Tamanho

Status_NFe Inteiro 1 dgito

Dom
2 Disponvel para Exportao,
modo normal.
3 Enviado, em processamento.
4 - Processado.
5 - Disponvel para Exportao, em
modo contingncia.

4 FORMATO DAS MENSAGENS


Todas as mensagens trocadas estaro no formato texto (arquivo .txt). A cada
uma das mensagens est definida uma estrutura hierrquica de grupos, que so
determinados por letras (conforme o Manual de Integrao do Contribuinte) e a
delimitao dos campos de cada grupo pelo caractere | , denominado
coloquialmente como pipe. O layout da mensagem, bem como a estrutura
hierrquica de grupos e a delimitao dos campos esta presente no Anexo II.
A codificao utilizada tanto nos arquivos enviados pelo sistema de faturamento
quanto nos de retorno do Oobj-NFE UTF-8.
Numa situao normal, as notas enviadas pelo sistema de faturamento so enviadas
SEFAZ e tm seu uso autorizado. Existem, contudo, mltiplos pontos de falha, que
incluem:

Indisponibilidade de conexo com a Internet em algum ponto da


rede;

Falta de energia na unidade do mdulo central;

Indisponibilidade do sistema receptor da SEFAZ;

Erro na estrutura ou contedo da mensagem enviada pelo sistema


de faturamento;

As respostas do Oobj-NFE prevem estas possibilidades de falha, sendo


influenciadas pelo fato de que tanto o mdulo central como o mdulo perifrico
podem ser configurados para entrar em contingncia automtica ou manualmente.
9
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

Em seguida sero apresentadas as diferentes mensagens devolvidas pelo Oobj-NFE


nestes diferentes cenrios:

4.1

Lote processado pela SEFAZ

Trata-se do cenrio principal, em que o Oobj-NFE conseguiu executar todas as


operaes normalmente, e o lote corretamente transmitido SEFAZ receptora e
por ela processado. O resultado do processamento auferido pela SEFAZ e
individual para cada nota do lote, e pode ser autorizao, rejeio ou denegao. Os
cdigos e mensagens dos resultados dados pela SEFAZ so repassados ao sistema
de faturamento.
Abaixo est um exemplo de uma mensagem de resposta de autorizao:
A|12345|S|104|Lote processado|52|
B|52071212345678000100550120000000014848581045|12|1|2007-1225T12:00:00|100|Autorizado
o
uso
da
NF-e|||
152090040537968|QmSRIyWBZznTLsgGRnV0stnflYI=|

O segundo campo do grupo A (origem da resposta) informa o valor S, o que


significa que a origem da resposta a SEFAZ.
O layout da mensagem, bem como a estrutura hierrquica de grupos e a
delimitao dos campos esta presente no Anexo II.

4.2

DANFEs emitidos em formulrio de segurana

Quando ocorrer uma falha que impea a autorizao do lote de NFE, pode ser feita
a emisso do DANFE em formulrio de segurana. O Oobj-NFE pode ser
configurado para acionar este modo de contingncia automaticamente, ou sob
comando manual.
Seja acionado automtica ou manualmente, quando houver emisso de DANFE em
formulrio de segurana, o sistema retornar uma mensagem semelhante ao
exemplo a seguir:
A|12345|O|5001|Notas emitidas em contingncia DANFE-FS.|

Importante observar que o segundo campo do grupo A (origem da resposta)


apresenta o valor O, o que significa que a resposta foi gerada pelo Oobj-NFE. Por
este motivo, o terceiro campo apresenta o valor 5001, que est compreendido na
faixa de nmeros de resultado reservada s mensagens do Oobj-NFE, a saber, 5000
a 5999. Sempre que o Oobj-NFE der origem resposta, sero utilizados cdigos da
faixa 5000-5999. A tabela completa com as mensagens retornadas pelo Oobj-NFE
pode ser encontrada no 0, ao final deste documento.
10
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

O layout da mensagem, bem como a estrutura hierrquica de grupos e a


delimitao dos campos esta presente no Anexo II.

4.3

Notas emitidas ao SCAN com mudana de srie

O mdulo central tambm pode ser configurado para entrar automaticamente em


contingncia, que consiste em enviar ao SCAN (Sistema de Contingncia do
Ambiente Nacional).
Para emitir ao SCAN, exigido que seja utilizada srie compreendida entre 900 e
999, inclusive. Seja acionado automtica ou manualmente, sempre que uma NFE for
emitida ao SCAN, o Oobj-NFE, para atender a esta exigncia, atribuir uma nova
srie NFE, cujo nmero ser a srie original atribuda pelo sistema de faturamento,
somada de 900. Por exemplo, se a srie original era 2, e fez-se necessrio emitir ao
SCAN, o Oobj-NFE atribuir a srie 902 NFE antes de enviar. O Oobj-NFE optou
por no alterar a numerao originalmente estabelecida, preservando a natureza
seqencial das sries de contingncia atravs de inutilizao.
O Oobj-NFE, nesta situao, retornar uma mensagem conforme o exemplo a
seguir:
A|12345|C|104|Lote processado|52|
B|52071212345678000100550120000000014848581045|12|1|2007-1225T12:00:00|100|Autorizado o uso da NF-e|912|1|

Percebe-se que, nesta mensagem, o segundo campo do grupo B1 (srie) no


informa o nmero da srie efetivo, e sim, o valor original (12). A srie de fato
informada na nota enviada ao SCAN aquela informada no penltimo campo do
grupo B1 (serie SCAN). O mesmo vale para o terceiro campo do grupo B1 (nNF) e o
ltimo campo do grupo B1 (nNFSCAN). Nota-se, tambm, que o segundo campo do
grupo A (origem da resposta) agora assume o valor C, indicando que a mensagem
teve sua origem no SCAN.
Recomenda-se ao sistema de faturamento que atualize sua base de dados com a
nova srie e nmero atribudos pelo Oobj-NFE, de modo que procedimentos
posteriores de escriturao tenham informaes corretas.
O layout da mensagem, bem como a estrutura hierrquica de grupos e a
delimitao dos campos esta presente no Anexo II.

4.4

Lote com estrutura invlida

O Oobj-NFE aplica uma srie de validaes prvias ao lote enviado pelo sistema de
faturamento. Primeiramente so feitas as seguintes validaes estruturais:

O tamanho do arquivo deve ser menor que 400 Kbytes;


11

ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

O contedo do arquivo texto deve estar formado de acordo com o layout


da mensagem, presente neste documento;

O layout da mensagem foi modelado com o objetivo de maximizar a flexibilidade, e


ser bem menos restritivos que o layout oficial da NFE. Como exemplo, cabe citar que
num campo com 4 casas decimais, o layout oficial exige que sejam informadas as 4
casas, mesmo que sejam zeros (Ex: 1.2500 um valor vlido, enquanto 1.25
invlido), enquanto o layout utilizado pela Oobj permite que se omitam as casas
decimais desnecessrias. Estas e outras diferenas diminuem bastante a ocorrncia
de falhas na validao de schema.
Se uma destas validaes falharem, o Oobj-NFE rejeitar o lote e seu contedo no
ser avaliado. A mensagem, neste caso, semelhante apresentada a seguir:
A|12345|O|5214|Rejeio: tamanho do arquivo excede o limite de 400k.|52|

O layout da mensagem, bem como a estrutura hierrquica de grupos e a


delimitao dos campos esta presente no Anexo II.

4.5

Lote com contedo invlido

Caso o lote passe com sucesso pelas validaes estruturais, so feitas outras
validaes de natureza semntica, semelhantes s validaes feitas pela SEFAZ.
Por exemplo, verifica-se se o CNPJ do emitente e do destinatrio so CNPJs
vlidos, e outras validaes diversas. Essa pr-validao tem por objetivo antecipar
a rejeio, poupando tempo de transmisso e processamento, e economizando
recursos computacionais e de rede.
Se um erro de contedo for encontrado em alguma nota, o lote inteiro rejeitado.
Um erro especfico que se enquadra neste cenrio ocorre quando o sistema de
faturamento envia uma nota com numerao e srie anteriormente enviada
SEFAZ, acarretando em duplicidade.
A mensagem de retorno do Oobj-NFE, em caso de falha na validao do contedo
do lote, semelhante ao exemplo apresentado a seguir:
A|12345|O|5002|Falha na validao de uma ou mais NFE|52|
B|52071212345678000100550120000000014848581045|12|1| 200712-25T12:00:00|5208|CNPJ do destinatrio invlido|

Diferentemente da rejeio por erro estrutural, a rejeio por erro de contedo


informa o problema com cada nota individualmente. O cdigo e a descrio do erro
especfico dada dentro do grupo B (infProt) da respectiva nota, no penltimo e
ltimo campos(cdigo do estado e motivo) .

12
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

Quando ocorrer este erro, espera-se que o usurio corrija a informao causadora
do problema e remeta o lote novamente ao Oobj-NFE.

4.6

Lote no pde ser enviado

Num cenrio em que os mtodos de contingncia esto programados para no


serem acionados automaticamente, a ocorrncia de falha impede que as notas
sejam emitidas. Neste caso, o Oobj-NFE informa a razo que impediu a emisso das
notas.
A mensagem, nesse cenrio, semelhante ao exemplo a seguir:
A|12345|O|5003|Falha de comunicao com o mdulo central.|52|

Neste cenrio, espera-se que o usurio decida entre aguardar que o problema se
normalize, ou acionar manualmente o mecanismo de contingncia adequado,
remetendo novamente o lote.
Existe uma situao rara, mas possvel, em que a comunicao com a SEFAZ
interrompida aps o envio de um lote, mas antes da obteno do resultado do
processamento. Neste caso especfico, impossvel determinar se as notas foram
autorizadas, e no pode haver sada das mercadorias referentes s notas em
questo. Uma conseqncia a perda da numerao das notas, fazendo-se
necessrio re-emitir as notas com nova numerao, utilizando o mecanismo de
contingncia adequado. A ao esperada que o sistema de faturamento remeta
novamente o lote, alterando a numerao de suas notas para uma nova numerao.

13
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

5 PADRO DE INTEGRAO PARA SERVIO DE


CANCELAMENTO E INUTILIZAO DE NF-E

5.1

- Arquivos de envio e resposta de cancelamento

Os arquivos de cancelamento de NF-e e as respectivas respostas obedecero


seguinte nomenclatura:
Padro de Nomenclatura
Entrada

canc-<chave-acesso-nfe>.txt
Exemplo :
canc-35090268733603000178550010000000350833154065.txt

Sada

respCanc-< chave-acesso-nfe>.xml
Exemplo :
respCanc-35090268733603000178550010000000350833154065.txt

5.1.1 Contedo arquivo de cancelamento


CANC|tpAmb|chNFe|xJust|

Descrio dos campos a serem informados no TXT :


TAG

Tamanho

Observaes

CANC

Constante

tpAmb

1 digito

Tipo de Ambiente (1
Produo, 2 Homologao),
opcional

chNFe

44 dgitos - Chave de Acesso da NF-e Chave de acesso contendo 44


composta por Cdigo da UF + AAMM da dgitos, que a identificao da
emisso + CNPJ do Emitente + Modelo, NF-e na SEFAZ.
Srie e Nmero da NFe + Cdigo
Numrico + DV.

xJust

Informar o motivo do cancelamento da NF- No Schema da Sefaz, se for


14

ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

e.
Mais de 15 caracteres no mnimo.

emitido um cancelamento que a


descrio for menor que o
tamanho de 15 caracteres, ser
rejeitado o cancelamento com o
motivo Falha de Schema.

Exemplo:
CANC||31090879655916000806550020000362545863277776|SOLICITACAO DE
CANCELAMENTO DO CLIENTE|

5.1.2 Contedo arquivo de resposta de cancelamento


RETCANC|tpAmb|verAplic|cStat|xMotivo|cUF|chNFe|dhRecbto|nProt|

Descrio dos campos retornados no TXT :


TAG

Tamanho

Observaes

RETCANC

Constante

tpAmb

1 digito

Tipo de Ambiente (1
Produo, 2 Homologao),
opcional

verAplic

1 20 caracteres

Verso do aplicativo
processou
o
pedido
cancelamento

cStat

3 caracteres

Cdigo do status da mensagem


enviada

xMotivo

1 255 caracteres

Descrio literal do status do


servio solicitado

cUF

2 caracteres

Cdigo da UF de atendimento

chNFe

44 dgitos - Chave de Acesso da NF-e Chave de acesso da NF-e


composta por Cdigo da UF + AAMM da
15

ESALES Solues de integrao

que
de

PADRO DE INTEGRAO TXT


Informao de Uso Interno

emisso + CNPJ do Emitente + Modelo,


Srie e Nmero da NFe + Cdigo
Numrico + DV.
dhRecbto Formato: AAAA-MM-DDTHH:MM:SS

Data e hora do recebimento

nProt

Nmero do Protocolo de Status


da NF-e

5.2

15 caracteres

Arquivos de envio e resposta de inutilizao

Os arquivos de inutilizao de NF-e e as respectivas respostas obedecero


seguinte nomenclatura:
Padro de Nomenclatura
Entrada

inut-<cdigo-numerico-qualquer>.txt
Exemplo :
inut-0001.txt

Sada

respInut-< cdigo-numerico-qualquer >.txt


Exemplo :
respInut-0001.txt

5.2.1 Contedo arquivo inutilizao


A|tpAmb|cUF|ano|CNPJ|serie|nNFIni|nNFin|xJust|

Descrio dos campos a serem informados no TXT :


TAG

Tamanho

Observaes

Constante

tpAmb

1 digito

Tipo de Ambiente (1
Produo, 2 Homologao),
opcional

cUF

2 caracteres

Cdigo da UF de atendimento
16

ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

ano

02 dgitos Ano da faixa de NF-e a ser Ano da faixa de NF-e a ser


inutilizada
inutilizada.

CNPJ

CNPJ do emitente que ser feito a CNPJ completo contendo 14


inutilizao da NF-e.
digitos sem formatao.

serie

Srie da NF-e a ser inutlizada.

Srie da NF-e a ser inutlizada.

nNFIni

Nmero da Nf-e inicial

Nmero da Nf-e inicial

nNFFin

Nmero da Nf-e Final

Nmero da Nf-e Final

Esta tag opcional


xJust

Informar o motivo da inutilizao da faixa No Schema da Sefaz, se for


de NF-e.
emitido uma inutilizao que a
descrio for menor que o
Mais de 15 caracteres no mnimo.
tamanho de 15 caracteres, ser
rejeitado o com o motivo Falha
de Schema.

5.2.2 Contedo arquivo de resposta de inutilizao


A|tpAmb|cStat|xMotivo|cUF|ano|CNPJ|serie|nNFIni|nNFFin|dhRecbto|nPro
t|

Descrio dos campos retornados no TXT :


TAG

Tamanho

Observaes

Constante

tpAmb

1 digito

Tipo de Ambiente (1
Produo, 2 Homologao),
opcional

cStat

3 caracteres

Cdigo do status da mensagem


enviada

17
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

xMotivo

1 255 caracteres

Descrio literal do status do


servio solicitado

cUF

2 caracteres

Cdigo da UF de atendimento

ano

02 dgitos Ano da faixa de NF-e a ser Ano da faixa de NF-e a ser


inutilizada
inutilizada.

CNPJ

CNPJ do emitente que ser feito a CNPJ completo contendo 14


inutilizao da NF-e.
dgitos sem formatao.

serie

Srie da NF-e a ser inutilizada.

Srie da NF-e a ser inutilizada.

nNFIni

Nmero da Nf-e inicial

Nmero da Nf-e inicial

nNFFin

Nmero da Nf-e Final

Nmero da Nf-e Final

Esta tag opcional


dhRecbto Formato: AAAA-MM-DDTHH:MM:SS

Data e hora do recebimento

nProt

Nmero do Protocolo de Status


da NF-e

15 caracteres

18
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

6 ANEXO I - CDIGOS DE ERRO DO OOBJ-NFE


Os erros decorrentes de validaes estabelecidas no Manual do Contribuinte tm
seu cdigo idntico a partir da centena ao seu cdigo correspondente no referido
manual. Abaixo est a lista de cdigos de erros gerados pelo Oobj-NFE e suas
respectivas descries:
Cdigo

Descrio

5001

DANFE emitido em formulrio de segurana.

5002

Falha na validao de uma ou mais NFE.

5003

Falha de comunicao com mdulo central.

5004

Falha de comunicao com SEFAZ devido a problemas na rede do


mdulo central.

5005

Falha de comunicao com SEFAZ devido a problemas na SEFAZ.

5006

Numerao de NFE j enviada anteriormente para SEFAZ.

5007

Interrupo na comunicao com conseqente perda de numerao.

5008

A SEFAZ retornou resposta fora dos padres estabelecidos.

5009

O id do lote informado j foi enviado anteriormente.

5010

O tempo limite para resposta da SEFAZ foi excedido.

5011

O lote foi rejeitado pela SEFAZ.

5012

O id do lote do XML no corresponde ao informado.

5013

Requisio invlida ou corrompida na transmisso ao Mdulo Central.

5014

Rejeio: Falha na validao do contedo do lote TXT

5204

Rejeio: Numerao de NFE j enviada anteriormente para SEFAZ.

5207

Rejeio: CNPJ do emitente invlido

5208

Rejeio: CNPJ do destinatrio invlido

5209

Rejeio: IE do emitente invlida

5210

Rejeio: IE do destinatrio invlida

5211

Rejeio: IE do substituto invlida

5212

Rejeio: Data de emisso NF-e posterior data de recebimento

5214

Rejeio: Tamanho da mensagem excedeu o limite estabelecido

5215

Rejeio: Falha no schema XML


19

ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

5228

Rejeio: Data de Emisso muito atrasada

5229

Rejeio: IE do emitente no informada

5232

Rejeio: IE do destinatrio no informada

5235

Rejeio: Inscrio SUFRAMA invlida

5237

Rejeio: CPF do destinatrio invlido

5243

Rejeio: XML Mal Formado

5251

Rejeio: UF/Municpio destinatrio no pertence SUFRAMA

5253

Rejeio: Digito Verificador da chave de acesso composta invlida

5254

Rejeio: NF-e referenciada no informada para NF-e complementar

5255

Rejeio: Informada mais de uma NF-e referenciada para NF-e


complementar

5266

Rejeio: Srie 900-999 reservada para uso do Oobj-NFE.

5269

Rejeio: CNPJ Emitente da NF Complementar difere do CNPJ da NF


Referenciada

5270

Rejeio: Cdigo Municpio do Fato Gerador: dgito invlido

5271

Rejeio: Cdigo Municpio do Fato Gerador: difere da UF do emitente

5272

Rejeio: Cdigo Municpio do Emitente: dgito invlido

5273

Rejeio: Cdigo Municpio do Emitente: difere da UF do emitente

5274

Rejeio: Cdigo Municpio do Destinatrio: dgito invlido

5275

Rejeio: Cdigo Municpio do Destinatrio: difere da UF do Destinatrio

5276

Rejeio: Cdigo Municpio do Local de Retirada: dgito invlido

5277

Rejeio: Cdigo Municpio do Local de Retirada: difere da UF do Local


de Retirada

5278

Rejeio: Cdigo Municpio do Local de Entrega: dgito invlido

5279

Rejeio: Cdigo Municpio do Local de Entrega: difere da UF do Local


de Entrega

5287

Rejeio: Cdigo Municpio do FG - ISSQN: dgito invlido

5288

Rejeio: Cdigo Municpio do FG - Transporte: dgito invlido

5402

Rejeio: XML da rea de dados com codificao diferente de UTF-8

5405

Rejeio: Cdigo do pas do emitente: dgito invlido

5406

Rejeio: Cdigo do pas do destinatrio: dgito invlido

5999

NF-e j emitida anteriormente, encontra-se j autorizada.


20

ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

7 ANEXO II - LAYOUT DAS MENSAGENS


Instrues gerais
Como informado, o arquivo texto segue uma estrutura hierrquica de grupos, que
so determinados por letras (conforme o Manual de Integrao do Contribuinte) e a
delimitao dos campos de cada grupo pelo caractere | , denominado pipe.
Informaes sobre cada tipo de grupo
Conforme layout abaixo, existem grupos de dados opcionais, que podem ser
omitidos do registro da NFE, assim como grupos que podem ser repetidos diversas
vezes (exemplo o grupo de produto da NFE que, para cada produto, um grupo
adicional).
Sobre os campos dos grupos, estes podem ter limitaes de tamanho mnimo e
mximo, alm de validaes de tipo (apenas caracteres, apenas dgitos, datas, etc.).
Assim, necessrio realizar a confrontao do tipo, tamanho e demais validaes
para cada campo, conforme descrito no layout.
Layout detalhado do arquivo
Grupos: identificados por uma letra seguida de |. Exemplo: A| , B|. Caso seja
opcional, pode-se optar pelo no preenchimento.
Exemplo:
E|XNome|IE|ISUF|
[seleo entre E02 ou E03]{
E02|CNPJ
[ou]
E03|CPF
}
E05|XLgr|Nro|XCpl|XBairro|CMun|XMun|UF|CEP|CPais|XPais|F
one|
[0 ou 1]{
F|CNPJ|XLgr|Nro|XCpl|XBairro|CMun|XMun|UF|
}
[0 ou 1]{
G|CNPJ|XLgr|Nro|XCpl|XBairro|CMun|XMun|UF|
21
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

}
Caso no seja necessrio o preenchimento do grupo F mas seja necessrio o
preenchimento do grupo G, temos:
E|XPTO Ltda| ...
G|11222333000181| ...
Nota-se que o grupo E e G so inseridos, mas o grupo F, omitido.
Campos: identificados pelo cdigo do campo e separados por |.
Exemplo: cUF, cNF
Caso seja opcional ou no informado, deve-se substituir o contedo pelo
preenchimento de apenas UM espao em branco.
Exemplo:
No grupo E05, temos:
E05|XLgr|Nro|XCpl|XBairro|CMun|XMun|UF|CEP|CPais|XPais|Fone|
Caso no seja necessrio o preenchimento do complemento (xCpl),CEP (CEP) e do
Telefone (Fone), preenche-se estes campos com apenas UM espao em branco:
E05|Avenida Rangel Pestana|300| |Se|3550308|So Paulo| SP||1058|BRASIL| |
Expresses:
[ 0 a N ] { ... } : Expresso indicando que todo o contedo entre chaves ( { e } )
pode ser inserido de 0 (ou seja, nenhuma vez) ou mais vezes.
[ 0 a 1 ] { ... } : Expresso indicando que todo o contedo entre chaves ( { e } )
pode ser inserido de 0 (ou seja, nenhuma vez) ou 1 vez.
[ 1 a 990 ] { ... } : Expresso indicando que todo o contedo entre chaves ( { e } )
pode ser adicionado at um limite de 990, mas deve ser inserido pelo menos 1 vez.
[seleo entre X ou Y ] { X|... [ou] Y|... } : Expresso indicando que deve-se realizar
uma escolha entre o cdigo X ou o cdigo Y, lembrando que X e Y podem variar de
acordo com os cdigos do layout. Exemplo:
[seleo entre C02 ou C02a]{
C02|NrDocumento
22
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

[ou]
C02a|NrDocumento
}
Neste caso, deve-se realizar a escolha entre C02 ou C02a: caso insira C02
(C02|NrDocumento), no poder ser inserido C02a (C02a|NrDocumento) e viceversa.
[0 a N] { [seleo entre X ou Y] { X [ou] Y } }: Expresso indicando que todo
contedo entre chaves ( { e } ) pode ser inserido de 0 (ou seja, nenhuma vez) ou
mais vezes. Onde para esse contedo deve-se fazer uma escolha entre o cdigo X
ou o cdigo Y. Os ns X devem ser seguidos e os ns Y tambm devem ser seguidos.
Exemplo:
B|cUF|NatOp| ...
B13|refNFe|
B13|refNFe|
B13|refNFe|
B14|cUF|AAMM(ano ms)|CNPJ|Mod|serie|nNF|
B14|cUF|AAMM(ano ms)|CNPJ|Mod|serie|nNF|
C|XNome|XFant|IE|IEST|IM|CNAE|
Nesse exemplo B13 o X e B14 o Y. Observe que se pode ter ns B13 e B14, mas
todos os B13s esto juntos e todos os B14s esto juntos.

Cadeias hierrquicas de chaves { }: Sempre deve-se seguir a precedncia


das chaves, de dentro para fora. Exemplo:
[0 ou 1]{
O|ClEnq|CNPJProd|CSelo|QSelo|CEnq|
[seleo entre O07 ou O08]{
O07|CST|VIPI|
[seleo entre O010 ou O11]{
23
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

O10|VBC|PIPI|
[ou]
O11|QUnid|VUnid|
}
[ou]
O08|CST|
}
}
Neste caso, caso seja inserido o grupo O (O|ClEnq|CNPJProd|CSelo|QSelo|
CEnq|), a prxima linha a ser inserida deve ser a escolha entre O07
(O07|CST|VIPI|) ou O08 (O08|CST|). Caso seja escolhido O07, deve-se
escolher ainda entre O010 (O10|VBC|PIPI|) ou O011 (O11|QUnid|VUnid|).
Abaixo segue o layout do arquivo de forma hierrquica e com indentaco para
facilita a leitura. Ao realizar a criao dos arquivos, os grupos e campos no devem
apresentar { } ou os comandos entre [ ].

24
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

8 ANEXO III - LAYOUT DAS MENSAGENS DE RETORNO


8.1

Lote Processado pela Sefaz


A|idLote|origemResp|cStat|xMotivo|cUF|
B|chNFe|serie|Nnf|dhRecbto|cStat|xMotivo| | |nProt|digVal|

8.2

DANFEs emitidos em formulrio de segurana


A|idLote|origemResp|cStat|xMotivo|

8.3

Notas emitidas ao SCAN com mudana de srie


A|idLote|origemResp|cStat|xMotivo|cUF|
B|chNFe|serie|Nnf|dhRecbto|cStat|xMotivo|serieSCAN|nNFSCAN|

8.4

Lote com estrutura invlida

A|idLote|origemResp|cStat|xMotivo|cUF|
8.5

Lote com contedo invlido

A|idLote|origemResp|cStat|xMotivo|cUF|
B|chNFe|serie|Nnf|dhRecbto|cStat|xMotivo|

8.6

Lote no pde ser enviado

A|idLote|origemResp|cStat|xMotivo|cUF|

25
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

9 ANEXO IV - LAYOUT DA MENSAGEM DE ENVIO NF-E TXT


NOTA FISCAL|qtd notas fiscais no arquivo|
A|verso do schema|id|
B|cUF|cNF|NatOp|indPag|mod|serie|nNF|dEmi|dSaiEnt|tpNF|cMunFG|TpImp|TpEmis|CDV|TpAmb|FinNFe|ProcEmi|VerProc|
[0 a N] {
[seleo entre B13 ou B14]{
B13|refNFe|
[ou]
B14|cUF|AAMM(ano ms)|CNPJ|Mod|serie|nNF|
}
}
[0 ou 1] {
B15|listaEmails|enviarDanfe|tipo|
}
C| XNome|XFant| IE|IEST|IM|CNAE|
[seleo entre C02 ou C02a]{
C02|CNPJ|
[ou]
C02a|CPF|
}

ESALES Solues de integrao

26

PADRO DE INTEGRAO TXT


Informao de Uso Interno

C05|XLgr|Nro|XCpl|Bairro|CMun|XMun|UF|CEP|CPais|XPais|Fone|
[0 ou 1]{
D|CNPJ|XOrgao|Matr|XAgente|Fone|UF|NDAR|DEmi|VDAR|RepEmi|DPag|
}
E| XNome| IE|ISUF|
[seleo entre E02 ou E03]{
E02|CNPJ|
[ou]
E03|CPF|
}
E05|XLgr|Nro|XCpl|XBairro|CMun|XMun|UF|CEP|CPais|XPais|Fone|
[0 ou 1]{
F|CNPJ|XLgr|Nro|XCpl|XBairro|CMun|XMun|UF|
}
[0 ou 1]{
G|CNPJ|XLgr|Nro|XCpl|XBairro|CMun|XMun|UF|
}
[1 a 990]{
H|NItem|InfAdProd|
I|CProd|CEAN|XProd|NCM|EXTIPI|Genero|CFOP|UCom|QCom|VUnCom|VProd|CEANTrib|UTrib|QTrib|VUnTrib|VFrete|VSeg|VDesc|
[0 a N]{
I18|NDI|DDI|XLocDesemb|UFDesemb|DDesemb|CExportador|
[1 a N]{

27
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

I25|NAdicao|NSeqAdic|CFabricante|VDescDI|
}
}
[0 ou 1 apenas se veculo]{
J|TpOp|Chassi|CCor|XCor|Pot|CM3|PesoL|PesoB|NSerie|TpComb|NMotor|CMKG|Dist|RENAVAM|AnoMod|AnoFab|TpPint|TpVei
c|EspVeic|VIN|CondVeic|CMod|
}
[0 a N apenas se medicamento]{
K|NLote|QLote|DFab|DVal|VPMC|
}
[0 a N apenas se armamento]{
L|TpArma|NSerie|NCano|Descr|
}
[0 a N apenas se combustvel]{
L1| CProdANP|CODIF|QTemp|
[0 ou 1]{
L105|QBCProd|VAliqProd|VCIDE|
}
L109|VBCICMS|VICMS|VBCICMSST|VICMSST|
[0 ou 1]{
L114|VBCICMSSTDest|VICMSSTDest|
}
L117|VBCICMSSTCons|VICMSSTCons|UFCons|

28
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

}
M|
N|
[Seleo entre N02 ou N03 ou N04 ou N05 ou N06 ou N07 ou N08 ou N09 ou N10]{
N02|Orig|CST|ModBC|VBC|PICMS|VICMS|
[ou]
N03|Orig|CST|ModBC|VBC|PICMS|VICMS|ModBCST|PMVAST|PRedBCST|VBCST|PICMSST|VICMSST|
[ou]
N04|Orig|CST|ModBC|PRedBC|VBC|PICMS|VICMS|
[ou]
N05|Orig|CST|ModBCST|PMVAST|PRedBCST|VBCST|PICMSST|VICMSST|
[ou]
N06|Orig|CST|
[ou]
N07|Orig|CST|ModBC|PRedBC|VBC|PICMS|VICMS|
[ou]
N08|Orig|CST|VBCST|VICMSST|
[ou]
N09|Orig|CST|ModBC|PRedBC|VBC|PICMS|VICMS|ModBCST|PMVAST|PRedBCST|VBCST|PICMSST|VICMSST|
[ou]
N10|Orig|CST|ModBC|VBC|PRedBC|PICMS|VICMS|ModBCST|PMVAST|PRedBCST|VBCST|PICMSST|VICMSST|
}
[0 ou 1]{

29
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

O|ClEnq|CNPJProd|CSelo|QSelo|CEnq|
[seleo entre O07 ou O08]{
O07|CST|VIPI|
[seleo entre O10 ou O11]{
O10|VBC|PIPI|
[ou]
O11|QUnid|VUnid|
}
[ou]
O08|CST|
}
}
[0 ou 1]{
P|VBC|VDespAdu|VII|VIOF|
}
Q|
[Seleo entre Q02 ou Q03 ou Q04 ou Q05]{
Q02|CST|VBC|PPIS|VPIS|
[ou]
Q03|CST|QBCProd|VAliqProd|VPIS|
[ou]
Q04|CST|
[ou]

30
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

Q05|CST|VPIS|
[Seleo entre Q07 ou Q10]{
Q07|VBC|PPIS|
[ou]
Q10|QBCProd|VAliqProd|
}
}
R|

[Seleo entre R02, ou R04,]{


R02|VBC|PPIS|
[ou]
R04|QBCProd|VAliqProd|
}
S|
[Seleo entre S02 ou S03 ou S04 ou S05]{
S02|CST|VBC|PCOFINS|VCOFINS|
[ou]
S03|CST|QBCProd|VAliqProd|VCOFINS|
[ou]
S04|CST|
[ou]
S05|CST| VCOFINS|

31
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

[Seleo entre S07 ou S09]{


S07|VBC|PCOFINS|
[ou]
S09|QBCProd|VAliqProd|
}
}
[0 ou 1]{
T| VCOFINS|
[Seleo entre T02 ou T04]{
T02|VBC|PCOFINS|
[ou]
T04|QBCProd|VAliqProd|
}

}
[0 ou 1]{
U|VBC|VAliq|VISSQN|CMunFG|CListServ|
}
}
W|
W02|VBC|VICMS|VBCST|VST|VProd|VFrete|VSeg|VDesc|VII|VIPI|VPIS|VCOFINS|VOutro|VNF|
[0 ou 1]{
W17|VServ|VBC|VISS|VPIS|VCOFINS|

32
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

}
[0 ou 1]{
W23|VRetPIS|VRetCOFINS|VRetCSLL|VBCIRRF|VIRRF|VBCRetPrev|VRetPrev|
}
X|ModFrete|
[0 ou 1]{
X03|XNome|IE|XEnder|UF|XMun|
[Seleo entre X04 ou X05]{
X04|CNPJ|
[ou]
X05|CPF|
}
}
[0 ou 1]{
X11|VServ|VBCRet|PICMSRet|VICMSRet|CFOP|CMunFG|
}
[0 ou 1]{
X18|Placa|UF|RNTC|
}
[0 a 2]{
X22|Placa|UF|RNTC|
}
[0 a N]{

33
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

X26|QVol|Esp|Marca|NVol|PesoL|PesoB|
[0 a N]{
X33|NLacre|
}
}
[0 ou 1]{
Y|
[0 ou 1]{
Y02|NFat|VOrig|VDesc|VLiq|
}
[0 a N]{
Y07|NDup|DVenc|VDup|
}
}
[0 ou 1]{
Z|InfAdFisco|InfCpl|
[0 a 10]{
Z04|XCampo|XTexto|
}
[0 a N]{
Z10|NProc|IndProc|
}
}

34
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

[0 ou 1]{
ZA|UFEmbarq|XLocEmbarq|
}
[0 ou 1]{
ZB|XNEmp|XPed|XCont|
}
[0 ou 1]{
OOBJBOL|
[1 a 99]{
OOBJBOL01|codigoBanco|codigoBarras|codigoBarrasFormatado|localPgto|dataVencimento|cedente|agenciaCodigoCedente|numeroDocumento|
especie|aceite|dataProcessamento|nossoNumero|cip|carteira|moeda|valorDuplicata|cndRepresentante|cdCliente|nnfe|
instrucao1|instrucao2|instrucao3|instrucao4|instrucao5|instrucao6|instrucao7|instrucao8|
sacadoIdentificacao|sacadoEndereco|sacadoTelefone|descontoAbatimento|nomeBanco|
}

35
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

Visando proteger o sistema de faturamento das freqentes alteraes na estrutura da NFE, foi retirado alguns campos do bloco
de identificao, que fazem somente parte do contexto NF-e no so necessrias ao ERP, e faz com que modificaes na legislao
no impacte em ter que modificar o sistema ERP.
Todos
os
campos,
incluindo
MAPEAMENTO_XML_TXT_Envio.xls.

os

citados

abaixo,

esto

descritos

no

documento

Template

de

Os campos retirados esto descritos abaixo em vermelho e tachado, no sendo necessrio informar os mesmos, sendo que
caso no sejam informados eles devem vir em branco.

Grupo

Campo

Descrio

Tipo

Ocorrncia

Tamanho

Dec

Observao

Atributos da NF-e
A

Versao

Verso do leiaute

Obrig

Id

Identificador da NF-e

Obrig

1a4

Verso do leiaute
Para a importao: informar apenas o literal NFe.
Para a exportao: ser preenchido com a chave de acesso da NF-e precedida
do literal NFe

Identificadores da NF-e
B

cUF

Cdigo da UF do emitente do Documento


Fiscal

brig

Cdigo da UF do emitente do Documento Fiscal. Utilizar a Tabela do IBGE de


cdigo de unidades da federao.

cNF

Cdigo Numrico que compe a Chave de


Acesso

cional

Cdigo numrico que compe a Chave de Acesso. Nmero aleatrio gerado


pelo emitente para cada NF-e para evitar acessos indevidos da NF-e.
No informar para a importao. Caso seja informado, ser desconsiderado.

36
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

natOp

Descrio da Natureza da Operao

brig

1 a 60

indPag

Indicador da forma de pagamento

brig

Mod

Cdigo do Modelo do Documento Fiscal

brig

Serie

Srie do Documento Fiscal

nNF

Nmero do Documento Fiscal

dEmi

Data de emisso do Documento Fiscal

dSaiEnt

B
B

Informar a natureza da operao de que decorrer a sada ou a entrada, tais


como: venda, compra, transferncia, devoluo, importao, consignao
remessa (para fins de demonstrao, de industrializao ou outra), conforme
previsto na alnea 'i', inciso I, art. 19 do CONVNIO S/N, de 15 de dezembro de
1970.
0 pagamento vista;
1 pagamento prazo;
2 - outros.
Utilizar o cdigo 55 para identificao da NF-e, emitida em substituio ao
modelo 1 ou 1A.

brig

1a3

Srie do Documento Fiscal, informar 0 (zero) para srie nica.

brig

1a9

Nmero do Documento Fiscal.

brig

Formato AAAA-MM-DD

Data de Sada ou da Entrada da


Mercadoria/Produto

cional

Formato AAAA-MM-DD

tpNF

Tipo do Documento Fiscal

cMunFG

Cdigo do Municpio de Ocorrncia do


Fato Gerador

tpImp

Formato de Impresso do DANFE

tpEmis

Forma de Emisso da NF-e

cDV

Dgito Verificador da Chave de Acesso da


NF-e

Opcional

tpAmb

Identificao do Ambiente

Obrig

Informar o DV da Chave de Acesso da NF-e, o DV ser calculado com a


aplicao do algoritmo mdulo 11 (base 2,9) da Chave de Acesso. (vide item 5
do Manual de Integrao).
No informar para a importao. Caso seja informado, ser desconsiderado.
1 - Produo/ 2 - Homologao

finNFe

Finalidade de emisso da NF-e

Obrig

1 a NF-e normal/ 2-NF-e complementar / 3 NF-e de ajuste

procEmi

Processo de emisso da NF-e

Obrig

Identificador do processo de emisso da NF-e:

0 a entrada / 1 a sada

Informar o municpio de ocorrncia do fato gerador do ICMS. Utilizar a Tabela


do IBGE

Obrig

1 a Retrato/ 2-Paisagem

Obrig

1 a Normal/ 2-Contingncia

0 - emisso de NF-e com aplicativo do contribuinte;


1 - emisso de NF-e avulsa pelo Fisco;
2 - emisso de NF-e avulsa, pelo contribuinte com seu certificado digital,
atravs do site do Fisco;
3- emisso NF-e pelo contribuinte com aplicativo fornecido pelo Fisco.

ESALES Solues de integrao

37

PADRO DE INTEGRAO TXT


Informao de Uso Interno

verProc

Verso do Processo de emisso da NF-e

Obrig

1 a 20

Identificador da verso do processo de emisso (informar a verso do aplicativo


emissor de NF-e).

Dados de Boletos
OOBJBOL

Grupo deinformaes de boletos

Opc.

0a1

OOBJBOL01 nomeBanco

Nome do banco

Obrig.

1 a 255

OOBJBOL01 codigoBanco

Cdigo do banco

Obrig.

1 a 255

OOBJBOL01 codigoBarras

Cdigo de barras numrico para leitura

Obrig.

1 a 255

OOBJBOL01 codigoBarrasFormatado

Cdigo de barras formatado para digitao

Obrig.

1 a 255

OOBJBOL01 localPgto

Local de pagamento

Opc.

1 a 255

OOBJBOL01 dataVencimento

Data de vencimento do ttulo

Obrig.

1 a 255

OOBJBOL01 cedente

Cedente

Obrig.

1 a 255

OOBJBOL01 agenciaCodigoCedente

Agncia do Cedente

Obrig.

1 a 255

OOBJBOL01 numeroDocumento

Nmero do ttulo

Obrig.

1 a 255

OOBJBOL01 especie

Espcie

Opc.

1 a 255

OOBJBOL01 aceite

Aceite

Opc.

1 a 255

OOBJBOL01 dataProcessamento

Data de processamento

Opc.

1 a 255

OOBJBOL01 nossoNumero

Nosso nmero

Opc.

1 a 255

OOBJBOL01 cip

CIP

Opc.

1 a 255

OOBJBOL01 carteira

Carteira

Obrig.

1 a 255

OOBJBOL01 moeda

Moeda

Opc.

1 a 255

OOBJBOL01 valorDuplicata

Valor da Duplicata

Obrig.

1 a 255

Opc.

1 a 255

Opc.

1 a 255

OOBJBOL01 cndRepresentante
OOBJBOL01 cdCliente

Cdigo do cliente

OOBJBOL01 nnfe

Nmero da NFE

Opc.

1 a 255

OOBJBOL01 instrucao1

Linha de instrues 1

Opc.

1 a 255

OOBJBOL01 instrucao2

Linha de instrues 2

Opc.

1 a 255

OOBJBOL01 instrucao3

Linha de instrues 3

Opc.

1 a 255

38
ESALES Solues de integrao

PADRO DE INTEGRAO TXT


Informao de Uso Interno

OOBJBOL01 instrucao4

Linha de instrues 4

Opc.

1 a 255

OOBJBOL01 instrucao5

Linha de instrues 5

Opc.

1 a 255

OOBJBOL01 instrucao6

Linha de instrues 6

Opc.

1 a 255

OOBJBOL01 instrucao7

Linha de instrues 7

Opc.

1 a 255

OOBJBOL01 instrucao8

Linha de instrues 8

Opc.

1 a 255

OOBJBOL01 sacadoIdentificacao

Identificao do sacado

Obrig.

1 a 255

OOBJBOL01 sacadoEndereco

Endereo do sacado

Opc.

1 a 255

OOBJBOL01 sacadoTelefone

Telefone do sacado

Opc.

1 a 255

OOBJBOL01 descontoAbatimento

Desconto ou abatimento

Opc.

1 a 255

39
ESALES Solues de integrao