WSInserirDocumento - Inserção de Documentos para processamento

O web service WSInserirDocumento é responsável por efetuar a inserção dos documentos gerados pelo ERP na base de processamento do e-Forms (NF-e, CT-e e MDF-e - envio, evento, cancelamento, inutilização, cancelamento/inutilização e solicitação de impressão), a partir de onde serão capturados para serem processados pela solução e-Forms.

Ao enviar um documento, é necessário informar na chamada do Web Service o identificador do Job que irá realizar o processamento do documento. Este identificador é o JobKey que deve estar configurado no Job de processamento do e-Forms e-Connector.

Para realizar o envio de documentos de manifestação de destinatário, será necessário informar o identificador do Entry Job que processará as manifestações.

Para o envio de documentos de entrada (recepção), também deve ser utilizado um identificador de Entry Job. Porém, atenção no schema da chamada para o tipo de serviço, onde deve ser enviado o processamento de entrada (tiposervico 9) e o tipo de documento deve ser somente XML (tipodocumento 1). O processo de inserção de documentos de entrada não valida schema, independente do que seja enviado na tag validarschema.

Internamente este web service irá gravar a mensagem (cabeçalho e o documento) em uma tabela do banco de dados, retornando o protocolo de inserção para posterior consulta. Esta mensagem será processada por um serviço do Windows que irá executar as operações necessárias de processamento dos dados, referentes à conversão de dados e a inserção na fila de processamento do e-Forms.

Este web service possui o método de envio InserirDocumento, o qual possui dois parâmetros de entrada: Cabeçalho e Documento (Área de Dados), como apresentado abaixo:

•Cabeçalho (header): Contém as informações necessárias para que possam ser processados os documentos enviados. Este XML conterá todos os dados de controle e definição para que o serviço de processamento possa atuar sobre os dados encaminhados;

•Área de dados: Contém o documento a ser processado pela solução.

Para efetuar o download do schema xsd clique aqui!

Exemplo XML de Cabeçalho

</eformsInserir>

Detalhamento do schema eformsInserir

eformsInserir
#	Pai	Campo	Descrição	Tipo	Obrigatório	Ocorrências	Tamanho	Observações
1		versao	Versão do schema.	C	S	1	4	Versão do schema.
2		tipodocumento	Tipo do documento.	N	S	1	1	1 = XML; 2 = TXT.
3		tiposervico	Tipo de serviço solicitado.	N	S	1	1	1 = Emissão - Inserção de documento; 2 = Emissão - Inserção de Cancelamento; 3 = Emissão - Inserção de Inutilização; 4 = Emissão - Inserção de Cancelamento /Inutilização; 5 = Emissão - Inserção de Impressão comandada; 6 = Emissão - Inserção de Eventos; 7 = Emissão/Recepção - Inserção de pedido de impressão; 9 = Recepção - Inserção de documento / Eventos. 10 = Emissão - Inserção de ped-bol.
4		identificador	Identificador do Job de processamento (JobKey).	C	S	1	1..60	Indica o JobKey configurado no Job de processamento para documentos de envio (NF-e, CT-e e MDF-e), cancelamento, inutilização, cancelamento/inutilização e solicitação de impressão. Quando for enviado documentos de eventos (CC-e e cancelamento) deve ser informado o JobKey de evento configurado no Job. Se o documento enviado for uma manifestação ou documentos de recepção, deverá ser indicado o JobKey configurado no Entry Job.
5		validarschema	Validação do schema da área de dados.	N	N	1	1	1 = validar; 2 = não validar. Caso o campo não seja informado no XML receberá como valor padrão 2. Para inserção de documentos de entrada não existe validação de Schema. Para quando a validação for em formato XML, somente serão validados documentos de envio e evento.
6		processoLinear	Indica se o processamento das requisições de insersão serão feitas uma por vez	N	N	1	1	Informar o valor 1 para ativar o processamento linear do serviço ou não informar a tag. Com o uso do processo linear o serviço do Input irá processar os documentos em fila na ordem de chegada, podendo levar praticamente o dobro do tempo de processamento em relação ao paralelo.
7		usuario	Usuário da impressão do documento.	C	N	1	1..30	Nome do usuário a ser utilizado na geração da impressão onde o software de contabilização de impressão estará atuando em conjunto.
8		nomedocumento	Nome do documento que será usado pelo sistema de contabilização de impressão.	C	N	1	1..50
9		listavalores	Lista de valores.	G	N	1		Lista de valores contendo os dados referentes a cada chave de acesso constante dentro do documento eletrônico. Este campo deve ser obrigatório caso o ERP deseje consultar o processamento de protocolos através de campos compostos.
10	9	valores	Valor composto.			1...N		Valor composto.
11	10	cnpj	CNPJ da chave de acesso.	N	S	1	14	CNPJ da chave de acesso.
12	10	numero	Número da chave de acesso.	N	S	1	1..9	Número da chave de acesso.
13	10	serie	Série da chave de acesso	N	S	1	1..3	Número entre 0 e 999 da chave de acesso do docuemnto eletrônico
14		separador	Separador utilizado para separar os campos.	C	N	1	1	Caracteres separador para arquivos TXT ";", "#", "!","?".

Para cada requisição efetuada, é apresentado um retorno pelo web service. É retornado um protocolo que possibilita ao ERP efetuar as consultas sobre os status dos documentos. Este será retornado somente se não ocorrerem erros na chamada. Caso haja algum erro de postagem, o protocolo será “0” e será retornada uma mensagem de erro na estrutura.

Ao utilizar o tiposervico com valor 7 (Emissão/Recepção - Inserção de pedido de impressão), caso seja enviado informando um JOB de saída, será direcionado o arquivo para a configuração realizada no "Cadastro de Entrada (via banco/diretório)" no e-Connector Settings;

Caso seja enviado informando um JOB de entrada, será direcionado o arquivo para a configuração realizada no campo "Processamento de eventos e consulta" no e-Connector Settings;

Ao enviar para uma entrada via diretório será gerado o arquivo com extensão ped-print que será processado pelo ERPprint Service;

E ao enviar para uma entrada via banco de dados, será destinado a tabela de entrada configurada respeitando o tipo de arquivo enviado (TXT ou XML) que será processado pelo ERPprint Service;

Para processamento do ped-bol, será aceito arquivos apenas no formato TXT para o campo tipodocumento, não sera realizado validação de schema, para o campo tiposervico será usado o valor 10 e será necessário informar o JobKey no campo identificador. O envio do ped-bol será feito apenas para entradas via banco de dados no e-forms.

Visualizar modelo do retorno da chamada