Leiaute XML - EDI

Para que o documento seja enviado para o EDI processá-lo, é necessário seguir um leiaute de XML, de maneira que o retorno também contemple um leiaute próprio.

XML de Envio

Estrutura de schema:

<tipo>

<xml>

<serie>

XML que deve ser validado:

#	Nome	Tipo	Pai	Ocorrência	Observação
1	tssedienvio	tctssedienvio		1-1

Formatos padrões utilizados:

Formato

Observação

Date (date)

Formato: AAAA-MM-DD, onde:

AAAA = ano com 4 caracteres.

MM = mês com 2 caracteres.

DD = dia com 2 caracteres.

Data / Hora (datetime)

Formato AAAA-MM-DDTHH:mm:SS, onde:

AAAA = ano com 4 caracteres.

MM = mês com 2 caracteres.

DD = dia com 2 caracteres.

T = separando a data da hora.

HH = Hora com 2 Caracteres.

mm = minuto com 2 caracteres.

SS = segundos com 2 caracteres.

Tipos Simples

A tabela com a lista dos tipos simples que são utilizados como tipos de dados está dividida em quatro colunas:

Campo: nome do tipo simples.
Tipo: tipo primitivo de dados utilizados pelo campo:
- C: Caractere
- N: Número
Descrição: apresenta informações sobre o campo.
Tam.: tamanho do campo:
- Quando for caracteres o tamanho define a quantidade máxima de caracteres que o texto pode ter.
- Quando for numérico o tamanho pode ser representado das seguintes formas:

- Número inteiro: define o total de dígitos existente no número. Exemplo: “15” significa que número pode ter, no máximo, 15 dígitos.

- Número fracionário: define o total de dígitos e quantos deles são designados para a parte fracionária.

Exemplo: “15,2” significa que o número pode ter, no máximo, 15 dígitos sendo 2 deles a identificação da parte fracionária. A parte fracionária não é obrigatória quando assim definido.

- Quando for data, não há definição de tamanho.

Leiaute com as validações dos Tipos Simples e Complexos:

Tipos Simples
Nome	Tipo	Descrição	Tamanho
Tsprioridade	N	Prioridade de processamento do documento: 0 – Normal 1 – Alta	1
Tsmodelo	C	Modelo do documento que está sendo processado: 55 – Nota Fiscal Eletrônica. 56 – Nota Fiscal de Serviço Eletrônica. 57 – Conhecimento de Transporte Eletrônico. 110110 – Carta de Correção Eletrônica. CLE – Capa de Lote Eletrônica.	6
Tstipo	N	Tipo do processamento: 1 – Remessa. 2 – Cancelamento. 3 – Substituição (NFS-e).	1
tsprtvias	N	Número de vias de impressão do documento autorizado.	2
Tsxml	C	XML do documento.	400KB
tsidentificacao	C	Identificação de controle do usuário.	50
Tsserie	C	Série do documento.	3
tsnumero	N	Número do documento.	9
tscpfcnpj	C	CPF/CNPJ.	14

Tipos Complexos

A seguir serão detalhadas as tabelas de cada tipo composto e seus campos. A tabela está dividida da seguinte forma:

(1)
(2)
Nome		Tipo
(3)	(4)	(5)	(6)	(7)
(3)	(4)	(5)	(6)	(7)

1) Nome do tipo complexo.

2) Descrição do tipo complexo.

3) Identifica se a sequência de campos faz parte de uma escolha (Choice). Não utilizado neste Layout.

4) Nome do campo que faz parte do tipo complexo.

5) Tipo do campo (pode ser um tipo simples ou complexo).

6) Quantas vezes o campo se repete na estrutura de dados:

Formato: “x-y” onde “x” é a quantidade mínima e “y” a quantidade máxima. Se a quantidade máxima for indefinida, será utilizado “N” no lugar do “y”;

7) Descrição do campo.

