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 _____________. |
Demonstrar as implementações no Envio de DANFE do ERP por E-mail disparado pelo TSS.
Este documento tem por objetivo a definição das especificações e critérios técnicos necessários para a implementação dos métodos "StatusDistribuicaoDeDocumentos" e "DistribuicaoDeDocumentos"
Atualmente estes métodos serão implementados inicialmente para a NF-e (modelo 55).
Regras de Negócio
O Método de "StatusDistribuicaoDeDocumentos " foi criado para verificação do Status do Email de Distribuição de Documentos Eletrônicos (Modelo 55).
O serviço carrega apenas os documentos autorizados e emitidos dentro do período de 30 dias para os Status de envio de E-Mail 0, 1, 2 e 3.
Legenda Status:
O Método de "DistribuicaoDeDocumentos " foi criado para o envio de E-mail de Distribuição dos Documentos Eletrônicos processados pelo TSS. Através da utilização dos parâmetros "MV_AUTDIST",
disponibilizado no método "CFGPARAMSPED" para o serviço "SPEDCFGNFE", os ERP´s poderão habilitar e desabilitar a distribuição automática feita pelo TSS.
Quando o parâmetro estiver desabilitado, o TSS aguarda que o ERP faça a solicitação da distribuição.
Este serviço visa atender as seguintes demandas:
Importante: Se o parâmetro NFEDISD estiver setado 1 (um) e AUTDIST estiver desativado igual á 0 (zero), o TSS irá ficar aguardando a requisição do ERP para disparo do e-mail.
NFEDISD | AUTDIST | XML | DANFE TSS (PDF) | DANFE ERP (PDF) |
---|---|---|---|---|
0 | 1 | X | - | - |
1 | 1 | X | X | - |
1 | 0 | X | - | X |
Serão utilizados os métodos dos Web Services abaixo:
Serviço: SPEDCFGNFE
Este método deve ser utilizado para informar qual a configuração dos parâmetros de funcionamento do TSS.
Os parâmetros de entrada do método são:
<soap:Body>
<USERTOKEN>STRING</USERTOKEN>
<ID_ENT>STRING</ID_ENT>
<USACOLAB>STRING</USACOLAB>
<NUMRETNF>INTEGER</NUMRETNF>
<AMBIENTE>INTEGER</AMBIENTE>
<MODALIDADE>INTEGER</MODALIDADE>
<VERSAONFE>STRING</VERSAONFE>
<VERSAONSE>STRING</VERSAONSE>
<VERSAODPEC>STRING</VERSAODPEC>
<VERSAOCTE>STRING</VERSAOCTE>
<USERNEOG>STRING</USERNEOG>
<PASSWORD>BASE64BINARY</PASSWORD>
<CONFALL>STRING</CONFALL>
<DOCSCOL>STRING</DOCSCOL>
<AMBNFECOLAB>INTEGER</AMBNFECOLAB>
<AMBCTECOLAB>INTEGER</AMBCTECOLAB>
<CFGPARAMDOC>
<PARAMDOC>
<CFGDOC>
<DOCUMENTOAMBIENTE>INTEGER</DOCUMENTOAMBIENTE>
<DOCUMENTOMODELO>INTEGER</DOCUMENTOMODELO>
</CFGDOC>
<CFGDOC>
<DOCUMENTOAMBIENTE>INTEGER</DOCUMENTOAMBIENTE>
<DOCUMENTOMODELO>INTEGER</DOCUMENTOMODELO>
</CFGDOC>
</PARAMDOC>
</CFGPARAMDOC>
<NFECANCEVENTO>BOOLEAN</NFECANCEVENTO>
<NFEDISTRDANFE>STRING</NFEDISTRDANFE>
<NFEENVEPEC>STRING</NFEENVEPEC>
<AUTODISTR>STRING</AUTODISTR>
</soap:Body>
Parâmetro | Tipo | Tam | Pai | Observação |
USERTOKEN | Alfanumérico | 06 | - | Token de bilhetagem para execução do serviço. |
ID_ENT | Alfanumérico | 06 | - | Código da entidade retornado pelo WS SpedAdm/AdmEmpresas. |
USACOLAB | Alfanumérico | 1 | - | Indica se o TSS realizará a INTEGRAÇÃO com a NEOGRID (TOTVS COLABORAÇÃO). Caso seja passado Sim, indica que a integração deve ser realizada, caso contrário (Não) a integração não será feita. |
NUMRETNF | Inteiro | 03 | - | Indica quantas notas retornarão da Integração com a NeoGrid a cada solicitação do TSS. Exemplo: Caso seja passado 10, sempre que o TSS chamar o Método de Retorno de Notas da Neogrid, ele retornará 10 notas. Observação: Caso a empresa utilize notas com muitos itens e gere um XML muito grande, este número deve ser reduzido para que o TSS suporte o retorno. |
AMBIENTE | Inteiro | 1 | - | Informe 1 para produção, 2 para homologação ou 0 para saber a configuração atual do ambiente. |
MODALIDADE | Inteiro | 1 | - | Modalidades da NF-e: 0-Configuração; 1-Normal; 2-Contingência off-line; 3-Contingência SCAN; 4-Ambiente Nacional; 5-EPEC; 6-SEFAZ Virtual; 7-Contingência FS-DA; 8-Contingência SVC-AN; 9-Contingência SVC-RS. |
VERSAONFE | Alfanumérico | 04 | - | Informe: 0.00-Configuração; 9.99; 2.00; 3.10 |
VERSAONSE | Alfanumérico | 04 | - | Informe: 0.00-Configuração; 9.99; 1.00 |
VERSAODPEC | Alfanumérico | 04 | Informe: 0.00-Configuração; 9.99; 1.01 | |
VERSAOCTE | Alfanumérico | 04 | - | Informe: 0.00-Configuração; 9.99 2.00 3.00 |
USERNEOG | Alfanumérico | - | Usuário de acesso http, que será responsável pela comunicação do TSS com WS da NeoGrid. | |
PASSWORD | Binário | - | Senha do Usuário de acesso HTTP, que será responsável pela comunicação do TSS com WS da NeoGrid. | |
CONFALL | Alfanumérico | - | Sim – para habilitar e Não – para desabilitar. Habilita a confirmação de todos os Documentos recebidos da NeoGrid. Este parâmetro deve ser utilizado somente se houver muitos documentos retornando da NeoGrid, impedindo que novos documentos enviados pelo ERP retornem. Habilitando este parâmetro, o processo poderá ficar mais lento. Foi necessária a criação deste parâmetro pois, por meio do portal da Nota Fiscal Eletrônica e CTE da NeoGrid, é possível que solicitar manualmente o retorno das notas para o ERP e, ao chegar este retorno ao TSS, se a nota já estiver autorizada e confirmada, acaba bloqueando o retorno de novos documentos. | |
DOCSCOL | Alfanumérico | - | Informe, separando por vírgula, quais documentos devem ser processados pelo TOTVS Colaboração. Sendo: 0- Todos; 1- Emissão de NF-e; 2- Emissão de CT-e; 3- Emissão de NFS-e; 4- Nenhum; 5- Carta de correção; 6- MD-e; 7- MDF-e; Exemplo: Caso queira que a emissão de NF-e e Emissão de CT-e seja feita pelo TOTVS Colaboração, o conteúdo deste campo deve ser: 1,2 | |
AMBNFECOLAB | INTEGER | 1 | - | Informe 1 para produção, 2 para homologação ou 0 para saber a configuração atual do ambiente. |
AMBCTECOLAB | INTEGER | 1 | - | Informe 1 para produção, 2 para homologação ou 0 para saber a configuração atual do ambiente. |
CFGPARAMDOC | Estrutura | Estrutura | -- | |
PARAMDOC | Estrutura | Estrutura | CFGPARAMDOC | -- |
CFGDOC | Estrutura | Estrutura | PARAMDOC | -- |
DOCUMENTOAMBIENTE | - | CFGDOC | Configuração de ambiente do documento. | |
DOCUMENTOMODELO | - | CFGDOC | Modelo do documento. | |
NFECANCEVENTO | Booleano | - | - | Indica se o cancelamento será realizado por evento ou não. |
NFEDISTRDANFE | Alfanumérico | 1 | - | Informa se no e-mail de distribuição do XML da NF-e ao destinatário do documento, será encaminhado o DANFE impresso em arquivo. Os valores possíveis são: 0 – Não enviar DANFE. 1 – Enviar DANFE. |
NFEENVEPEC | Alfanumerico | 1 | - | Habilita o envio do evento EPEC para a NF-e versão 3.10 0- Não; 1- Sim Observação: Caso o parâmetro não seja informado, será considerado o valor 0- Não. |
AUTODISTR | Alfanumérico | 1 | - | Indica se o TSS sera responsável pelo envio do documento (Ex: DANFE da nfe). Os valores possíveis são: 1 – O TSS será responsável pelo envio do documento. 0 – O TSS não será responsável pelo envio do documento ficando a cargo do ERP. |
Os parâmetros de saída do método são:
<soap:Body>
<MSG>STRING</MSG>
</soap:Body>
</soap:Envelope>
Parâmetro | Tipo | Tam | Pai | Observação |
MSG | Alfanumérico | 255 | - | Mensagem de configuração com sucesso, por parâmetro: Exemplo1: Caso sejam passados todos os parâmetros: 001 - Configuração do Ambiente : Ok 002 - Configuração da Modalidade: Ok 003 - Configuração da Versão da NF-e: Ok 004 - Configuração da Versão da NFs-e: Ok 005 - Configuração da Versão do DPEC: Ok 006 - Configuração da versão do CT-e: Ok 007 - Configuração da Colaboração: Ok 008 - Configuração de Número de Retorno de Notas: Ok 009 - Configuração da Autenticação HTTP: Ok 010 - Confirmação de Todos os documentos Ativada.
007 - Configuração da Colaboração: Ok 008 - Configuração de Número de Retorno de Notas: Ok 009 – Configuração de Documentos: OK. 010 - Confirmação de Todos documentos Ativada. 011 - Confirmação de Todos documentos Desativada. 012 - Configuração de Documentos: OK; 013 - Configuração do Ambiente de Recebimento de NF-e : Ok. 014 - Configuração do Ambiente de Recebimento de CT-e : Ok. 015 - Configuração de Cancelamento por Evento : Ok. 016 - Configuração para envio do DANFE por e-mail : Ok 017 - Não é possível desabilitar o cancelamento por evento; 018 - Configuração para envio da NF-e 3.10 na modalidade EPEC : Ok 019 - Configuração para enviar email de distribuição automatica: Ok |
Serviço: NFESBRA
Método destinado ao envio de E-mail de Distribuição dos Documentos Eletrônicos processados pelo TSS. Através da utilização do parâmetro "MV_AUTDIST" disponível no método "CFGPARAMSPED" para o serviço "SPEDCFGNFE",
os ERP´s poderão desabilitar a distribuição automática feita pelo TSS.
Os parâmetros de entrada do método são:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfs="http://webservices.totvs.com.br/nfsebra.apw">
<soapenv:Header/>
<soapenv:Body>
<nfs:DISTRIBUICAODEDOCUMENTOS>
<nfs:USERTOKEN>?</nfs:USERTOKEN>
<nfs:ID_ENT>?</nfs:ID_ENT>
<nfs:DISTEMAIL>
<nfs:LISTADOCUMENTOS>
<!--Zero or more repetitions:-->
<nfs:DOCUMENTOS>
<!--Optional:-->
<nfs:EMAIL>?</nfs:EMAIL>
<nfs:NFE_ID>?</nfs:NFE_ID>
<!--Optional:-->
<nfs:PDF>cid:1076726658018</nfs:PDF>
<!--Optional:-->
<nfs:RETRANSMITIR>?</nfs:RETRANSMITIR>
<!--Optional:-->
<nfs:TIPOCOMPRESSAO>?</nfs:TIPOCOMPRESSAO>
</nfs:DOCUMENTOS>
</nfs:LISTADOCUMENTOS>
<nfs:MODELO>?</nfs:MODELO>
</nfs:DISTEMAIL>
</nfs:DISTRIBUICAODEDOCUMENTOS>
</soapenv:Body>
</soapenv:Envelope>
Parâmetro | Tipo | Tam | Pai | Observação |
USERTOKEN | Alfanumérico | 6 | - | Token de bilhetagem para execução do serviço. |
ID_ENT | Alfanumérico | 6 | - | Código da entidade retornado pelo WS SpedAdm/AdmEmpresas. |
DISTEMAIL | Estrutura | - | - | Tag Raiz. |
LISTADOCUMENTOS | Estrutura | - | DISTEMAIL | Tag Raiz. |
DOCUMENTOS | Estrutura | - | LISTADOCUMENTOS | |
Alfanumérico | 250 | LISTADOCUMENTOS | Contas de e-mail. Separar endereço(s) por ponto-e-vírgula. Ex: [email protected];nfe2@totvs.com.br. | |
NFE_ID | Alfanumérico | - | LISTADOCUMENTOS | ID da nota fiscal eletrônica. |
Base64Binary | - | LISTADOCUMENTOS | PDF a ser utilizado na distribuição via e-mail. | |
RETRANSMITIR | Lógico | - | LISTADOCUMENTOS | Forçar envio do e-mail, independente do status de envio de e-mail atual. |
TIPOCOMPRESSAO | Alfanumérico | LISTADOCUMENTOS | Tipo de compressão a ser utilizado. Fixo "zip". Obs. Caso informado, o nome do arquivo deverá ser o Id documento informado no parâmetro NFE_ID da requisição. | |
MODELO | Alfanumérico | 10 | DISTEMAIL | Modelo do documento eletrônico. Modelos válidos: 55 (NFe). |
Soap Fault
Fault | Descrição |
Invalid Token | O parâmetro USERTOKEN foi passado incorretamente. |
001 | Código da entidade inválida. |
002 | Código da entidade em branco. |
003 | Modelo inválido. Modelos permitidos: 55 |
Exemplos:
Envio:
Retorno:
Serviço: NFESBRA
Método destinado a verificação do Status do Email de Distribuição de Documentos Eletrônicos (Modelo 55).
Os parâmetros de entrada do método são:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfs="http://webservices.totvs.com.br/nfsebra.apw">
<soapenv:Header/>
<soapenv:Body>
<nfs:STATUSDISTRIBUICAODEDOCUMENTOS>
<nfs:USERTOKEN>Character</nfs:USERTOKEN>
<nfs:ID_ENT>Numérico</nfs:ID_ENT>
<nfs:STATUSDISTMAIL>
<nfs:MODELO>Alfanumérico</nfs:MODELO>
<nfs:SEQUENCIA>Numérico</nfs:SEQUENCIA>
<!--Optional:-->
<nfs:STATUS>Numérico</nfs:STATUS>
</nfs:STATUSDISTMAIL>
</nfs:STATUSDISTRIBUICAODEDOCUMENTOS>
</soapenv:Body>
</soapenv:Envelope>
Parâmetro | Tipo | Tam | Pai | Observação |
USERTOKEN | Alfanumérico | 6 | - | Token de bilhetagem para execução do serviço. |
ID_ENT | Alfanumérico | 6 | - | Código da entidade retornado pelo WS SpedAdm/AdmEmpresas. |
STATUSDISTMAIL | Estrutura | - | - | Tag Raiz. |
MODELO | Alfanumérico | 10 | STATUSDISTMAIL | Modelo do documento eletrônico Modelos válidos: 55 (NFe). |
SEQUENCIA | Numérico | 1-16 | STATUSDISTMAIL | Sequencia do retorno. Utilizado como marcador(paginação) de retorno da consulta. Default = 1 |
STATUS | Numérico | 1 | STATUSDISTMAIL | Status a ser filtrado no retorno da consulta. 0= Aguardando solicitação 1= Solicitação já realizada 2= Distribuição Realizada 3=Falha na Distribuição |
Fault | Descrição |
Invalid Token | O parâmetro USERTOKEN foi passado incorretamente. |
001 | Código da entidade inválida. |
002 | Código da entidade em branco. |
003 | Modelo inválido. Modelos permitidos: 55 |
004 | Status inválido. 1=Pendente; 2=Distribuído; 3=Falha na Distribuição |
Exemplos:
Envio:
Retorno:
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|