Interface IDownloadServico
Esse serviço disponibiliza funcionalidades relacionadas ao download de XML e PDF dos documentos para outros sistemas.
Importante
Por padrão esse serviço será iniciado no caminho SDE/Download. Para maiores informações sobre a composição da URL dos webservices clique aqui
Métodos
BaixarPdf(String, String, Int32, String, Int32, List<Int32>)
Permite o download do PDF dos documentos auxiliares. Sempre gera um PDF novo com as configurações atuais (filtros de impressão, template, etc.) do sistema.
Serviço disponível apenas para os documentos: NF-e, CT-e, MDF-e, NFS-e, NFC-e e GNRE
Parâmetros
System.String
usuario
Usuário configurado na empresa para acesso ao webservice. |
System.String
senha
Senha configurada na empresa para acesso ao webservice. |
System.Int32
tipoDocumento
Tipo de documento que se deseja obter o PDF. Para valores aceitos ver TipoDocumentoEletronico. |
System.String
chave
Chave do documento que se deseja obter o PDF. |
System.Int32
tipoProcessamento
Tipo de processamento do documento que se deseja obter o PDF (1 - emissão e 2 - recebimento). |
System.Collections.Generic.List<System.Int32>
adicionais
Indica que PDFs adicionais se deseja gerar além do documento. Para valores aceitos ver TipoDocumentoAuxiliar. |
Retorno
IRetornoRequisicaoSde
|
Exemplos
Exemplo da requisição com PDFs adicionais:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soapenv:Header/>
<soapenv:Body>
<nfe:BaixarPdf>
<nfe:usuario>usuario</nfe:usuario>
<nfe:senha>senha</nfe:senha>
<nfe:tipoDocumento>1</nfe:tipoDocumento>
<nfe:chave>00000000000000000000000000000000000000000000</nfe:chave>
<nfe:tipoProcessamento>1</nfe:tipoProcessamento>
<nfe:adicionais>
<arr:int>2</arr:int>
</nfe:adicionais>
</nfe:BaixarPdf>
</soapenv:Body>
</soapenv:Envelope>
BaixarXml(String, String, Int32, String, Int64)
Permite o download do XML do documento com a chave
informada. Somente baixa documentos de Emissão, para download de documentos de Recebimento
utilizar o método BaixarXmlv2(String, String, Int64, Int32, Int32, String, Boolean, Boolean).
Serviço disponível apenas para os documentos: NF-e, NFC-e, NFS-e, CT-e, MDF-e e BlocoX
Parâmetros
System.String
usuario
Usuário configurado na empresa para acesso ao webservice. |
System.String
senha
Senha configurada na empresa para acesso ao webservice. |
System.Int32
tipoDocumento
Tipo de documento que se deseja baixar o XML. Para valores aceitos ver TipoDocumentoEletronico. |
System.String
chave
Chave/identificador do documento que se deseja baixar o XML. |
System.Int64
cnpjFilial
Documento da filial (obrigatório somente para o Bloco X). |
Retorno
IRetornoRequisicaoSde
|
Exemplos
Exemplo da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
<soapenv:Header/>
<soapenv:Body>
<nfe:BaixarXml>
<nfe:usuario>usuario</nfe:usuario>
<nfe:senha>senha</nfe:senha>
<nfe:tipoDocumento>1</nfe:tipoDocumento>
<nfe:chave>00000000000000000000000000000000000000000000</nfe:chave>
</nfe:BaixarXml>
</soapenv:Body>
</soapenv:Envelope>
BaixarXmlManifestacao(String, String, Int64, String, Int32, Boolean)
Permite o download do XML do documento com a chave
informada. Somente baixa documentos de Recebimento, para download de documentos de Emissão
utilizar o método BaixarXmlv2(String, String, Int64, Int32, Int32, String, Boolean, Boolean).
Para download de XMLs de NF-e caso o sistema não encontre a NF-e em base será gerada uma manifestação para a nota requisitada, isso permitirá o download posteriormente pela consulta de DF-e.
Serviço disponível apenas para os documentos: NF-e, NFC-e, NFS-e, NF3-e, CT-e, MDF-e e GNRE
Parâmetros
System.String
usuario
Usuário configurado na empresa para acesso ao webservice. |
System.String
senha
Senha configurada na empresa para acesso ao webservice. |
System.Int64
cnpjCpfFilial
CNPJ/CPF da filial vinculada ao documento, deve ser sempre o tomador/destinatário. |
System.String
chave
Chave/identificador do documento que se deseja baixar o XML. |
System.Int32
tipoDocumento
Tipo de documento que se deseja realizar o download. Para valores aceitos ver TipoDocumentoEletronico. |
System.Boolean
marcarRetorno
Indica ao sistema que ele deve alterar a situação de retorno dos documentos consultados. |
Retorno
IRetornoRequisicaoSde
|
Exemplos
Exemplo da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
<soapenv:Header/>
<soapenv:Body>
<nfe:BaixarXmlManifestacao>
<nfe:usuario>usuario</nfe:usuario>
<nfe:senha>senha</nfe:senha>
<nfe:cnpjCpfFilial>80680093000181</nfe:cnpjCpfFilial>
<nfe:chave>00000000000000000000000000000000000000000000</nfe:chave>
<nfe:tipoDocumento>1</nfe:tipoDocumento>
<nfe:marcarRetorno>true</nfe:marcarRetorno>
</nfe:BaixarXmlManifestacao>
</soapenv:Body>
</soapenv:Envelope>
BaixarXmlv2(String, String, Int64, Int32, Int32, String, Boolean, Boolean)
Expõe a mesma funcionalidade do método BaixarXml(String, String, Int32, String, Int64) com as seguintes funcionalidades a mais:
- Permite o download de XMLs de recebimento
- Caso seja realizado o download de uma NF-e de recebimento que não exista na base do sistema o parâmetro
gerarManifestacao
indica que o sistema deve gerar uma manifestação para essa nota. Com a manifestação gerada o sistema posteriormente realizará o download dessa nota via consulta de DF-e, permitindo o download dela.
Serviço disponível apenas para os documentos: NF-e, NFC-e, NF3-e, NFS-e, CT-e, MDF-e e BlocoX
Parâmetros
System.String
usuario
Usuário configurado na empresa para acesso ao webservice. |
System.String
senha
Senha configurada na empresa para acesso ao webservice. |
System.Int64
cnpjCpfFilial
CNPJ/CPF da filial vinculada ao documento, para um download de emissão deve ser a emissora do documento e para recebimento o tomador/destinatário. |
System.Int32
tipoDocumento
Tipo de documento que se deseja realizar o download. Para valores aceitos ver TipoDocumentoEletronico. |
System.Int32
tipoProcessamento
Tipo de processamento que se deseja realizar o download (1 - emissão e 2 - recebimento). |
System.String
chave
Chave/identificador do documento que se deseja baixar o XML. |
System.Boolean
gerarManifestacao
Somente usado para downloads de recebimento de NF-e. Indica ao sistema que caso ele não encontre a NF-e ele deve gerar uma manifestação para o documento, permitindo o download posteriormente pela consulta de DF-e. |
System.Boolean
marcarRetorno
Usado somente para recebimento, indica ao sistema que ele deve alterar a situação de retorno dos documentos consultados. |
Retorno
IRetornoRequisicaoSde
|
Exemplos
Exemplo da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
<soapenv:Header/>
<soapenv:Body>
<nfe:BaixarXmlv2>
<nfe:usuario>usuario</nfe:usuario>
<nfe:senha>senha</nfe:senha>
<nfe:cnpjCpfFilial>80680093000181</nfe:cnpjCpfFilial>
<nfe:tipoDocumento>1</nfe:tipoDocumento>
<nfe:tipoProcessamento>2</nfe:tipoProcessamento>
<nfe:chave>00000000000000000000000000000000000000000000</nfe:chave>
<nfe:gerarManifestacao>true</nfe:gerarManifestacao>
<nfe:marcarRetorno>true</nfe:marcarRetorno>
</nfe:BaixarXmlv2>
</soapenv:Body>
</soapenv:Envelope>
ConsultarRetornoRecebimento(String, String, Int32, Int64)
Consulta os documentos que estão pendentes de retorno de recebimento. Caso um evento de documento esteja pendente de retorno será retornado o identificador do documento para ser usado posteriormente para obter o evento.
Serviço disponível apenas para os documentos: NF-e, NFS-e, NF3-e, CT-e e CT-e OS
Parâmetros
System.String
usuario
Usuário configurado na empresa para acesso ao webservice. |
System.String
senha
Senha configurada na empresa para acesso ao webservice. |
System.Int32
tipoDocumento
Tipo de documento que se deseja consultar os retornos pendentes. Para valores aceitos ver TipoDocumentoEletronico. |
System.Int64
documentoFilial
CNPJ/CPF da filial vinculada aos documentos que se deseja consultar. Essa filial deve ser sempre o tomador/destinatário dos documentos. |
Retorno
IRetornoRequisicaoSde
|
Exemplos
Exemplo da requisição com PDFs adicionais:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
<soapenv:Header/>
<soapenv:Body>
<nfe:ConsultarRetornoRecebimento>
<nfe:usuario>usuario</nfe:usuario>
<nfe:senha>senha</nfe:senha>
<nfe:tipoDocumento>1</nfe:tipoDocumento>
<nfe:documentoFilial>99999999000191</nfe:documentoFilial>
</nfe:ConsultarRetornoRecebimento>
</soapenv:Body>
</soapenv:Envelope>
RequisitarGeracaoPdfLote(String, String, Int32, Int32, IList<FiltroProcessamento>)
Gera um PDF agrupado de todos os documentos que atendem aos filtros
informados. Esse PDF será gerado em segundo plano pelo sistema e será acessível pela URL
(url_do_monitor)/(instalacao)/DocumentoAuxiliar/DownloadDocumento.ashx?IdSegundoPlano=(idSegundoPlanoGerado). O idSegundoPlanoGerado
da URL será retornado caso a requisição seja finalizada com sucesso.
Serviço disponível apenas para os documentos: NF-e e CT-e
Parâmetros
System.String
usuario
Usuário configurado na empresa para acesso ao webservice. |
System.String
senha
Senha configurada na empresa para acesso ao webservice. |
System.Int32
tipoDocumento
Tipo de documento que se deseja obter o PDF. Para valores aceitos ver TipoDocumentoEletronico. |
System.Int32
tipoProcessamento
Tipo de processamento do documento que se deseja obter o PDF (1 - emissão e 2 - recebimento). |
System.Collections.Generic.IList<FiltroProcessamento>
filtros
Filtros que identificam quais documentos devem ser incluídos no PDF agrupado. |
Retorno
IRetornoRequisicaoSde
|
Exemplos
Exemplo da requisição com PDFs adicionais:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe" xmlns:sen="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Serializacao.Documento.Filtros" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soapenv:Header/>
<soapenv:Body>
<nfe:RequisitarGeracaoPdfLote>
<nfe:usuario>a</nfe:usuario>
<nfe:senha>senha</nfe:senha>
<nfe:tipoDocumento>1</nfe:tipoDocumento>
<nfe:tipoProcessamento>1</nfe:tipoProcessamento>
<nfe:filtros>
<sen:FiltroProcessamento>
<sen:Chave>
<arr:string>00000000000000000000000000000000000000000000</arr:string>
<arr:string>11111111111111111111111111111111111111111111</arr:string>
</sen:Chave>
<sen:Documento>
<sen:FiltroDocumento>
<sen:CnpjFilial>80680093000181</sen:CnpjFilial>
<sen:SerieNumero>
<sen:FiltroSerieNumero>
<sen:NumeroFinal>1</sen:NumeroFinal>
<sen:NumeroInicial>10</sen:NumeroInicial>
<sen:SerieFinal>100</sen:SerieFinal>
<sen:SerieInicial>150</sen:SerieInicial>
</sen:FiltroSerieNumero>
</sen:SerieNumero>
</sen:FiltroDocumento>
</sen:Documento>
</sen:FiltroProcessamento>
</nfe:filtros>
</nfe:RequisitarGeracaoPdfLote>
</soapenv:Body>
</soapenv:Envelope>