tctssedienvio (uma única ocorrência)
Nome	Tipo	Ocorrência	Descrição
prioridade	tsprioridade	1-1	Indica se o arquivo terá prioridade no processamento.
modelo	tsmodelo	1-1	Modelo do documento contido no arquivo.
tipo	tstipo	1-1	Indica o tipo de processamento a ser realizado.
prtvias	tsprtvias	1-1	Número de vias que será impresso do documento contido pelo processamento da impressão automática.
xml	tsxml	1-1	XML do documento contido.
identificacao	tsidentificacao	1-1	Identificação de controle do usuário.
emissor	Tcemissor	1-1	Agrupa informações sobre o emissor do documento.
inutilizar	Tcinutilizar	0-1	Informações sobre uma inutilização.

tcemissor

(uma única ocorrência)

Nome

Tipo

Ocorrência

Descrição

cpfcnpj

Tscpfcnpj

1-1

CPF/CNPJ do emissor do documento.

tcinutilizar (uma única ocorrência)
Nome	Tipo	Ocorrência	Descrição
serie	Tsserie	1-1	Série a ser inutilizada.
numero	Tsnumero	1-1	Número a ser inutilizado.

Estrutura de tags do XML:

Estrutura de tags
Nome	Pai	Descrição
tssedienvio	--	Tag raíz do XML.
cpfcnpj	emissor	CPF/CNPJ do emissor do documento.
prioridade	tssedienvio	Prioridade de processamento do documento: 0 – Normal. 1 – Alta.
modelo	tssedienvio	Modelo do documento que está sendo processado. 55 – Nota Fiscal Eletrônica. 56 – Nota Fiscal de Serviço Eletrônica. 57 – Conhecimento de Transporte Eletrônico. 110110 – Carta de Correção Eletrônica. CLE – Capa de Lote Eletrônica.
tipo	tssedienvio	Tipo do processamento: 1 – Remessa. 2 – Cancelamento. 3 – Substituição (NFS-e). 4 – Inutilização.
prtvias	tssedienvio	Número de vias de impressão do documento autorizado.
xml	tssedienvio	XML do documento. Deve ser enviado dentro de uma declaração CDATA.
identificacao	tssedienvio	Identificação do sistema gerador do XML.
emissor	tssedienvio	Tag que agrupará informações sobre o emissor do documento.
cpfcnpj	emissor	CPF ou CNPJ do emissor
inutilizar	tssedienvio	Tag raíz de inutilização.
serie	inutilizar	Série do documento a ser inutilizado.
numero	inutilizar	Número do documento a ser inutilizado.

XML de Retorno

Estrutura de tags do XML:

Estrutura de tags
Nome	Pai	Descrição
tssediretorno	--	Tag raíz do XML.
cnpj	tssediretorno	CNPJ do documento processado.
cpf	tssediretorno	CPF do documento processado.
docid	tssediretorno	ID do documento processado pelo EDI.
docxml	tssediretorno	XML do documento importado pelo EDI.
retxml	tssediretorno	XML de retorno do documento.
status	tssediretorno	Status do documento no EDI.
docautorizado	tssediretorno	Status da autorização do documento: 0=Não autorizado. 1=autorizado.
descricao	tssediretorno	Descrição do status.
detalhe	tssediretorno	Detalhe do status.
impdata	tssediretorno	Data de importação do arquivo no EDI.
imphora	tssediretorno	Hora de importação do arquivo no EDI
modelo	tssediretorno	Modelo do documento processado: 55 – Nota Fiscal Eletrônica. 56 – Nota Fiscal de Serviço Eletrônica. 57 – Conhecimento de Transporte Eletrônico. 110110 – Carta de Correção Eletrônica. CLE – Capa de Lote Eletrônica.
doctipo	tssediretorno	Tipo do processamento: 1 – Remessa. 2 – Cancelamento. 3 – Substituição (NFS-e). 4 – Inutilização.
identificacao	tssediretorno	Identificação do sistema que gerou o arquivo enviado para o EDI.
inutilizar	tssediretorno	Tag raíz de inutilização.
serie	inutilizar	Série do documento a ser inutilizado.
numero	inutilizar	Número do documento a ser inutilizado.

Páginas filhas

Leiaute XML - EDI

XML de Envio