Web service Com.senior.g5.co.int.eletronicos.documentos
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_int_eletronicos_documentos?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_eletronicos_documentos?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_eletronicos_documentos?wsdl
Portas
Essa porta realiza o retorno dos eventos de pedidos de prorrogação de suspensão de ICMS. O retorno dos eventos é realizado em dois retornos:
Primeiro retorno: confirmação do recebimento do evento
O primeiro retorno apenas é registrado o recebimento do evento na SEFAZ, onde o ERP recebe o número do protocolo de recebimento, a data e a hora de recebimento. Para o ERP receber o primeiro retorno, a requisição do web service envia as seguintes informações:
- EntradaDoRetornoNFEletronica.TipDoe: tipo do documento eletrônico. Devem ser enviados os valores abaixo, conforme o tipo do evento que está sendo retornado:
- 14: 111500 - Evento Pedido de Prorrogação 1º Prazo;
- 15: 111501 - Evento Pedido de Prorrogação 2º prazo;
- 16: 111502 - Evento Cancelamento de Pedido de Prorrogação 1º prazo;
- 17: 111503 - Evento Cancelamento de pedido de Prorrogação 2° prazo.
- EntradaDoRetornoNFEletronica.SeqEve: sequência do evento para o qual está sendo processado o retorno.
- EntradaDoRetornoNFEletronica.ChvNel: chave de acesso do documento eletrônico. Este valor é opcional se for informado EntradaDoRetornoNFEletronica.FilCgc, EntradaDoRetornoNFEletronica.CodSel e EntradaDoRetornoNFEletronica.NumNfv.
- EntradaDoRetornoNFEletronica.FilCgc: CNPJ da filial da nota fiscal de saída para a qual foi gerado o evento. Este valo é opcional se for informado EntradaDoRetornoNFEletronica.ChvNel.
- EntradaDoRetornoNFEletronica.CodSel: código da série legal da nota fiscal de saída para a qual foi gerado o evento. Este valor é opcional se for informado EntradaDoRetornoNFEletronica.ChvNel.
- EntradaDoRetornoNFEletronica.NumNfv: número da nota fiscal para a qual foi gerado o evento. Este valor é opcional se for informado EntradaDoRetornoNFEletronica.ChvNel.
- EntradaDoRetornoNFEletronica.NumPrt: número do protocolo de registro de recebimento ou cancelamento do evento de prorrogação de ICMS na SEFAZ.
- EntradaDoRetornoNFEletronica.DatHor: data e hora em que foi gerado o protocolo de recebimento ou cancelamento do evento na SEFAZ (formato: AAAA-MM-DDThh:mm).
- EntradaDoRetornoNFEletronica.SitNel: situação eletrônica do evento. Deve ser enviado somente quando se tratar de uma rejeição (situação 4), erro na geração do arquivo (situação 10) ou erro na solicitação de cancelamento (situação 11). Não deve ser enviada a situação 3 (autorizada) neste momento, visto que o deferimento (autorização) ou indeferimento (negação) irá ocorrer em um segundo retorno, através do evento do Fisco.
- EntradaDoRetornoNFEletronica.observacao.ObsRet: observação do retorno. Deve ser enviado somente quando se tratar de uma rejeição (situação 4), erro de geração do arquivo (situação 10) ou erro na solicitação de cancelamento (situação 11).
Segundo retorno: retorno do Deferimento ou Indeferimento através de eventos do Fisco
No segundo retorno é enviado o Deferimento (autorização) ou Indeferimento (negação) do evento, e o ERP grava um novo evento do Fisco com a situação. O ERP recebe estes retornos através de eventos emitidos pelo Fisco. Estes eventos são armazenados no ERP e atualizam as informações dos eventos de origem. Para o ERP receber estes eventos, a requisição do web service envia as seguintes informações:
- EntradaDoRetornoNFEletronica.TipDoe: tipo do documento eletrônico. Devem ser enviados os valores abaixo, conforme o tipo do evento que está sendo retornado:
- 18: 411500 - Evento Fisco Resposta ao Pedido de Prorrogação 1º prazo;
- 19: 411501 - Evento Fisco Resposta ao Pedido de Prorrogação 2º prazo;
- 20: 411502 - Evento Fisco Resposta ao Cancelamento de Prorrogação 1º prazo;
- 21: 411503 - Evento Fisco Resposta ao Cancelamento de Prorrogação 2º prazo.
- EntradaDoRetornoNFEletronica.SeqEve: sequência do evento do Fisco para o mesmo tipo de evento.
- EntradaDoRetornoNFEletronica.CodOrg: código do órgão de geração do evento do Fisco;
- EntradaDoRetornoNFEletronica.EveOri: identificação do evento de origem emitido pelo contribuinte. Esta identificação é composta por: caracteres "ID" + tipo do evento + chave da NF-e + sequência do evento. Por exemplo, um evento do tipo 111500 gerado para uma NF-e cuja chave eletrônica é 42160880680093000181550020000003151470162450, a identificação fica: ID + 111500 + 42160880680093000181550020000003151470162450 + 01, ID1115004216088068009300018155002000000315147016245001.
- EntradaDoRetornoNFEletronica.DatHor: data e hora em que foi gerada a resposta do Fisco para o evento (formato: AAAA-MM-DDThh:mm).
O grupo Itens do web service, que refere-se às informações tratadas a nível de item do evento, envia as seguintes informações requisição por item:
- EntradaDoRetornoNFEletronica.Itens.SeqNfi: sequência do item da NF-e conforme o arquivo XML;
- EntradaDoRetornoNFEletronica.Itens.SitNel: situação eletrônica do item no evento. Deve ser enviado 3 (Autorizado) nos casos de Deferimento ou 19 (Indeferido) nos casos de Indeferimento;
- EntradaDoRetornoNFEletronica.Itens.JusFis: justificativa de resposta do Fisco.
Para os eventos do Fisco de tipos 411500 - Evento Fisco Resposta ao Pedido de Prorrogação 1º prazo e 411501 - Evento Fisco Resposta ao Pedido de Prorrogação 2º prazo, os eventos de origem serão os eventos de tipo 111500 - Evento Pedido de Prorrogação 1º Prazo e 111501 - Evento Pedido de Prorrogação 2º prazo, respectivamente. Ao receber um evento do Fisco, o sistema localiza o evento de origem e atualiza as seguintes informações a nível de item:
- Situação eletrônica através do campo EntradaDoRetornoNFEletronica.Itens.SitNel (situação eletrônica do item do evento do Fisco);
- Observação do retorno através do campo EntradaDoRetornoNFEletronica.Itens.JusFis (observação do item do evento do Fisco).
Se o evento de origem estiver vinculado a um evento de cancelamento, de tipos 111502 - Evento Cancelamento de Pedido de Prorrogação 1º prazo ou 111503 - Evento Cancelamento de pedido de Prorrogação 2° prazo, este evento de cancelamento é localizado e têm as seguintes informações atualizadas:
- Situação eletrônica: será atualizada para a situação 9 (Cancelado) quando o campo EntradaDoRetornoNFEletronica.Itens.SitNel (situação eletrônica do item do evento do Fisco) for 3 (Autorizado), ou seja, o cancelamento foi deferido. Quando o campo EntradaDoRetornoNFEletronica.Itens.SitNel (situação eletrônica do item do evento do Fisco) for 19 (Indeferido), a situação do evento de cancelamento será atualizada ou mantida em 3 (Autorizado).
- Observação do retorno através do campo EntradaDoRetornoNFEletronica.Itens.JusFis (observação do item do evento do Fisco).
Após a atualização do evento de origem, o evento do Fisco é gravado da mesma forma como são gravados os demais eventos de prorrogação de suspensão de ICMS.
Observação
Por causa de instabilidade na SEFAZ pode ocorrer que, na solicitação de inutilização de uma NF-e, ela seja inutilizada corretamente, porém a SEFAZ não retorne o número do protocolo ao eDocs. A Secretaria não disponibiliza um web service de consulta das inutilizações para que o eDocs possa atualizar o número do protocolo. Assim, quando ocorre esse tipo de instabilidade, o eDocs atualiza a NF-e para inutilizada, pois a SEFAZ retornou a inutilização como ok, no entanto o sistema não grava o número de protocolo, já que ele não foi retornado. Por isso esta porta não valida a falta do protocolo de inutilização. Nesses casos, a NF-e será atualizada no ERP ou GO UP para a situação 8 - Inutilizada, porém não irá conter as informações de data, hora e número de protocolo de inutilização.
Necessita autenticação: sim.
Situação de versão: atual.
Versão: 6.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ImportarRetornos> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <EntradaDoRetornoNFEletronica> <seqDoc>String</seqDoc> <numNfv>String</numNfv> <seqEve>String</seqEve> <numDfs>String</numDfs> <filCgc>String</filCgc> <codSel>String</codSel> <chvNel>String</chvNel> <chvNov>String</chvNov> <numPrt>String</numPrt> <codVer>String</codVer> <datHor>String</datHor> <sitNel>String</sitNel> <codErr>String</codErr> <desErr>String</desErr> <tipDoe>String</tipDoe> <observacao> <obsRet>String</obsRet> </observacao> <codOrg>Integer</codOrg> <eveOri>String</eveOri> <segCba>String</segCba> <itens> <seqNfi>Integer</seqNfi> <sitEve>Integer</sitEve> <jusFis>String</jusFis> </itens> </EntradaDoRetornoNFEletronica> </parameters> </ser:ImportarRetornos> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
entradaDoRetornoNFEletronica | Set | - |
entradaDoRetornoNFEletronica.seqDoc | String | (Opcional) - String(050) - Sequência do documento eletrônico. |
entradaDoRetornoNFEletronica.numNfv | String | (Obrigatório) - Number(009) - Número da nota fiscal de saída/RPS - Condição: Opcional se ChvNel informado. |
entradaDoRetornoNFEletronica.seqEve | String | (Opcional) - Number(004) - Sequência do evento da carta de correção eletrônica - Condição: Obrigatório se for carta de correção eletrônica. |
entradaDoRetornoNFEletronica.numDfs | String | (Opcional) - Number(016) - Número do documento fiscal de serviço - Condição: Obrigatório se TipDoc = 3 (NFS-e). |
entradaDoRetornoNFEletronica.filCgc | String | (Obrigatório) - Number(014) - Número do CNPJ da filial - Condição: Opcional se CodEmp e CodFil ou ChvNel informado. |
entradaDoRetornoNFEletronica.codSel | String | (Obrigatório) - String(003) - Código da série legal - Condição: Opcional se CodEmp e CodFil ou ChvNel informado. |
entradaDoRetornoNFEletronica.chvNel | String | (Obrigatório) - String(050) - Chave de acesso do documento eletrônico - Condição: Opcional se FilCgc, CodSnf e NumNfv informado ou CodEmp, CodFil, NumNfv e CodSnf informado. |
entradaDoRetornoNFEletronica.chvNov | String | (Opcional) - String(050) - Nova Chave de acesso do documento eletrônico, informar somente quando é necessária a troca da chave, por exemplo se a SEFAZ entrou em contingência. |
entradaDoRetornoNFEletronica.numPrt | String | (Obrigatório) - String(015) - Número do protocolo do documento eletrônico para retorno de autorização, cancelamento, inutilização. Observação: Opcional em casos de retornos de erros de geração. |
entradaDoRetornoNFEletronica.codVer | String | (Opcional) - String(015) -Código de verificação do documento eletrônico - Condição: Obrigatório para retorno de autorização (NFS-e). |
entradaDoRetornoNFEletronica.datHor | String | (Obrigatório) - String(016) - Data e hora da autorização ou Cancelamento ou Inutilização (Formato: AAAA-MM-DDTHH:MM; ex.: 2008-10-30T09:28). |
entradaDoRetornoNFEletronica.sitNel | String | (Obrigatório) - Number(002) - Situação do documento eletrônico
DESCRIÇÕES DA SITUAÇÕES: 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização. RETORNOS ESPERADOS NA NOTA FISCAL ELETRÔNICA E NO CONHECIMENTO DE TRANSPORTE ELETRÔNICO. Situação do documento no Gestão Empresarial | ERP -> Retorno esperados Mensagem de retorno quando não está nas situações esperadas 2 -> 3 ou 4 ou 5 ou 10 Documento aguardando autorização. Somente são válidos os retornos de documento eletrônico autorizado(3), rejeitado(4), denegado(5) ou erro de geração (10). Foi informado a situação do documento eletrônico como = X. 6 -> 8 ou 12 Documento aguardando inutilização. Somente são válidos os retornos de documento eletrônico inutilizado(8) ou erro na solicitação de inutilização(12). Foi informado a situação do documento eletrônico como = X. 7 -> 9 ou 11 Documento aguardando cancelamento. Somente são válidos os retornos de documento eletrônico cancelado(9) ou erro na solicitação de cancelamento(11). Foi informado a situação do documento eletrônico como = X. RETORNOS ESPERADOS NA NOTA FISCAL ELETRÔNICA DE SERVIÇO. Situação do documento no Gestão Empresarial | ERP -> Retorno esperado Mensagem de retorno quando não está nas situações esperadas 2 -> 3 ou 4 ou 10 Documento aguardando autorização. Somente são válidos os retornos de documento eletrônico autorizado(3), rejeitado(4), denegado(5) ou erro de geração (10). Foi informado a situação do documento eletrônico como = X. 7 -> 9 ou 11 Documento aguardando cancelamento. Somente são válidos os retornos de documento eletrônico cancelado(9), erro na solicitação de cancelamento(11). Foi informado a situação do documento eletrônico como = X. RETORNOS ESPERADOS NA CARTA DE CORREÇÃO ELETRÔNICA. Situação do documento no Gestão Empresarial | ERP -> Retorno esperado Mensagem de retorno quando não está nas situações esperadas 2 -> 3 ou 4 ou 5 ou 10 Carta de correção aguardando autorização. Somente são válidos os retornos de autorizado(3), rejeitado(4) ou denegado(5). Foi informada a situação da carta de correção eletrônica como = X. RETORNOS ESPERADOS NO EVENTO DE CANCELAMENTO. Situação do documento no Gestão Empresarial | ERP -> Retorno esperado Mensagem de retorno quando não está nas situações esperadas 2 -> 3 ou 4 Documento aguardando evento de cancelamento. Somente são válidos os retornos de autorizado(3), rejeitado(4). Foi informada a situação da carta de correção eletrônica como = X. |
entradaDoRetornoNFEletronica.codErr | String | (Opcional) - Number(003) - Código de erro conforme manual do contribuinte. |
entradaDoRetornoNFEletronica.desErr | String | (Opcional) - String(150) - Descrição do erro - Condição: Obrigatório se CodErr informado. |
entradaDoRetornoNFEletronica.tipDoe | String |
(Obrigatório) - Number(002) - Tipo do documento eletrônico Lista:
1 - Nota fiscal eletrônica; 2 - Conhecimento de transporte eletrônico; 3 - Nota fiscal eletrônica de serviço; 4 - Carta de correção eletrônica; 5 - Evento de Cancelamento; 6 - Manifestação do Destinatário - Ciência da Operação; 7 - Manifestação do Destinatário - Confirmação da Operação; 8 - Manifestação do Destinatário - Operação não Realizada; 9 - Manifesto Eletrônico de Documentos Fiscais; 10 - Manifesto Eletrônico de Documentos Fiscais - Cancelamento; 11 - Manifesto Eletrônico de Documentos Fiscais - Encerramento; 12 - Manifesto Eletrônico de Documentos Fiscais - Inclusão de Condutor; 22 - Conhecimento de Transporte Eletrônico - Prestação de Serviço em Desacordo; 24 - Inclusão de DF-e (chamadas: pelo eDocs ou pelo próprio ERP. Ocorre quando o 25 - Evento de Comprovante de Entrega da NF-e; 26 - Evento de Cancelamento comprovante de Entrega da NF-e; 27 - Registro de saída da NF-e; 28 - Cancelamento Registro de saída da NF-e; 29 - Insucesso de Entrega do CT-e; 30 - Cancelamento de Insucesso de Entrega do CT-e; 31 - Conhecimento de Transporte Eletrônico - Cancelamento de Prestação de Serviço em Desacordo. |
entradaDoRetornoNFEletronica.observacao | Set | |
entradaDoRetornoNFEletronica.observacao.obsRet | String | (Opcional) - String(250) - Descrição do retorno. Condição: apenas para retorno com "SitNel = 4,5,11,12" |
entradaDoRetornoNFEletronica.tipCtg | String | (Opcional) - Number(001) - Tipo de contingência em que o documento foi autorizado. Lista: 1 = DPEC, 2 = EPEC, 3 = SCAN, 4 = SVC, 5 = FS-IA, 6 = FS-DA. Condição: quando a Situação do Documento Eletrônico for igual a 16 - Autorizado em Contingência, o preenchimento do campo torna-se obrigatório. |
entradaDoRetornoNFEletronica.chvCtg | String | (Opcional) - String(050) - Chave eletrônica gerada pela contingência. Condição: quando a Situação do Documento Eletrônico for igual a 16 - Autorizado em Contingência, o documento for Nota Fiscal Eletrônica e o Tipo de Contingência for igual a 5 ou 6, ou o documento for Conhecimento de Transporte Eletrônico e o Tipo de Contingência for igual a 6, o preenchimento do campo torna-se obrigatório. |
entradaDoRetornoNFEletronica.codOrg | Integer | (Opcional) - Number(002) - Código do órgão de recepção do evento. Condição: Obrigatório para eventos de resposta do Fisco. |
entradaDoRetornoNFEletronica.eveOri | String | (Opcional) - String(100) - Identificação do evento de origem emitido pelo contribuinte. Condição: obrigatório para eventos de resposta do Fisco. |
entradaDoRetornoNFEletronica.segCba | String | Segundo código de barras da autorização em contingência FS-IA/FS-DA de NF-e ou CT-e (para CT-e apenas contingência FS-DA). Apesar do campo ser alfanumérico, são aceitos apenas números [0-9]. |
itens | - | - |
itens.seqNfi | Integer | (Opcional) - Number(004) - Sequência do item na nota fiscal impressa. Condição: obrigatório para eventos de resposta do Fisco. |
itens.sitEve | Integer | (Opcional) - Number(002) - Situação do evento. Condição: obrigatório para eventos de resposta do Fisco. |
itens.jusFis | String | (Opcional) - String(255) - Justificativa da resposta do Fisco. Condição: obrigatório para eventos de resposta do Fisco. |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ImportarRetornos_4Response> <result> <saidaDoRetornoNFEletronica> <seqDoc>String</seqDoc> <codEmp>String</codEmp> <codFil>String</codFil> <codSnf>String</codSnf> <numNfv>String</numNfv> <seqEve>String</seqEve> <numDfs>String</numDfs> <SegCba>String<SegCba> <chvDoe>String</chvDoe> <result>String</result> </saidaDoRetornoNFEletronica> <tipoRetorno>String</tipoRetorno> <mensagemRetorno>String</mensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ImportarRetornos_4Response> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
saidaDoRetornoNFEletronica | Set | - |
saidaDoRetornoNFEletronica.seqDoc | String | (Opcional) - String(050) - Sequência do documento eletrônico. |
saidaDoRetornoNFEletronica.codEmp | String | (Obrigatório) - Number(004) - Código da empresa |
saidaDoRetornoNFEletronica.codFil | String | (Obrigatório) - Number(005) - Código da filial |
saidaDoRetornoNFEletronica.codSnf | String | (Obrigatório) - String(003) - Código da série da nota fiscal de saída |
saidaDoRetornoNFEletronica.numNfv | String | (Obrigatório) - Number(009) - Número da nota fiscal de saída/RPS |
saidaDoRetornoNFEletronica.seqEve | String | - |
saidaDoRetornoNFEletronica.numDfs | String | (Opcional) - Number(016) - Número do documento fiscal de serviço - Condição: Obrigatório se TipDoc = 3(NFS-e). |
saidaDoRetornoNFEletronica.SegCba | String | (Obrigatório) - String(09) - Retornado o segundo código de barras na autorização em contingência FS-IA/FS-DA de NF-e ou CT-e (para CT-e apenas contingência FS-DA). |
saidaDoRetornoNFEletronica.chvDoe | String | (Obrigatório) - String(050) - Chave de acesso do documento eletrônico |
saidaDoRetornoNFEletronica.result | String | (Obrigatório) - String(250) - Retorno do processamento do documento eletrônico |
tipoRetorno | String | (Obrigatório) - Number(001) - Indicativo do tipo de retorno da solicitação - Lista: 1 = Processado com sucesso, 2 = Processado com erro |
mensagemRetorno | String | (Obrigatório) - String(250) - Mensagem de retorno do processamento |
Permite o recebimento eletrônicos dos seguintes tipos de arquivo:
- XML de Nota Fiscal Eletrônica (NF-e) - modelo: 55;
- XML de Conhecimento de Transporte (CT-e) - modelo: 57;
- XML de Conhecimento de Transporte Eletrônico para Outros Serviços (CT-e OS) - modelo: 67;
- XML de Nota Fiscal de Serviços Eletrônica (NFS-e);
- XML de Evento de Cancelamento de NF-e;
- XML de Evento de Cancelamento de CT-e;
- XML de Evento de Carta de Correção de NF-e;
- XML de Evento de Carta de Correção de CT-e.
Necessita autenticação: sim
Situação de versão: atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Receber> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <itensAProcessar> <seqItn>Integer</seqItn> <xmlItn>String</xmlItn> </itensAProcessar> </parameters> </ser:Receber> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
itensAProcessar | Set | |
itensAProcessar.seqItn | Integer | (Obrigatório) - Number - Sequência do item a ser processado |
itensAProcessar.xmlItn | String | (Obrigatório) - String - .XML do item a ser processado. O conteúdo do .XML deverá tratar os caracteres especiais de acordo com a tabela de códigos especiais de HTML. |
Importante
Uma das informações trazidas pelo parâmetro itensAProcessar é o CNPJ da filial de recebimento. Esse campo só considera filiais que estão configuradas no sistema como não consolidadoras.
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ReceberResponse> <result> <retornos> <seqItn>Integer</seqItn> <retorno>String</retorno> </retornos> <erroExecucao>String</erroExecucao> </result> </ser:ReceberResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
retornos | Set | |
retornos.seqItn | Integer | Number - Sequência do item processado |
retornos.retorno | String | String - Retorno do item processado. Irá retornar 'OK' se foi processado com sucesso ou a mensagem de erro do processamento. |
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Versão atual: 1.
Classe do sistema ERP que implementa a porta do web service: TSrEncerramentoManifestoEletronico.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:EncerramentoMDFe> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <DadosManifestos> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numEbq>Integer</numEbq> <codSma>Integer</codSma> <numMan>Integer</numMan> <numCgc>Integer</numCgc> <cepEnc>String</cepEnc> <ufsEnc>String</ufsEnc> </DadosManifestos> </parameters> </ser:EncerramentoMDFe> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
dadosManifestos | Integer | |
dadosManifestos.codEmp | Integer | Código da empresa |
dadosManifestos.codFil | Integer | Código da filial |
dadosManifestos.numEbq | Integer | Número do embarque |
dadosManifestos.codSma | Integer | Série |
dadosManifestos.numMan | Integer | Número do manifesto |
dadosManifestos.numCgc | Integer | |
dadosManifestos.cepEnc | String | (Opcional) - Number(008) - Cep da cidade de encerramento |
dadosManifestos.ufsEnc | String | (Opcional) - String(002) - UF de encerramento |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:EncerramentoMDFeResponse> <result> <RetornoManifestos> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numEbq>Integer</numEbq> <codSma>Integer</codSma> <numMan>Integer</numMan> <msgRet>Integer</msgRet> </RetornoManifestos> <erroExecucao>String</erroExecucao> </result> </ser:EncerramentoMDFeResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
retornoManifestos | Integer | |
retornoManifestos.codEmp | Integer | Código da empresa |
retornoManifestos.codFil | Integer | Código da filial |
retornoManifestos.numEbq | Integer | Número do embarque |
retornoManifestos.codSma | Integer | Série |
retornoManifestos.numMan | Integer | Número do manifesto |
retornoManifestos.msgRet | Integer | Mensagem de retorno |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:EmitirEventoComprovante> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <evento> <codEmp>Integer</codEmp> <codFIl>Integer</codFIl> <codSnf>String</codSnf> <numNfv>Integer</numNfv> <tipEve>Integer</tipEve> <datEve>DateTime</datEve> <horEve>Time</horEve> <datEnt>DateTime</datEnt> <horEnt>Time</horEnt> <docEnt>String</docEnt> <resRec>String</resRec> <latEnt>Integer</latEnt> <lonEnt>Integer</lonEnt> <imaEnt>String</imaEnt> <relSeq>Integer</relSeq> <tipGer>Integer</tipGer> </evento> </parameters> </ser:EmitirEventoComprovante> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
evento.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
evento.codFIl | Integer | Obrigatório) - Number(005) - Código da filial |
evento.codSnf | String | (Obrigatório) - String (003) - Série da nota fiscal de saída |
evento.numNfv | Integer | (Obrigatório) - Number(009) - Número da nota fiscal de saída |
evento.tipEve | Integer | (Obrigatório) - Number(006) - Tipo evento eletrônico gerado (110130 - Comprovante de Entrega da NF-e; 110131 - Cancelamento de Comprovante de Entrega da NF-e) |
evento.datEve | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data do Evento. |
evento.horEve | Time | (Obrigatório) - Number(005) - Hora do Evento. |
evento.datEnt | DateTime | (Opcional) - Date(DD/MM/YYYY) - Data da Entrega - Obrigatório quando tipEve = 110130 |
evento.horEnt | Time | (Opcional) - Number(005) - Hora da Entrega - Obrigatório quando tipEve = 110130 |
evento.docEnt | String | (Opcional) - String(99) - Número do Documento de identificação da pessoa que assinou o comprovante de entrega - Obrigatório quando tipEve = 110130 |
evento.resRec | String | (Opcional) - String(254) - Nome da pessoa que assinou o comprovante de entrega - Obrigatório quando tipEve = 110130 |
evento.latEnt | Integer | (Opcional) - Number(009,6) - Latitude da entrega - Opcional, utilizado quando tipEve = 110130 |
evento.lonEnt | Integer | (Opcional) - Number(009,6) - Longitude da entrega - Opcional, utilizado quando tipEve = 110130 |
evento.imaEnt | String | (Opcional) - String Base64 - Imagem em Base64 do comprovante de entrega - Obrigatório quando tipEve = 110130 |
evento.relSeq | Integer | (Opcional) - Number(004) - Sequencial do evento de comprovante de entrega da NF-e a ser cancelado - Obrigatório quando tipEve = 110131 |
evento.tipGer | Integer | (Obrigatório) - String(001) - Tipo da geração do comprovante (1 = Nada a fazer, 2 = De acordo a parametrização do software emissor NF-e da tela F070FVE) |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:EmitirEventoComprovanteResponse> <result> <retornoEvento> <tipoRetorno>Integer</tipoRetorno> <codEmp>Integer</codEmp> <codFIl>Integer</codFIl> <codSnf>String</codSnf> <numNfv>Integer</numNfv> <tipEve>Integer</tipEve> <seqEve>Integer</seqEve> <sitCce>Integer</sitCce> <msgRet>String</msgRet> <erroExecucao>String</erroExecucao> </retornoEvento> <erroExecucao>String</erroExecucao> </result> </ser:EmitirEventoComprovanteResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
retornoEvento | Set | - |
retornoEvento.tipoRetorno | Integer | (Obrigatório) - Number(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
retornoEvento.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
retornoEvento.codFIl | Integer | (Obrigatório) - Number(005) - Código da filial |
retornoEvento.codSnf | String | (Obrigatório) - String (003) - Série da nota fiscal de saída |
retornoEvento.numNfv | Integer | (Obrigatório) - Number(009) - Número da nota fiscal de saída |
retornoEvento.tipEve | Integer | (Obrigatório) - Number(006) - Tipo evento eletrônico gerado (110130 - Comprovante de Entrega e 110131 - Cancelamento de Comprovante) |
retornoEvento.seqEve | Integer | (Obrigatório) - Number(004) - Sequencial do evento eletrônico gerado (E140CCE.SeqEve) |
retornoEvento.sitCce | Integer | (Obrigatório) - Number(002) - (Obrigatório) - String(001) - Situação do evento eletrônico (0 = Não se aplica 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 9 = Cancelada; 10 = Erro Geração). |
retornoEvento.msgRet | String | (Obrigatório) - String(999) - Mensagem de retorno da requisição |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ConsultarEvento> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <evento> <codEmp>Integer</codEmp> <codFIl>Integer</codFIl> <codSnf>String</codSnf> <numNfv>Integer</numNfv> <tipEve>Integer</tipEve> <seqEve>Integer</seqEve> </evento> </parameters> </ser:ConsultarEvento> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
evento | Set | - |
evento.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
evento.codFIl | Integer | (Obrigatório) - Number(005) - Código da filial |
evento.codSnf | String | (Obrigatório) - String (003) - Série da nota fiscal de saída |
evento.numNfv | Integer | (Obrigatório) - Number(009) - Número da nota fiscal de saída |
evento.tipEve | Integer | (Obrigatório) - Number(006) - Tipo evento eletrônico gerado (110111 - Cancelamento; 110110 - Carta de Correção; 110150 - Ator interessado na NF-e – Transportador; 110130 - Comprovante de Entrega da NF-e; 110131 - Cancelamento de Comprovante de Entrega da NF-e) |
evento.seqEve | Integer | (Obrigatório) - Number(004) - Sequencial do evento do documento eletrônico no ERP (E140CCE.SeqEve) |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ConsultarEventoResponse> <result> <retornoEvento> <tipoRetorno>Integer</tipoRetorno> <codEmp>Integer</codEmp> <codFIl>Integer</codFIl> <codSnf>String</codSnf> <numNfv>Integer</numNfv> <tipEve>Integer</tipEve> <seqEve>Integer</seqEve> <sitCce>Integer</sitCce> <numPrt>String</numPrt> <datAut>DateTime</datAut> <horAut>Time</horAut> <msgRet>String</msgRet> <erroExecucao>String</erroExecucao> </retornoEvento> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarEventoResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
tipoRetorno | Integer | (Obrigatório) - Number(001) - Retorno da situação da execução do serviço (0 = Processado com sucesso; -1 = Processado com falhas) |
retornoEvento.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
retornoEvento.codFil | Integer | (Obrigatório) - Number(005) - Código da filial |
retornoEvento.codSnf | String | (Obrigatório) - String (003) - Série da nota fiscal de saída |
retornoEvento.numNfv | Integer | (Obrigatório) - Number(009) - Série da nota fiscal de saída |
retornoEvento.tipEve | Integer | (Obrigatório) - Number(006) - Tipo evento eletrônico gerado (110130 - Comprovante de Entrega e 110131 - Cancelamento de Comprovante) |
retornoEvento.seqEve | Integer | (Obrigatório) - Number(004) - Sequencial do evento eletrônico gerado (E140CCE.SeqEve) |
retornoEvento.sitCce | Integer |
(Obrigatório) - Number(002) - (Obrigatório) - String(001) - Situação do documento eletrônico Situações:
0 = Não se aplica; 1 = Não Enviada; 2 = Enviada; 3 = Autorizada; 4 = Rejeitada; 5 = Denegada; 6 = Solicitado Inutilização; 7 = Solicitado Cancelamento; 8 = Inutilizada; 9 = Cancelada; 10 = Erro Geração; 11 = Erro Solicitação Cancelamento; 12 = Erro Solicitação Inutilização; 13 = Pendente de Cancelamento; 16 = Autorizado em Contingência (utilizado apenas para retorno web service); 17= Evento registrado (evento pror. suspensão ICMS - utilizado apenas web service); 18 = Deferido parcial (evento pror. suspensão ICMS - utilizado apenas no web service); 19 = Indeferido (evento prorrogação suspensão ICMS - utilizado apenas no web service). |
retornoEvento.numPrt | String | Opcional - String(015) - Número do protocolo de autorização na SEFAZ |
retornoEvento.datAut | DateTime | (Opcional) - Date(DD/MM/YYYY) - Data do protocolo de autorização na SEFAZ |
retornoEvento.horAut | Integer | (Opcional) - Number(005) - Hora do protocolo de autorização na SEFAZ |
retornoEvento.msgRet | String | (Obrigatório) - String(999) - Mensagem de retorno da requisição |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |