Este documento é material de especificação dos requisitos de manutenção, trata-se de conteúdo extremamente técnico. |
---|
Especificação | |||
Produto | TSS | Módulo | NF-e |
Segmento Executor | Serviços | ||
Chamado/ISSUE | |||
País | ( X ) Brasil ( ) Argentina ( ) México ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colômbia ( ) Outro _____________. |
Objetivo
Possibilitar que o TSS envie para o ERP o arquivo PDF da Carta de Correção Eletrônica (CC-e), como também, o envio por e-mail do arquivo PDF anexado após a sua autorização.
Regras de Negócio
Para realizar o processo de exportação, tanto no formato XML como no formato PDF, foi criado um método NFEEXPEVENTO.
Sua estrutura de recebimento é:
USERTOKEN - usar TOTVS
ID_ENT - Código da entidade retornado pelo WS SpedAdm/AdmEmpresas.
CHVINICIAL - Chave da NF-e inicial para o processamento.
CHVFINAL - Chave da NF-e final para o processamento.
TIPO - Tipo de exportação. Valores aceito: 0 - Todos / 1 - XML / 2 - PDF
Sua estrutura de retorno é:
NFEEXPEVENTORESULT - Estrutura de retorno principal
RETEXPEVENTO - Estrutura de retorno de cada nota
CHAVE - Chave do documento
ID_EVENTO - Id do evento
PDF - Arquivo PDF encodado em base64
XML - XML do evento
Caso a requisição esteja com a tag TIPO igual a 0 (todos) ou 2 (PDF), somente será aceito uma única chave, devido ao tempo de processo e também o fluxo de tráfegos de dados.
O arquivo PDF será retornado na tag PDF encodado em base64, para que seja possível realizar a gravação por parte do requisitante.
Para realizar o processo de envio por e-mail foi criado o parâmetro MV_CCEPDF, onde caso seja realizada a configuração através do método CFGCCE, será anexado o PDF juntamente com o XML após a autorização do evento.
O método CFGCCE é utilizado para realizar a configuração necessária da Carta de Correção da NF-e, assim foi criado em sua estrutura de recebimento a tag opcional:
ENVIACCEPDF - Indica se será enviado por e-mail o arquivo PDF da carta de correção, após a autorização do evento. Valores aceito: 1 - Sim / 2 - Não
E incluído em sua estrutura de retorno a tag:
CCEPDF - Retorna mensagem de configuração do envio da cartão de correção no formato PDF.
"Envio de CCE em PDF configurado com sucesso."
"Envio de CCE em PDF não configurado."
Após configurado o parâmetro MV_CCEPDF, onde 1 indica que será enviado anexado ao e-mail e 2 indica que não será enviado, ou seja, somente será enviado o XML do evento.
Poderá ser realizado a configuração do envio através das interfaces TSSMANAGER e TSSINTERFACE.
Poderá ser realizado o envio através das interfaces TSSMANAGER e TSSMONITOR.
Documentação de como realizar os processos acima: Configuração de parâmetros e Envio da Carta de correção em PDF
Web Services e Métodos do TSS
Serão utilizados os métodos dos Web Services abaixo:
Método CFGCCE
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CFGCCE xmlns="http://webservices.totvs.com.br/spedcfgnfe.apw"> <USERTOKEN>TOTVS</USERTOKEN> <ID_ENT>000001</ID_ENT> <AMBIENTECCE>2</AMBIENTECCE> <VERCCELAYOUT>1.00</VERCCELAYOUT> <VERCCELAYEVEN>1.00</VERCCELAYEVEN> <VERCCEEVEN>1.00</VERCCEEVEN> <VERCCE>1.00</VERCCE> <HORAVERAOCCE>2-Nao</HORAVERAOCCE> <HORARIOCCE>2-Brasilia</HORARIOCCE> <SEQLOTECCE>1</SEQLOTECCE> <ENVIACCEPDF>1</ENVIACCEPDF> </CFGCCE> </soap:Body> </soap:Envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CFGCCERESPONSE xmlns="http://webservices.totvs.com.br/spedcfgnfe.apw"> <CFGCCERESULT> <AMBIENTE>2-Homologacao</AMBIENTE> <AMBIENTEEPP>2-Homologacao</AMBIENTEEPP> <CCEPDF>Envio de CCE em PDF configurado com sucesso.</CCEPDF> <HORARIOCCE>2-Brasilia</HORARIOCCE> <HORAVERAOCCE>2-Nao</HORAVERAOCCE> <SEQLOTECCE>1</SEQLOTECCE> <SEQLOTEEPP>0</SEQLOTEEPP> <VERCCE>1.00</VERCCE> <VERCCEEVEN>1.00</VERCCEEVEN> <VERCCELAYEVEN>1.00</VERCCELAYEVEN> <VERCCELAYOUT>1.00</VERCCELAYOUT> <VEREPP>1.00</VEREPP> <VEREPPEVEN>1.00</VEREPPEVEN> <VEREPPLAYEVEN>1.00</VEREPPLAYEVEN> <VEREPPLAYOUT>1.00</VEREPPLAYOUT> </CFGCCERESULT> </CFGCCERESPONSE> </soap:Body> </soap:Envelope>
Método NFEEXPEVENTO.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfs="http://webservices.totvs.com.br/nfsebra.apw"> <soapenv:Header/> <soapenv:Body> <nfs:NFEEXPEVENTO> <nfs:USERTOKEN>TOTVS</nfs:USERTOKEN> <nfs:ID_ENT>000001</nfs:ID_ENT> <nfs:ID_EVENTO>110110</nfs:ID_EVENTO> <nfs:CHVINICIAL>CHAVE DA NOTA</nfs:CHVINICIAL> <nfs:CHVFINAL>CHAVE DA NOTA</nfs:CHVFINAL> <nfs:TIPO>0</nfs:TIPO> </nfs:NFEEXPEVENTO> </soapenv:Body> </soapenv:Envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <NFEEXPEVENTORESPONSE xmlns="http://webservices.totvs.com.br/nfsebra.apw"> <NFEEXPEVENTORESULT> <RETEXPEVENTO> <CHAVE>CHAVE DA NOTA</CHAVE> <ID_EVENTO>ID DO EVENTO</ID_EVENTO> <PDF>UERGIEVNIEJBU0U2NA==</PDF> <XML>XML DO EVENTO</XML> </RETEXPEVENTO> </NFEEXPEVENTORESULT> </NFEEXPEVENTORESPONSE> </soap:Body> </soap:Envelope>
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|