Senior.SapiensNfe.DataAccess.Dados.Documento
| Classes | Interfaces |
| CriticaIntegracaoRetorno | IConfiguracaoServico |
| DadosFilial | IDownloadServico |
| IEnvioEmailServico | |
| IImpressaoRemotaServico | |
| IIntegracaoDocumento | |
| IUploadServico |
Classes
CriticaIntegracaoRetorno
Modelo de retorno para críticas de integração.
| Propriedades | Tipo | Descrição |
| Chave | System.String | Chave/Identificador do documento integrado. |
| DocumentoFilial | System.Int64 | Documento da filial vinculada a crítica. |
| TipoDocumentoFilial | System.Int32 | Tipo de documento da filial. |
| DocumentoEmissor | System.Nullable<System.Int64> | Documento do emissor/empregador da crítica. Somente será preenchido para críticas de documentos que utilizam a estrutura de emissores/outorgados (por exemplo eSocial). |
| TipoDocumento | System.Int32 | Tipo de documento da crítica. |
| TipoAmbiente | System.Int32 | Tipo de ambiente do sistema. |
| Critica | System.String | Mensagem da crítica. |
| Data | System.String | Data de ocorrência da crítica. Retornará no formato yyyy-MM-ddTHH:mm:ss exemplo: 2018-08-25T18:45:30. |
| Identificador | System.String | Identificador informado na integração por webservice do documento. |
DadosFilial
Dados para criação/alteração de uma filial.
| Propriedades | Tipo | Descrição |
| TipoConfiguracao | System.Nullable<System.Int32> | Tipo da configuração. Ver TipoConfiguracaoWebservice para valores aceitos.
(*) |
| Documento | System.Int64 | Documento (CNPJ/CPF) da filial. |
| TipoDocumento | System.Int32 | Tipo de documento da filial. Para valores aceitos ver TipoDocumentoEmissor. |
| Nome | System.String | Nome da filial. Obrigatório no primeiro cadastro de uma filial, opcional em alterações de configuração. |
| Codigo | System.String | Código da filial. Opcional, usado somente para buscas dentro do Monitor do sistema. |
| Estado | System.Nullable<System.Int32> | Código do estado da filial, utilizar os códigos da tabela IBGE. Obrigatório no primeiro cadastro de uma filial, opcional em alterações de configuração. |
| Municipio | System.Nullable<System.Int32> | Código do município da filial. Utilizar códigos da tabela IBGE, informando todos os 7 dígitos. Obrigatório no primeiro cadastro de uma filial, opcional em alterações de configuração. |
| Parametros | System.Collections.Generic.List<Senior.Core.Modelo.Serializacao.ParChaveValor<System.String, System.String>> | Par chave/valor dos parâmetros da filial, a chave deve ser sempre o identificador do parâmetro (ver TipoParametroFilial para valores aceitos) e o valor a configuração desejada para esse parâmetro. |
| Logotipo | System.Byte[] | Logotipo da filial. (*) |
| Certificado | Certificado | Certificado digital da filial. (*) |
| InscricoesMunicipais | System.Collections.Generic.List<InscricaoMunicipal> | Inscrições municipais da filial. (*) |
| Emissores | System.Collections.Generic.List<Emissor> | Emissores da filial. (*) |
| FiltrosImpressao | System.Collections.Generic.List<FiltroImpressao> | Filtros de impressão da filial. (*) |
| ContingenciasAutomaticas | System.Collections.Generic.List<ContingenciaAutomatica> | Contingências automáticas da filial. (*) |
| ParametrosMunicipio | System.Collections.Generic.List<ParametroMunicipio> | Parâmetros por município da filial. (*) |
| TemplatesRelatorio | System.Collections.Generic.List<TemplateRelatorio> | Templates customizados da filial. (*) |
IMPORTANTE
Propriedade para uso interno do sistema. Não é recomendada a utilização por outros sistemas.
Interfaces
IConfiguracaoServico
Esse serviço disponibiliza funcionalidades relacionadas a configuração do eDocs para outros sistemas.
Importante
Por padrão esse serviço será iniciado no caminho SDE/Configuracao. Para maiores informações sobre a composição da URL dos webservices clique aqui.
Métodos
ConfigurarFilial(String, String, DadosFilial)
Configura uma nova filial ou realiza alterações em uma filial existente.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurado na empresa para acesso ao webservice. |
| dados | DadosFilial | Dados para configuração da filial. |
Retorno
IRetornoRequisicaoSde
Sempre retornará uma instância de RetornoIntegracaoGenerico tanto em casos de sucesso quanto erro.
Exemplo da requisição SOAP:
<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.Dados.Documento" xmlns:sen1="http://schemas.datacontract.org/2004/07/Senior.Core.Modelo.Serializacao">
<soapenv:Header/>
<soapenv:Body>
<nfe:ConfigurarFilial>
<nfe:usuario>sde</nfe:usuario>
<nfe:senha>sde</nfe:senha>
<nfe:dados>
<sen:Documento>22222222000191</sen:Documento>
<sen:TipoDocumento>1</sen:TipoDocumento>
<sen:Nome>A2</sen:Nome>
<sen:Codigo>a2</sen:Codigo>
<sen:InscricaoMunicipal>ISENTO</sen:InscricaoMunicipal>
<sen:Estado>35</sen:Estado>
<sen:Municipio>3520509</sen:Municipio>
<sen:Parametros>
<sen1:ParChaveValor>
<sen1:Chave>TIPO_INTEGRACAO_SAIDA</sen1:Chave>
<sen1:Valor>0</sen1:Valor>
</sen1:ParChaveValor>
<sen1:ParChaveValor>
<sen1:Chave>TIPO_INTEGRACAO_ENTRADA</sen1:Chave>
<sen1:Valor>D</sen1:Valor>
</sen1:ParChaveValor>
<sen1:ParChaveValor>
<sen1:Chave>PASTA_INTEGRACAO</sen1:Chave>
<sen1:Valor>c:\umdiretorio</sen1:Valor>
</sen1:ParChaveValor>
</sen:Parametros>
</nfe:dados>
</nfe:ConfigurarFilial>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de uma resposta de erro:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ConfigurarFilialResponse xmlns="http://www.senior.com.br/nfe">
<ConfigurarFilialResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Codigo>999</Codigo>
<Mensagem>Usuário e/ou senha incorretos.</Mensagem>
<Sucesso>false</Sucesso>
</ConfigurarFilialResult>
</ConfigurarFilialResponse>
</s:Body>
</s:Envelope>
Exemplo de resposta de uma requisição finalizada com sucesso:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ConfigurarFilialResponse xmlns="http://www.senior.com.br/nfe">
<ConfigurarFilialResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Sucesso>true</Sucesso>
</ConfigurarFilialResult>
</ConfigurarFilialResponse>
</s:Body>
</s:Envelope>
ConsultarAmbiente(String, String)
Consulta informações gerais do ambiente como versão, tipo de ambiente que está em execução, etc.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurado na empresa para acesso ao webservice. |
Retorno
- Em caso de erros será retornado uma instância de RetornoIntegracaoGenerico com a mensagem e código indicando o que ocorreu
- Em caso de sucesso será retornado uma instância de DadosAplicacao com os dados da aplicação disponibilizados nesse tipo
Exemplo da requisição SOAP:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
<soapenv:Header/>
<soapenv:Body>
<nfe:ConsultarAmbiente>
<nfe:usuario>usuario</nfe:usuario>
<nfe:senha>senha</nfe:senha>
</nfe:ConsultarAmbiente>
</soapenv:Body>
</soapenv:Envelope>
Exemplo de uma resposta de erro:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ConsultarAmbienteResponse xmlns="http://www.senior.com.br/nfe">
<ConsultarAmbienteResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Codigo>10014</Codigo>
<Mensagem>Usuário e/ou senha incorretos.</Mensagem>
<Sucesso>false</Sucesso>
</ConsultarAmbienteResult>
</ConsultarAmbienteResponse>
</s:Body>
</s:Envelope>
Exemplo de resposta de uma requisição finalizada com sucesso:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ConsultarAmbienteResponse xmlns="http://www.senior.com.br/nfe">
<ConsultarAmbienteResult i:type="DadosAplicacao" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Mensagem i:nil="true"/>
<NomeAmbiente>Nome</NomeAmbiente>
<Sucesso>true</Sucesso>
<TipoAmbiente>2</TipoAmbiente>
<VersaoAmbiente>5.8.11.90</VersaoAmbiente>
</ConsultarAmbienteResult>
</ConsultarAmbienteResponse>
</s:Body>
</s:Envelope>
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 mais informações sobre a composição da URL dos webservices, consulte a documentação correspondente.
Métodos
- BaixarPDF
- BaixarXml
- BaixarXmlManifestacao
- BaixarXmlv2
- ConsultarRetornoRecebimento
- RequisitarGeracaoPdfLote
BaixarPdf(String, String, Int32, String, Int32, List<Int32>)
Permite o download do PDF dos documentos auxiliares. Sempre gera um novo PDF com base nas configurações atuais do sistema.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento que se deseja obter o PDF. Para valores aceitos ver TipoDocumentoEletronico. |
| chave | System.String | Chave do documento que se deseja obter o PDF. Para o modelo ABRASF, a chave deve ser enviada com o prefixo ID, seguido do número da chave. Já para o modelo Padrão Nacional de NFS-e, a chave deve ser enviada com o prefixo DPS, seguido do número da chave. |
| tipoProcessamento | System.Int32 | Tipo de processamento do documento que se deseja obter o PDF (1 - emissão e 2 - recebimento). |
| adicionais | System.Collections.Generic.List<System.Int32>adicionais | Indica que PDFs adicionais se deseja gerar além do documento. Para valores aceitos ver TipoDocumentoAuxiliar. |
Retorno
- Caso ocorra algum erro que impeça o sistema de baixar o XML será retornado uma instância de RetornoIntegracaoGenerico com mensagem e código de erro.
- Caso o sistema consiga obter o(s) PDF(s) será retornada uma instância de RetornoDownload com uma das tags Pdf ou Pdfs preenchida, dependendo se foi requisitado algum PDF adicional pelo parâmetro 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>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<BaixarPdfResponse xmlns="http://www.senior.com.br/nfe">
<BaixarPdfResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Codigo>10014</Codigo>
<Mensagem>Usuário e/ou senha incorretos.</Mensagem>
<Sucesso>false</Sucesso>
</BaixarPdfResult>
</BaixarPdfResponse>
</s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<BaixarPdfResponse xmlns="http://www.senior.com.br/nfe">
<BaixarPdfResult i:type="RetornoDownload" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Pdf>base64 do PDF</Pdf>
<Sucesso>true</Sucesso>
</BaixarPdfResult>
</BaixarPdfResponse>
</s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<BaixarPdfResponse xmlns="http://www.senior.com.br/nfe">
<BaixarPdfResult i:type="RetornoDownload" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Pdfs>
<PdfRetorno>
<Conteudo>base64 do PDF do documento principal</Conteudo>
<TipoDocumentoAuxiliar>1</TipoDocumentoAuxiliar>
</PdfRetorno>
<PdfRetorno>
<Conteudo>base64 do PDF do boleto da GNRE</Conteudo>
<TipoDocumentoAuxiliar>2</TipoDocumentoAuxiliar>
</PdfRetorno>
</Pdfs>
<Sucesso>true</Sucesso>
</BaixarPdfResult>
</BaixarPdfResponse>
</s:Body>
</s: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, NF3-e, NFS-e, NFTS, NFCom, DC-e, CT-e, MDF-e e BlocoX.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento que se deseja baixar o XML. Para valores aceitos ver TipoDocumentoEletronico. |
| chave | System.String | Chave/identificador do documento que se deseja baixar o XML. Para o modelo ABRASF, a chave deve ser enviada com o prefixo ID, seguido do número da chave. Já para o modelo Padrão Nacional de NFS-e, a chave deve ser enviada com o prefixo DPS, seguido do número da chave. |
| cnpjFilial | System.Int64 | Documento da filial (obrigatório somente para o Bloco X). |
| cnpjFilialAlfaNumerico | System.String | Documento da filial (obrigatório somente para o Bloco X) em formato alfanumérico. |
Retorno
- Caso ocorra algum erro que impeça o sistema de baixar o XML será retornado uma instância de RetornoIntegracaoGenerico com mensagem e código de erro.
- Caso o sistema consiga obter os XMLs será retornada uma instância de RetornoDownload com os XMLs do documento informado
<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>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<BaixarXmlResponse xmlns="http://www.senior.com.br/nfe">
<BaixarXmlResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Codigo>10014</Codigo>
<Mensagem>Usuário e/ou senha incorretos.</Mensagem>
<Sucesso>false</Sucesso>
</BaixarXmlResult>
</BaixarXmlResponse>
</s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<BaixarXmlResponse xmlns="http://www.senior.com.br/nfe">
<BaixarXmlResult i:type="RetornoDownload" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Sucesso>true</Sucesso>
<Xmls xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:string>conteudo do XML em base64</a:string>
<a:string>conteudo do segundo XML em base64</a:string>
</Xmls>
</BaixarXmlResult>
</BaixarXmlResponse>
</s:Body>
</s:Envelope>
BaixarXmlManifestacao(String, String, Int64, String, Int32, Boolean)
Permite o download do XML do documento com a chave informada. Realiza o download apenas de documentos de Recebimento; para documentos de Emissão, deve-se 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 localize o documento na base, será gerada automaticamente uma manifestação para a nota requisitada, possibilitando o download posteriormente por meio da 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
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| cnpjCpfFilial | System.Int64 | CNPJ/CPF da filial vinculada ao documento, correspondente ao tomador/destinatário. |
| chave | System.String | Chave/identificador do documento que se deseja baixar o XML. |
| tipoDocumento | System.Int32 | Tipo de documento para o qual se deseja realizar o download. Para valores aceitos, consultar TipoDocumentoEletronico. |
| marcarRetorno | System.Boolean | Indica se o sistema deve atualizar a situação de retorno dos documentos consultados. |
| cnpjFilialAlfaNumerico | System.String | CNPJ/CPF da filial, em formato alfanumérico, vinculada ao documento, deve ser sempre o tomador/destinatário. |
Retorno
- Caso ocorra algum erro que impeça o sistema de baixar o XML será retornado uma instância de RetornoIntegracaoGenerico com mensagem e código de erro.
- Caso o sistema consiga obter os XMLs será retornada uma instância de RetornoDownload com os XMLs do documento informado.
<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>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <BaixarXmlManifestacaoResponse xmlns="http://www.senior.com.br/nfe"> <BaixarXmlManifestacaoResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </BaixarXmlManifestacaoResult> </BaixarXmlManifestacaoResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <BaixarXmlManifestacaoResponse xmlns="http://www.senior.com.br/nfe"> <BaixarXmlManifestacaoResult i:type="RetornoDownload" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> <Xmls xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>conteudo do XML em base64</a:string> <a:string>conteudo do outro XML em base64</a:string> </Xmls> </BaixarXmlManifestacaoResult> </BaixarXmlManifestacaoResponse> </s:Body> </s:Envelope>
BaixarXmlv2(String, String, Int64, Int32, Int32, String, Boolean, Boolean)
Expõe a mesma funcionalidade do método BaixarXml(String, String, Int32, String, Int64), incluindo recursos adicionais.
- Permite o download de XMLs de documentos 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, possibilitando o download posteriormente por meio da consulta de DF-e.
Serviço disponível apenas para os documentos: NF-e, NFC-e, NF3-e, NFS-e, NFTS, NFCom, DC-e, CT-e, MDF-e e BlocoX.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| cnpjCpfFilial | System.Int64 | CNPJ/CPF da filial vinculada ao documento. Para download de emissão, deve ser o emissor do documento; para recebimento, o tomador/destinatário. |
| tipoDocumento | System.Int32 | Tipo de documento que se deseja realizar o download. Para valores aceitos, consultar TipoDocumentoEletronico. |
| tipoProcessamento | System.Int32 | Tipo de processamento do download (1 - emissão e 2 - recebimento). |
| chave | System.String | Chave/identificador do documento que se deseja baixar o XML. |
| gerarManifestacao | System.Boolean | Utilizado apenas para downloads de recebimento de NF-e. Indica que, caso o documento não seja localizado, o sistema deve gerar uma manifestação para permitir o download posterior via DF-e. |
| marcarRetorno | System.Boolean | Utilizado apenas para recebimento. Indica se o sistema deve atualizar a situação de retorno dos documentos consultados. |
| cnpjFilialAlfaNumerico | System.String | CNPJ/CPF da filial, em formato alfanumérico, vinculada ao documento, para um download de emissão deve ser a emissora do documento e para recebimento o tomador/destinatário. |
Retorno
- Caso ocorra alguma situação que impeça o download do XML, será retornada uma instância de RetornoIntegracaoGenerico com mensagem e código.
- Caso o sistema consiga obter os XMLs, será retornada uma instância de RetornoDownload com os XMLs do documento informado.
<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>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <BaixarXmlv2Response xmlns="http://www.senior.com.br/nfe"> <BaixarXmlv2Result i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </BaixarXmlv2Result> </BaixarXmlv2Response> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <BaixarXmlv2Response xmlns="http://www.senior.com.br/nfe"> <BaixarXmlv2Result i:type="RetornoDownload" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> <Xmls xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>conteudo do XML em base64</a:string> <a:string>conteudo do segundo XML em base64</a:string> </Xmls> </BaixarXmlv2Result> </BaixarXmlv2Response> </s:Body> </s: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 utilizado posteriormente na obtenção do evento.
Serviço disponível apenas para os documentos: NF-e, NFS-e, NF3-e, CT-e e CT-e OS.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento que se deseja consultar os retornos pendentes. Para valores aceitos, consultar TipoDocumentoEletronico. |
| documentoFilial | System.Int64 | CNPJ/CPF da filial vinculada aos documentos a serem consultados. Essa filial deve ser sempre o tomador/destinatário dos documentos. |
| limiteMaxRegistros | System.String | Limite máximo de registros a serem retornados. |
| documentoFilialAlfaNumerico | System.String | CNPJ/CPF da filial, em formato alfanumérico, vinculada aos documentos que se deseja consultar. Essa filial deve ser sempre o tomador/destinatário dos documentos. |
Retorno
- Caso ocorra alguma situação que impeça a consulta dos documentos pendentes de retorno, será retornada uma instância de RetornoIntegracaoGenerico com mensagem e código.
- Caso o sistema consiga consultar os documentos, será retornada uma instância de PendenteRetorno com os dados dos documentos pendentes.
<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>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarRetornoRecebimentoResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarRetornoRecebimentoResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </ConsultarRetornoRecebimentoResult> </ConsultarRetornoRecebimentoResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarRetornoRecebimentoResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarRetornoRecebimentoResult i:type="PendenteRetorno" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Documentos> <ItemPendenteRetorno> <Chave>00000000000000000000000000000000000000000000</Chave> <TipoDocumento>1</TipoDocumento> </ItemPendenteRetorno> <ItemPendenteRetorno> <Chave>ID1101112222222222222222222222222222222222222222222222</Chave> <TipoDocumento>1</TipoDocumento> <TipoEvento>110111</TipoEvento> </ItemPendenteRetorno> </Documentos> <Sucesso>true</Sucesso> </ConsultarRetornoRecebimentoResult> </ConsultarRetornoRecebimentoResponse> </s:Body> </s:Envelope>
RequisitarGeracaoPdfLote(String, String, Int32, Int32, IList<FiltroProcessamento>)
Gera um PDF agrupado de todos os documentos que atendem aos filtros informados.
O PDF é gerado em segundo plano pelo sistema e pode ser acessado por meio da URL: (url_do_monitor)/(instalacao)/DocumentoAuxiliar/DownloadDocumento.ashx?IdSegundoPlano=(idSegundoPlanoGerado).
O identificador do processamento em segundo plano será retornado ao final da requisição quando concluída com sucesso.
Serviço disponível apenas para os documentos: NF-e e CT-e.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento que se deseja obter o PDF. Para valores aceitos, consultar TipoDocumentoEletronico. |
| tipoProcessamento | System.Int32 | Tipo de processamento do documento (1 - emissão e 2 - recebimento). |
| filtros | System.Collections.Generic.IList<FiltroProcessamento> | Filtros que identificam quais documentos devem ser incluídos no PDF agrupado. |
Retorno
- Caso ocorra alguma situação que impeça a geração do processamento em segundo plano, será retornada uma instância de RetornoIntegracaoGenerico com mensagem e código.
- Caso o sistema consiga gerar o processamento, será retornada uma instância de RetornoIntegracaoGenerico o campo Sucesso igual a true e o campo Mensagem contendo o identificador do segundo plano gerado.
<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>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <RequisitarGeracaoPdfLoteResponse xmlns="http://www.senior.com.br/nfe"> <RequisitarGeracaoPdfLoteResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </RequisitarGeracaoPdfLoteResult> </RequisitarGeracaoPdfLoteResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <RequisitarGeracaoPdfLoteResponse xmlns="http://www.senior.com.br/nfe"> <RequisitarGeracaoPdfLoteResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Mensagem>2</Mensagem> <Sucesso>true</Sucesso> </RequisitarGeracaoPdfLoteResult> </RequisitarGeracaoPdfLoteResponse> </s:Body> </s:Envelope>
IEnvioEmailServico
Esse serviço disponibiliza funcionalidades relacionadas ao envio de e-mail.
Importante
Por padrão esse serviço será iniciado no caminho SDE/Email. Para maiores informações sobre a composição da URL dos webservices clique aqui.
Métodos
ConsultarSituacaoEnvioEmail(String, String, Int32, Int32, String)
Consulta a situação de envio de e-mail de um determinado documento.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento a ser consultado. Para valores aceitos, consultar TipoDocumentoEletronico. |
| tipoOperacao | System.Int32 | Indica se o e-mail consultado refere-se a documento ou evento. Valores suportados: 1 - Emissão e 72 - Carta de correção. |
| chave | System.String | Chave/identificador do documento a ser consultado. |
Retorno
Em caso de erro o campo Sucesso estará com o valor false e serão retornados um código e mensagem de erro. Caso o sistema consiga consultar a situação de envio de e-mail do documento o campo Sucesso será retornado com o valor true e o campo Codigo irá indicar a a situação de e-mail do documento por um dos seguintes códigos:
- 10000,
- 10001,
- 10002
- 10003
- 10004.
Para consultar os códigos de retorno do sistema clique aqui.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe"> <soapenv:Header/> <soapenv:Body> <nfe:ConsultarSituacaoEnvioEmail> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:tipoDocumento>1</nfe:tipoDocumento> <nfe:tipoOperacao>1</nfe:tipoOperacao> <nfe:chave>00000000000000000000000000000000000000000000</nfe:chave> </nfe:ConsultarSituacaoEnvioEmail> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarSituacaoEnvioEmailResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarSituacaoEnvioEmailResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </ConsultarSituacaoEnvioEmailResult> </ConsultarSituacaoEnvioEmailResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarSituacaoEnvioEmailResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarSituacaoEnvioEmailResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10002</Codigo> <Mensagem>Somente alguns e-mails vinculados ao documento ou evento foram enviados com sucesso.</Mensagem> <Sucesso>true</Sucesso> </ConsultarSituacaoEnvioEmailResult> </ConsultarSituacaoEnvioEmailResponse> </s:Body> </s:Envelope>
MarcarEnvioEmail(String, String, Int32, Int32, String, IList<String>, Boolean, List<Arquivo>, String)
Permite a marcação de envio de e-mail para um determinado documento no sistema.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento que será utilizado no envio do e-mail. Para valores aceitos, consultar TipoDocumentoEletronico. |
| tipoOperacao | System.Int32 | Indica se o e-mail refere-se a um documento ou evento. Valores suportados: 1 - Emissão e 72 - Carta de correção. |
| chave | System.String | Chave/identificador do documento relacionado ao envio do e-mail. |
| enderecosEnvio | System.Collections.Generic.IList<System.String> | Lista de endereços de e-mail que devem receber o envio. |
| enviarBoleto | System.Boolean | Indica se o boleto deve ser enviado junto ao documento. Disponível apenas para NF-e, NFS-e e CT-e. |
| arquivos | System.Collections.Generic.List<Arquivo> | Lista de arquivos adicionais que serão enviados por e-mail. |
| conteudoAdicional | System.String | Conteúdo adicional incluído ao final do corpo do e-mail. Essa informação não será enviada caso o e-mail seja destinado à transportadora. |
Retorno
IRetornoRequisicaoSde
Sempre será retornada uma instância de RetornoIntegracaoGenerico, em caso de erro o campo Sucesso estará com o valor false e serão retornados um código e mensagem de erro. Caso o sistema consiga marcar o envio de e-mail para o documento o campo Sucesso estará com o valor true.
<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:MarcarEnvioEmail> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:tipoDocumento>1</nfe:tipoDocumento> <nfe:tipoOperacao>1</nfe:tipoOperacao> <nfe:chave>00000000000000000000000000000000000000000000</nfe:chave> <nfe:enderecosEnvio> <arr:string>teste@senior.com.br</arr:string> </nfe:enderecosEnvio> <nfe:enviarBoleto>true</nfe:enviarBoleto> </nfe:MarcarEnvioEmail> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <MarcarEnvioEmailResponse xmlns="http://www.senior.com.br/nfe"> <MarcarEnvioEmailResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </MarcarEnvioEmailResult> </MarcarEnvioEmailResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <MarcarEnvioEmailResponse xmlns="http://www.senior.com.br/nfe"> <MarcarEnvioEmailResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> </MarcarEnvioEmailResult> </MarcarEnvioEmailResponse> </s:Body> </s:Envelope>
IImpressaoRemotaServico
Esse serviço disponibiliza funcionalidades relacionadas a impressão de documentos.
Importante
Por padrão esse serviço será iniciado no caminho SDE/Impressão. Para maiores informações sobre a composição da URL dos webservices clique aqui.
Métodos
Imprimir(String, String, Int32, String)
Tenta enviar o documento com a chave informada para impressão.
A operação será realizada apenas se o documento existir e estiver em uma situação que permita a impressão.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento a ser impresso. Para valores aceitos, consultar TipoDocumentoEletronico. |
| chaveDocumento | System.String | Chave/identificador do documento a ser impresso. |
Retorno
Sempre será retornado uma instância de RetornoIntegracaoGenerico, em caso de erro o campo Sucesso estará com o valor false e serão retornados um código e mensagem de erro. Caso o sistema consiga imprimir o documento o campo Sucesso estará com o valor true.
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:Imprimir> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:tipoDocumento>1</nfe:tipoDocumento> <nfe:chaveDocumento>00000000000000000000000000000000000000000000</nfe:chaveDocumento> </nfe:Imprimir> </soapenv:Body> </soapenv:Envelope>
Exemplo da resposta com algum erro na requisição:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ImprimirResponse xmlns="http://www.senior.com.br/nfe"> <ImprimirResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </ImprimirResult> </ImprimirResponse> </s:Body> </s:Envelope>
Exemplo da resposta quando o documento é enviado para impressão:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ImprimirResponse xmlns="http://www.senior.com.br/nfe"> <ImprimirResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> </ImprimirResult> </ImprimirResponse> </s:Body> </s:Envelope>
IIntegracaoDocumento
Esse serviço disponibiliza funcionalidades relacionadas a integração e consulta de documentos no sistema.
Importante
Por padrão esse serviço será iniciado no caminho SDE/Integração. Para maiores informações sobre a composição da URL dos webservices clique aqui.
Métodos
- AutorizarDocumento
- ConfigurarFilial
- ConsultaBlocoX
- ConsultarCadastroContribuinte
- ConsultarSituacaoDocumentos
- ConsultarTipoEmissao
- ConsultarTipoEmissaoV2
- IntegrarDocumentos
- IntegrarDocumentosIdentificacao
- IntegrarDocumentosIdentificacaoOrigem
- MarcarRetorno
- ObterCriticasIntegracao
- ObterCriticasPorIdentificador
- ObterMensagensSat
- RequisitarConsultaDocumento
AutorizarDocumento(String, String, Int64, String, String, List<Arquivo>, Nullable<Boolean>)
Tenta emitir o documento informado, se o documento não suportar emissão síncrona será somente realizada a integração e retornará o resultado de acordo, sem tentar realizar nenhum envio a entidade autorizadora.
- A integração de CF-e somente é disponibilizada no cliente remoto do eDocs. Como não temos acesso ao banco de dados no cliente as informações disponibilizadas no retorno desses documentos será mais limitada.
- A integração de Recintos aduaneiros utiliza um XML para encapsular o JSON dos recintos, um exemplo desse XML pode ser encontrado no Integração de recintos aduaneiros.
- Os tipos de operação para a integração dos vários eventos de recintos são os seguintes:
- 113 - Credenciamento de veículo
- 114 - Credenciamento de pessoa
- 115 - Acesso de veículo
- 116 - Acesso de pessoa
- 136 - Evento de Georreferenciamento
- 137 - Indisponibilidade de Equipamento
- 139 - Acesso de Representantes
Para eventos de CT-e e MDF-e a resposta será assíncrona, ou seja, é necessária uma consulta posterior para obter o resultado.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| cnpjFilial | System.Int64 | CNPJ da filial que ficará vinculada aos documentos no sistema. No caso documentos que usam a estrutura de emissores/outorgados deve ser a filial vinculada ao emissor/outorgado do documento. |
| xml | System.String | XML do documento a ser emitido. |
| identificacaoGerador | System.String | Valor única gerado pelo emissor do documento, esse valor será retornado em consultas. |
| arquivos | System.Collections.Generic.List<Arquivo> | Arquivos adicionais integrados junto ao documento. Atualmente são anexados no envio de e-mail após a autorização do documento. |
| ativarEnvioEmail | System.Nullable<System.Boolean> | Indica se deve enviar o email ao emitir o documento. |
Retorno
- Em casos de erro na requisição retornará sempre uma instância de SituacaoDocumento com o código e mensagem de erro
- Em casos de rejeição pode retornar tanto uma instância de RetornoIntegracaoGenerico quanto SituacaoDocumento dependendo do tipo de documento enviado. O tipo do retorno será sempre o mesmo para rejeições de um determinado tipo de documento, mudando somente para tipos de documento diferentes
- Em casos de autorização retornará sempre uma instância de SituacaoDocumento com os dados de autorização do documento
<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"> <soapenv:Header/> <soapenv:Body> <nfe:AutorizarDocumento> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:cnpjFilial>80680093000181</nfe:cnpjFilial> <nfe:xml><![CDATA[conteudo do XML]]></nfe:xml> <nfe:identificacaoGerador>ERP Senior</nfe:identificacaoGerador> <nfe:arquivos> <sen:Arquivo> <sen:Conteudo>conteudo do arquivo em base64</sen:Conteudo> <sen:Nome>teste.txt</sen:Nome> </sen:Arquivo> </nfe:arquivos> </nfe:AutorizarDocumento> </soapenv:Body> </soapenv:Envelope>
<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"> <soapenv:Header/> <soapenv:Body> <nfe:AutorizarDocumento> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:cnpjFilial>80680093000858</nfe:cnpjFilial> <nfe:xml><![CDATA[<rcnt><tipooperacao>113</tipooperacao><perfil>DEPOSIT</perfil><evento><![CDATA[JSON DO EVENTO]]]]><![CDATA[></evento></rcnt>]]></nfe:xml> </nfe:AutorizarDocumento> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <AutorizarDocumentoResponse xmlns="http://www.senior.com.br/nfe"> <AutorizarDocumentoResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </AutorizarDocumentoResult> </AutorizarDocumentoResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <AutorizarDocumentoResponse xmlns="http://www.senior.com.br/nfe"> <AutorizarDocumentoResult i:type="SituacaoDocumento" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> ... </AutorizarDocumentoResult> </AutorizarDocumentoResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <AutorizarDocumentoResponse xmlns="http://www.senior.com.br/nfe"> ... </AutorizarDocumentoResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> ... </s:Envelope>
ConfigurarFilial(String, String, DadosFilial)
Importante
Esse método será descontinuado, para configurar uma filial por webservice utilizar o serviço ConfigurarFilial(String, String, DadosFilial).
Parâmetros
| Parâmetro | Tipo |
| usuario | System.String |
| senha | System.String |
| dados | DadosFilial |
Retorno
ConsultaBlocoX(String, String, Int64, String, Int32)
Permite realizar a consulta de histórico de arquivos ou pendências dos arquivos do Bloco X e a situação do bloqueio do PAF-ECF.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| documentoFilial | System.Int64 | Documento da filial que se deseja consultar as mensagens. |
| documentoEnvio | System.String | Documento que será enviado na consulta IE/Recibo (informar de acordo com o tipo de consulta a ser realizado) |
| tipoConsulta | System.Int32 | Tipo de consulta que será efetuado. Para ver os valores possiveis Senior.SapiensNfe.DataAccess.Enums.TipoConsultaBlocoX. |
Retorno
Retorna uma instância de RetornoConsultaBlocoX, somente variando os campos que são retornados em caso de sucesso ou rejeição.
Caso a requisição seja atendida com sucesso serão preenchidos os campos Sucesso com o valor true e o campo XmlRetorno com o retorno da consulta.
Caso ocorra algum problema que impeça o sistema de completar a requisição será preenchido o campo Sucesso com o valor false e os campos Codigo e Mensagem indicando o problema ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe"> <soapenv:Header/> <soapenv:Body> <nfe:ConsultaBlocoX> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:documentoFilial>00000000000000</nfe:documentoFilial> <nfe:documentoEnvio>000000000000</nfe:documentoEnvio> <nfe:tipoConsulta>1</nfe:tipoConsulta> </nfe:ConsultaBlocoX> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultaBlocoXResponse xmlns="http://www.senior.com.br/nfe"> <ConsultaBlocoXResult xmlns:a="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Serializacao.Documento" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:Codigo>10014</a:Codigo> <a:Mensagem>Usuário e/ou senha incorretos.</a:Mensagem> <a:Sucesso>false</a:Sucesso> </ConsultaBlocoXResult> </ConsultaBlocoXResponse> </s:Body> </s:Envelope>
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:ConsultaBlocoX>
<nfe:usuario>usuario</nfe:usuario>
<nfe:senha>senha</nfe:senha>
<nfe:documentoFilial>00000000000000</nfe:documentoFilial>
<nfe:documentoEnvio>000000000000</nfe:documentoEnvio>
<nfe:tipoConsulta>1</nfe:tipoConsulta>
</nfe:ConsultaBlocoX>
</soapenv:Body>
</soapenv:Envelope>
Exemplo da resposta com mensagens retornadas:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ConsultaBlocoXResponse xmlns="http://www.senior.com.br/nfe">
<ConsultaBlocoXResult xmlns:a="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Serializacao.Documento" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Sucesso>true</a:Sucesso>
<a:XmlRetorno><![CDATA[<?xml version="1.0" encoding="utf-8"?>
<RespostaConsultarPendenciasContribuinte>
<SituacaoOperacaoCodigo>0</SituacaoOperacaoCodigo>
<SituacaoOperacaoDescricao>OK</SituacaoOperacaoDescricao>
<IE>000000000</IE>
<DataInicioObrigacao>2018-01-08</DataInicioObrigacao>
<TransmiteEstoque>true</TransmiteEstoque>
<ReducoesZ>
<Ecf>
<NumeroFabricacaoEcf>AA000000000000000000</NumeroFabricacaoEcf>
<SituacaoPafEcfCodigo>0</SituacaoPafEcfCodigo>
<SituacaoPafEcfDescricao>Não bloqueado</SituacaoPafEcfDescricao>
<QuantidadePendencias>1</QuantidadePendencias>
<QuantidadeAvisos>1</QuantidadeAvisos>
<Pendencias>
<Pendencia>
<Codigo>000000</Codigo>
<Descricao>Descrição</Descricao>
<Quantidade>1</Quantidade>
<Recibos>
<Recibo>00000000-0000-0000-0000-000000000000</Recibo>
</Recibos>
</Pendencia>
</Pendencias>
<Avisos>
<Aviso>
<Codigo>100003</Codigo>
<Descricao>Última data de referência de Redução Z...</Descricao>
</Aviso>
<Avisos>
</Ecf>
</ReducoesZ>
<Estoques>
<QuantidadePendencias>2</QuantidadePendencias>
<QuantidadeAvisos>1</QuantidadeAvisos>
<Estoque>
<DataReferencia>2018-12-31</DataReferencia>
<Pendencias>
<Pendencia>
<Codigo>000000</Codigo>
<Descricao>Descrição</Descricao>
<Quantidade>1</Quantidade>
<Recibos>
<Recibo>00000000-0000-0000-0000-000000000000</Recibo>
</Recibos>
</Pendencia>
</Pendencias>
<Avisos>
<Aviso>
<Codigo>400002</Codigo>
<Descricao>Contribuinte não enviou o Estoque do dia 31/07/2018</Descricao>
</Aviso>
<Avisos>
</Estoque>
</Estoques>
</RespostaConsultarPendenciasContribuinte>]]></a:XmlRetorno>
</ConsultaBlocoXResult>
</ConsultaBlocoXResponse>
</s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultaBlocoXResponse xmlns="http://www.senior.com.br/nfe"> <ConsultaBlocoXResult xmlns:a="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Serializacao.Documento" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:Sucesso>true</a:Sucesso> <a:XmlRetorno><![CDATA[...]]></a:XmlRetorno> </ConsultaBlocoXResult> </ConsultaBlocoXResponse> </s:Body> </s:Envelope>
ConsultarCadastroContribuinte(String, String, Int64, Int64, Int32, Int32)
Consulta na Sefaz a situação de cadastro de contribuintes do ICMS da unidade federada a partir de um número de documento do contribuinte. A Sefaz do estado do Rio de Janeiro (RJ) não possui webservice para esta consulta, portanto as consultas neste estado não serão possíveis.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| cnpjFilial | System.Int64 | CNPJ da filial que fará a requisição para a Sefaz. Deve ser a filial no eDocs que terá o certificado digital a ser usado na consulta. |
| documentoConsulta | System.Int64 | Documento a ser consultado na Sefaz. Pode ser um CNPJ, um CPF ou uma Inscrição Estadual. |
| tipoDocumentoConsulta | System.Int32 | Tipo do documento informado no parâmetro documentoConsulta. Opções: 1 - CNPJ; 2 - CPF; 3 - Inscrição Estadual. |
| uf | System.Int32 | Código IBGE do estado do contribuinte a ser consultado. |
Retorno
Em casos de erro será retornado uma instância de RetornoIntegracaoGenerico com a mensagem e código de erro
Caso contrário será retornado uma instância de RetornoIntegracaoXml com o XML retornado pela consulta. Nessa situação o eDocs não realiza nenhum tratamento sobre o XML retornado, simplesmente repassamos o que o webservice de consulta nos retornou
Exemplo da requisição SOAP: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe"> <soapenv:Header/> <soapenv:Body> <nfe:ConsultarCadastroContribuinte> <nfe:usuario>usuariows</nfe:usuario> <nfe:senha>senhaws</nfe:senha> <nfe:cnpjFilial>80680093000181</nfe:cnpjFilial> <nfe:documentoConsulta>80680093000181</nfe:documentoConsulta> <nfe:tipoDocumentoConsulta>1</nfe:tipoDocumentoConsulta> <nfe:uf>42</nfe:uf> </nfe:ConsultarCadastroContribuinte> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarCadastroContribuinteResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarCadastroContribuinteResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>999</Codigo> <Mensagem>Não foi possível atender a requisição: A conexão subjacente estava fechada: Erro inesperado em um envio.</Mensagem> <Sucesso>false</Sucesso> </ConsultarCadastroContribuinteResult> </ConsultarCadastroContribuinteResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarCadastroContribuinteResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarCadastroContribuinteResult i:type="RetornoIntegracaoXml" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> <XmlRetorno><![CDATA[XML retornado pela consulta de cadastro]]></XmlRetorno> </ConsultarCadastroContribuinteResult> </ConsultarCadastroContribuinteResponse> </s:Body> </s:Envelope>
ConsultarSituacaoDocumentos(String, String, Int32, Int32, IList<IdentificacaoDocumento>)
Permite realizar consulta de situação de documentos eletrônicos. Para consultar a situação de um evento é necessário consultar o documento vinculado a ele.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento a ser consultado. Para valores aceitos ver TipoDocumentoEletronico. |
| tipoProcessamento | System.Int32 | Tipo de processamento do documento (1 - emissão ou 2 - recebimento) |
| documentos | System.Collections.Generic.IList<IdentificacaoDocumento> | Identificação dos documentos a serem consultados. |
Retorno
System.Collections.Generic.IList<IRetornoRequisicaoSde>
Esse webservice sempre retornará uma lista, existem alguns cenários diferentes que podem alterar o retorno:
- Caso ocorra algum problema na requisição que impeça o sistema de consultar os documentos será retornado um único item do tipo RetornoIntegracaoGenerico.
- Caso o sistema consiga consultar os documentos será retornada uma resposta para cada IdentificacaoDocumento informado na requisição. Aqui podem ocorrer duas coisas:
- Caso o sistema consiga encontrar o documento será retornado uma instância de SituacaoDocumento com os dados do documento
- Caso não consiga será retornado uma instância de RetornoIntegracaoGenerico com a mensagem e código indicando o problema
Exemplo da requisição com mais de um documento consultado: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe"> <soapenv:Header/> <soapenv:Body> <nfe:ConsultarSituacaoDocumentos> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:tipoDocumento>1</nfe:tipoDocumento> <nfe:tipoProcessamento>1</nfe:tipoProcessamento> <nfe:documentos> <nfe:IdentificacaoDocumento> <nfe:ChaveDocumento>42130980680093000181551200000002551202540158</nfe:ChaveDocumento> </nfe:IdentificacaoDocumento> <nfe:IdentificacaoDocumento> <nfe:CnpjEmissor>99999999000191</nfe:CnpjEmissor> <nfe:Numero>999</nfe:Numero> <nfe:Serie>999</nfe:Serie> </nfe:IdentificacaoDocumento> </nfe:documentos> </nfe:ConsultarSituacaoDocumentos> </soapenv:Body> </soapenv:Envelope>
Exemplo da resposta com algum erro na requisição: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarSituacaoDocumentosResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarSituacaoDocumentosResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:anyType i:type="RetornoIntegracaoGenerico"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </a:anyType> </ConsultarSituacaoDocumentosResult> </ConsultarSituacaoDocumentosResponse> </s:Body> </s:Envelope>
Exemplo da resposta com mais de um retorno: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarSituacaoDocumentosResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarSituacaoDocumentosResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:anyType i:type="SituacaoDocumento"> <DataAutorizacao>2013-09-13T14:21:27</DataAutorizacao> <DataConsulta>2019-08-12T14:24:32</DataConsulta> <Documento> <ChaveDocumento>42130980680093000181551200000002551202540158</ChaveDocumento> <ChaveDocumentoContigencia>42130980680093000181551200000002551202540158</ChaveDocumentoContigencia> <CnpjEmissor>80680093000181</CnpjEmissor> <Numero>255</Numero> <Serie>120</Serie> </Documento> <Eventos> <SituacaoEvento> <DataAutorizacao>2013-09-13T14:23:52+00:00</DataAutorizacao> <ProtocoloAutorizacao>342130000812533</ProtocoloAutorizacao> <Sequencia>1</Sequencia> <Situacao>1</Situacao> <TipoEvento>110110</TipoEvento> <XmlAutorizado>{XML em base64}</XmlAutorizado> </SituacaoEvento> </Eventos> <ProtocoloAutorizacao>342130000812524</ProtocoloAutorizacao> <Situacao>1</Situacao> <Sucesso>true</Sucesso> <TipoAmbiente>2</TipoAmbiente> <TipoDocumento>1</TipoDocumento> </a:anyType> <a:anyType i:type="RetornoIntegracaoGenerico"> <Codigo>999</Codigo> <Mensagem>Documento não encontrado, verifique se foi informado a chave ou CNPJ, número e série do documento.</Mensagem> <Sucesso>false</Sucesso> </a:anyType> </ConsultarSituacaoDocumentosResult> </ConsultarSituacaoDocumentosResponse> </s:Body> </s:Envelope>
ConsultarTipoEmissao(String, String, Int64, Int32)
Retorna situação da filial em relação a contingência.
Importante
Esse método está obsoleto e será descontinuado, deve ser usado o método ConsultarTipoEmissaoV2(String, String, Int64, Int32) para consultar a situação de contingência de uma filial.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| cnpjFilial | System.Int64 | CNPJ da filial a ser consultada. |
| tipoDocumento | System.Int32 | Tipo do documento eletrônico a ser consultado. Para valores permitidos ver TipoDocumentoEletronico. |
Retorno
- Caso ocorra algum erro que impeça o eDocs de consultar a situação de contingência da filial será retornado uma instância de RetornoIntegracaoGenerico com mensagem e código de erro
- Caso o sistema consiga consultar a situação da filial será retornada uma instância de SituacaoContingencia com os dados de contingência da filial consultada
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:ConsultarTipoEmissao> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:cnpjFilial>80680093000181</nfe:cnpjFilial> <nfe:tipoDocumento>1</nfe:tipoDocumento> </nfe:ConsultarTipoEmissao> </soapenv:Body> </soapenv:Envelope>
Exemplo da resposta com algum erro na requisição: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarTipoEmissaoResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarTipoEmissaoResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </ConsultarTipoEmissaoResult> </ConsultarTipoEmissaoResponse> </s:Body> </s:Envelope>
Exemplo da resposta com os dados da filial: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarTipoEmissaoResponse xmlns="http://www.senior.com.br/nfe"> <ConsultarTipoEmissaoResult i:type="SituacaoContingencia" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CnpjFilial>80680093000181</CnpjFilial> <Sucesso>true</Sucesso> <TipoAmbiente>2</TipoAmbiente> <TipoDocumento>1</TipoDocumento> <TipoEmissao>1</TipoEmissao> <Versao>5.8.11.90</Versao> </ConsultarTipoEmissaoResult> </ConsultarTipoEmissaoResponse> </s:Body> </s:Envelope>
ConsultarTipoEmissaoV2(String, String, Int64, Int32)
Expõe a mesma funcionalidade do método ConsultarTipoEmissao(String, String, Int64, Int32) mas suporta o retorno de dados de contingência por estado (utilizado para NF-e, por exemplo).
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| documentoFilial | System.Int64 | CNPJ da filial a ser consultada. |
| tipoDocumento | System.Int32 | Tipo do documento eletrônico a ser consultado. Para valores permitidos ver TipoDocumentoEletronico. |
Retorno
- Caso ocorra algum erro que impeça o eDocs de consultar a situação de contingência da filial será retornado uma instância de RetornoIntegracaoGenerico com mensagem e código de erro
- Caso o sistema consiga consultar a situação da filial será retornada uma instância de SituacaoContingenciaV2 com os dados de contingência da filial consultada
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:ConsultarTipoEmissaoV2> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:documentoFilial>80680093000181</nfe:documentoFilial> <nfe:tipoDocumento>1</nfe:tipoDocumento> </nfe:ConsultarTipoEmissaoV2> </soapenv:Body> </soapenv:Envelope>
Exemplo da resposta com algum erro na requisição: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarTipoEmissaoV2Response xmlns="http://www.senior.com.br/nfe"> <ConsultarTipoEmissaoV2Result i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </ConsultarTipoEmissaoV2Result> </ConsultarTipoEmissaoV2Response> </s:Body> </s:Envelope>
Exemplo da resposta sem nenhum estado em contingência: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarTipoEmissaoV2Response xmlns="http://www.senior.com.br/nfe"> <ConsultarTipoEmissaoV2Result i:type="SituacaoContingenciaV2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <DocumentoFilial>80680093000181</DocumentoFilial> <EmContingencia>false</EmContingencia> <Sucesso>true</Sucesso> <TipoAmbiente>2</TipoAmbiente> <TipoDocumento>1</TipoDocumento> <TipoDocumentoFilial>1</TipoDocumentoFilial> <Versao>5.8.11.90</Versao> </ConsultarTipoEmissaoV2Result> </ConsultarTipoEmissaoV2Response> </s:Body> </s:Envelope>
Exemplo da resposta com estados em contingência: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarTipoEmissaoV2Response xmlns="http://www.senior.com.br/nfe"> <ConsultarTipoEmissaoV2Result i:type="SituacaoContingenciaV2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Contingencias> <Contingencia> <CodigoEstado>42</CodigoEstado> <DataEntrada>2019-08-13T11:44:07</DataEntrada> <Motivo>motivo da entrada em contingência para o estado de SC</Motivo> <TipoEmissao>4</TipoEmissao> <TipoEntradaContingencia>1</TipoEntradaContingencia> <UfEstado>SC</UfEstado> </Contingencia> <Contingencia> <CodigoEstado>12</CodigoEstado> <DataEntrada>2019-08-13T11:44:16</DataEntrada> <Motivo>motivo da entrada em contingência para o estado de AC</Motivo> <TipoEmissao>2</TipoEmissao> <TipoEntradaContingencia>1</TipoEntradaContingencia> <UfEstado>AC</UfEstado> </Contingencia> </Contingencias> <DocumentoFilial>80680093000181</DocumentoFilial> <EmContingencia>true</EmContingencia> <Sucesso>true</Sucesso> <TipoAmbiente>2</TipoAmbiente> <TipoDocumento>1</TipoDocumento> <TipoDocumentoFilial>1</TipoDocumentoFilial> <Versao>5.8.11.90</Versao> </ConsultarTipoEmissaoV2Result> </ConsultarTipoEmissaoV2Response> </s:Body> </s:Envelope>
Exemplo da resposta com estados em contingência: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ConsultarTipoEmissaoV2Response xmlns="http://www.senior.com.br/nfe"> <ConsultarTipoEmissaoV2Result i:type="SituacaoContingenciaV2" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Contingencias> <Contingencia> <DataEntrada>2019-08-13T11:46:36</DataEntrada> <Motivo>motivo da entrada em contingência</Motivo> <TipoEmissao>7</TipoEmissao> <TipoEntradaContingencia>1</TipoEntradaContingencia> </Contingencia> </Contingencias> <DocumentoFilial>80680093000181</DocumentoFilial> <EmContingencia>true</EmContingencia> <Sucesso>true</Sucesso> <TipoAmbiente>2</TipoAmbiente> <TipoDocumento>3</TipoDocumento> <TipoDocumentoFilial>1</TipoDocumentoFilial> <Versao>5.8.11.90</Versao> </ConsultarTipoEmissaoV2Result> </ConsultarTipoEmissaoV2Response> </s:Body> </s:Envelope>
IntegrarDocumentos(String, String, Int64, Int32, IList<String>, Nullable<Boolean>)
Realiza a integração assíncrona de documentos no sistema.
Importante
Para integração de NFS-e o sistema utiliza um arquivo de XSD customizado para validação, para visualizar esse arquivo clique aqui.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| cnpjFilial | System.Int64 | CNPJ da filial que ficará vinculada aos documentos no sistema. No caso documentos que usam a estrutura de emissores/outorgados deve ser a filial vinculada ao emissor/outorgado do documento. |
| tipoDocumento | System.Int32 | Informe 0 nesse campo, mantido apenas para compatibilidade. |
| xmls | System.Collections.Generic.IList<System.String> | XML dos documentos a serem integrados. O sistema irá determinar qual rotina de integração deve ser usada para cada XML dependendo de seu schema. |
| ativarEnvioEmail | System.Nullable<System.Boolean> | Indica se deve enviar o email ao emitir o documento. |
Retorno
System.Collections.Generic.IList<IRetornoRequisicaoSde>
Esse webservice sempre retornará uma lista, existem alguns cenários diferentes que podem alterar o retorno:
- Caso ocorra algum problema na requisição que impeça o sistema de integrar os documentos será retornado um único item do tipo RetornoIntegracaoGenerico.
- Caso o sistema consiga integrar os documentos será retornada uma resposta para cada um dos xmls informado na requisição. Aqui podem ocorrer duas coisas:
- Caso o sistema consiga integrar o documento será retornado uma instância de RetornoIntegracaoGenerico com o campo Sucesso com o valor true
- Caso não consiga será retornado uma instância de RetornoIntegracaoGenerico Sucesso com o valor false e a mensagem e código indicando o problema
Exemplo da requisição com mais de um XML para integrar: <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:IntegrarDocumentos> <nfe:usuario>usuarioErrado</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:cnpjFilial>80680093000181</nfe:cnpjFilial> <nfe:tipoDocumento>0</nfe:tipoDocumento> <nfe:xmls> <arr:string><![CDATA[conteudo do XML]]></arr:string> <arr:string><![CDATA[conteudo do segundo XML]]></arr:string> </nfe:xmls> </nfe:IntegrarDocumentos> </soapenv:Body> </soapenv:Envelope>
Exemplo da resposta com algum erro na requisição: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <IntegrarDocumentosResponse xmlns="http://www.senior.com.br/nfe"> <IntegrarDocumentosResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:anyType i:type="RetornoIntegracaoGenerico"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </a:anyType> </IntegrarDocumentosResult> </IntegrarDocumentosResponse> </s:Body> </s:Envelope>
Exemplo da resposta com mais de um retorno: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <IntegrarDocumentosResponse xmlns="http://www.senior.com.br/nfe"> <IntegrarDocumentosResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:anyType i:type="RetornoIntegracaoGenerico"> <Codigo>999</Codigo> <Mensagem>Não foi possível integrar o documento. Problemas ao integrar o documento, verifique as críticas de integração.</Mensagem> <Sucesso>false</Sucesso> </a:anyType> <a:anyType i:type="RetornoIntegracaoGenerico"> <Sucesso>true</Sucesso> </a:anyType> </IntegrarDocumentosResult> </IntegrarDocumentosResponse> </s:Body> </s:Envelope>
IntegrarDocumentosIdentificacao(String, String, Int64, Int32, IList<IntegracaoDocumento>, Nullable<Boolean>)
Expõe a mesma funcionalidade do método IntegrarDocumentos, adicionando duas funcionalidades:
- Permite informar um identificador para cada XML integrado, esse identificador será retornado junto com a resposta
- Permite informar anexos de e-mail dentro de cada um dos documentos, esses anexos serão enviados junto com o e-mail de autorização do documento integrado
Importante
Para integração de NFS-e o sistema utiliza um arquivo de XSD customizado para validação, para visualizar esse arquivo clique aqui.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| cnpjFilial | System.Int64 | CNPJ da filial que ficará vinculada aos documentos no sistema. No caso documentos que usam a estrutura de emissores/outorgados deve ser a filial vinculada ao emissor/outorgado do documento. |
| tipoDocumento | System.Int32 | Informe 0 nesse campo, mantido apenas para compatibilidade. |
| documentos | System.Collections.Generic.IList<IntegracaoDocumento> | XMLs com as informações vinculadas a cada um. |
| ativarEnvioEmail | System.Nullable<System.Boolean> | Indica se deve enviar o email ao emitir o documento. |
Retorno
System.Collections.Generic.IList<IRetornoRequisicaoSde>
Esse webservice sempre retornará uma lista, existem alguns cenários diferentes que podem alterar o retorno:
- Caso ocorra algum problema na requisição que impeça o sistema de integrar os documentos será retornado um único item do tipo RetornoIntegracaoGenerico.
- Caso o sistema consiga integrar os documentos será retornada uma resposta para cada um dos xmls informado na requisição. Aqui podem ocorrer duas coisas, nos dois casos o sistema irá retornar o Identificador do XML junto com seu retorno:
- Caso o sistema consiga integrar o documento será retornado uma instância de RetornoIntegracaoGenerico com o campo Sucesso com o valor true
- Caso não consiga será retornado uma instância de RetornoIntegracaoGenerico Sucesso com o valor false e a mensagem e código indicando o problema
Exemplo da requisição com mais de um XML para integrar: <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"> <soapenv:Header/> <soapenv:Body> <nfe:IntegrarDocumentosIdentificacao> <nfe:usuario>usuarioErrado</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:cnpjFilial>80680093000181</nfe:cnpjFilial> <nfe:tipoDocumento>0</nfe:tipoDocumento> <nfe:documentos> <sen:IntegracaoDocumento> <sen:AnexosEmail> <sen:Arquivo> <sen:Conteudo>{conteudo do arquivo em base64}</sen:Conteudo> <sen:Nome>teste.txt</sen:Nome> </sen:Arquivo> </sen:AnexosEmail> <sen:Identificador>1</sen:Identificador> <sen:Xml><![CDATA[conteudo do XML]]></sen:Xml> </sen:IntegracaoDocumento> <sen:IntegracaoDocumento> <sen:AnexosEmail> <sen:Arquivo> <sen:Conteudo>{conteudo do arquivo em base64}</sen:Conteudo> <sen:Nome>teste2.txt</sen:Nome> </sen:Arquivo> </sen:AnexosEmail> <sen:Identificador>2</sen:Identificador> <sen:Xml><![CDATA[conteudo do outro XML]]></sen:Xml> </sen:IntegracaoDocumento> </nfe:documentos> </nfe:IntegrarDocumentosIdentificacao> </soapenv:Body> </soapenv:Envelope>
Exemplo da resposta com algum erro na requisição: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <IntegrarDocumentosIdentificacaoResponse xmlns="http://www.senior.com.br/nfe"> <IntegrarDocumentosIdentificacaoResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:anyType i:type="RetornoIntegracaoGenerico"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </a:anyType> </IntegrarDocumentosIdentificacaoResult> </IntegrarDocumentosIdentificacaoResponse> </s:Body> </s:Envelope>
Exemplo da resposta com mais de um retorno: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <IntegrarDocumentosIdentificacaoResponse xmlns="http://www.senior.com.br/nfe"> <IntegrarDocumentosIdentificacaoResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:anyType i:type="RetornoIntegracaoGenerico"> <Identificador>1</Identificador> <Sucesso>true</Sucesso> </a:anyType> <a:anyType i:type="RetornoIntegracaoGenerico"> <Codigo>999</Codigo> <Identificador>2</Identificador> <Mensagem>Não foi possível integrar o documento. Problemas ao integrar o documento, verifique as críticas de integração.</Mensagem> <Sucesso>false</Sucesso> </a:anyType> </IntegrarDocumentosIdentificacaoResult> </IntegrarDocumentosIdentificacaoResponse> </s:Body> </s:Envelope>
IntegrarDocumentosIdentificacaoOrigem(String, String, Int64, IList<IntegracaoDocumento>, String, Nullable<Boolean>)
Expõe a mesma funcionalidade do método IntegrarDocumentosIdentificacao mas permite informar também uma identificação textual do software que originou o documento.
Importante
Para integração de NFS-e o sistema utiliza um arquivo de XSD customizado para validação, para visualizar esse arquivo clique aqui.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| cnpjFilial | System.Int64 | CNPJ da filial que ficará vinculada aos documentos no sistema. No caso documentos que usam a estrutura de emissores/outorgados deve ser a filial vinculada ao emissor/outorgado do documento. |
| documentos | System.Collections.Generic.IList<IntegracaoDocumento> | XMLs com as informações vinculadas a cada um. |
| identificadorOrigem | System.String | Identificador textual do sistema origem do documento. |
| ativarEnvioEmail | System.Nullable<System.Boolean> | Indica se deve enviar o email ao emitir o documento. |
Retorno
System.Collections.Generic.IList<IRetornoRequisicaoSde>
Esse webservice sempre retornará uma lista, existem alguns cenários diferentes que podem alterar o retorno:
- Caso ocorra algum problema na requisição que impeça o sistema de integrar os documentos será retornado um único item do tipo RetornoIntegracaoGenerico.
- Caso o sistema consiga integrar os documentos será retornada uma resposta para cada um dos xmls informado na requisição. Aqui podem ocorrer duas coisas, nos dois casos o sistema irá retornar o Identificador do XML junto com seu retorno:
- Caso o sistema consiga integrar o documento será retornado uma instância de RetornoIntegracaoGenerico com o campo Sucesso com o valor true
- Caso não consiga será retornado uma instância de RetornoIntegracaoGenerico Sucesso com o valor false e a mensagem e código indicando o problema
Exemplo da requisição com mais de um XML para integrar: <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"> <soapenv:Header/> <soapenv:Body> <nfe:IntegrarDocumentosIdentificacaoOrigem> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:cnpjFilial>80680093000181</nfe:cnpjFilial> <nfe:documentos> <sen:IntegracaoDocumento> <sen:Identificador>1</sen:Identificador> <sen:Xml><![CDATA[conteudo do XML]]></sen:Xml> </sen:IntegracaoDocumento> <sen:IntegracaoDocumento> <sen:AnexosEmail> <sen:Arquivo> <sen:Conteudo>c2VuaW9yMjAxNVNpc3Q=</sen:Conteudo> <sen:Nome>teste.txt</sen:Nome> </sen:Arquivo> </sen:AnexosEmail> <sen:Identificador>2</sen:Identificador> <sen:Xml><![CDATA[conteudo do outro XML]]></sen:Xml> </sen:IntegracaoDocumento> </nfe:documentos> <nfe:identificadorOrigem>ERP Senior</nfe:identificadorOrigem> </nfe:IntegrarDocumentosIdentificacaoOrigem> </soapenv:Body> </soapenv:Envelope>
Exemplo da resposta com algum erro na requisição: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <IntegrarDocumentosIdentificacaoOrigemResponse xmlns="http://www.senior.com.br/nfe"> <IntegrarDocumentosIdentificacaoOrigemResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:anyType i:type="RetornoIntegracaoGenerico"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </a:anyType> </IntegrarDocumentosIdentificacaoOrigemResult> </IntegrarDocumentosIdentificacaoOrigemResponse> </s:Body> </s:Envelope>
Exemplo da resposta com mais de um retorno: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <IntegrarDocumentosIdentificacaoOrigemResponse xmlns="http://www.senior.com.br/nfe"> <IntegrarDocumentosIdentificacaoOrigemResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:anyType i:type="RetornoIntegracaoGenerico"> <Identificador>1</Identificador> <Sucesso>true</Sucesso> </a:anyType> <a:anyType i:type="RetornoIntegracaoGenerico"> <Codigo>999</Codigo> <Identificador>2</Identificador> <Mensagem>Não foi possível integrar o documento. Problemas ao integrar o documento, verifique as críticas de integração.</Mensagem> <Sucesso>false</Sucesso> </a:anyType> </IntegrarDocumentosIdentificacaoOrigemResult> </IntegrarDocumentosIdentificacaoOrigemResponse> </s:Body> </s:Envelope>
MarcarRetorno(String, String, Int32, Int32, Int32, String, Int32, String)
Permite sinalizar ao sistema que um determinado documento ou evento foi retornado com sucesso para o sistema emissor.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento a ser marcado. Para valores aceitos ver TipoDocumentoEletronico. |
| tipoOperacao | System.Int32 | Tipo de operação que será usado para marcar o documento. Por exemplo para NF-e identifica emissão, cancelamento, CC-e, etc. Para valores aceitos ver TipoOperacao |
| tipoProcessamento | System.Int32 | Tipo de processamento do documento (1 - emissão ou 2 - recebimento) |
| chave | System.String | Chave/identificador do documento ou evento que deve ser marcado para retorno. |
| tipoRetorno | System.Int32 | Tipo de retorno, sucesso ou erro (0 - sucesso, 1 - erro) |
| mensagem | System.String | Quando retorno de erro, mensagem com a descrição do problema. |
Retorno
Retorna uma instância de RetornoIntegracaoGenerico com o campo Sucesso indicando se o retorno foi marcado ou não e os campos Codigo e Mensagem indicando o que deu errado em casos de erro.
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:MarcarRetorno> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:tipoDocumento>1</nfe:tipoDocumento> <nfe:tipoOperacao>1</nfe:tipoOperacao> <nfe:tipoProcessamento>1</nfe:tipoProcessamento> <nfe:chave>00000000000000000000000000000000000000000000</nfe:chave> </nfe:MarcarRetorno> </soapenv:Body> </soapenv:Envelope>
Exemplo de resposta com o documento marcado para retorno com sucesso: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <MarcarRetornoResponse xmlns="http://www.senior.com.br/nfe"> <MarcarRetornoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> </MarcarRetornoResult> </MarcarRetornoResponse> </s:Body> </s:Envelope>
Resposta erro (tambem com dois blocos)
Exemplo da resposta com algum erro na requisição: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <MarcarRetornoResponse xmlns="http://www.senior.com.br/nfe"> <MarcarRetornoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10031</Codigo> <Mensagem>O campo tipoDocumento est em um formato incorreto, corrija o valor dele de acordo com a documenta o do sistema e tente novamente.</Mensagem> <Sucesso>false</Sucesso> </MarcarRetornoResult> </MarcarRetornoResponse> </s:Body> </s:Envelope>
Exemplo de resposta com o documento marcado para retorno com sucesso: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <MarcarRetornoResponse xmlns="http://www.senior.com.br/nfe"> <MarcarRetornoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> </MarcarRetornoResult> </MarcarRetornoResponse> </s:Body> </s:Envelope>
ObterCriticasIntegracao(String, String, Int64, Int32, Int32, Int32)
Retorna críticas de integração de acordo com o tipo de documento e paginação informados.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| documentoFilial | System.Int64 | Documento da filial vinculada as críticas. |
| tipoDocumento | System.Int32 | Tipo de documento das críticas. Para valores aceitos ver TipoDocumentoEletronico. |
| registroInicial | System.Int32 | Registro inicial, usado para paginação. |
| quantidadeRegistros | System.Int32 | Quantidade de registros retornados, usado para paginação. |
Retorno
- Caso ocorra algum erro que impeça o eDocs de consultar as críticas da filial será retornado uma instância de RetornoIntegracaoGenerico com mensagem e código de erro
- Caso o sistema consiga consultar as críticas da filial será retornada uma instância de RetornoCriticas com as críticas encontradas
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe"> <soapenv:Header/> <soapenv:Body> <nfe:ObterCriticasIntegracao> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:documentoFilial>80680093000181</nfe:documentoFilial> <nfe:tipoDocumento>1</nfe:tipoDocumento> <nfe:registroInicial>0</nfe:registroInicial> <nfe:quantidadeRegistros>2</nfe:quantidadeRegistros> </nfe:ObterCriticasIntegracao> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ObterCriticasIntegracaoResponse xmlns="http://www.senior.com.br/nfe"> <ObterCriticasIntegracaoResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </ObterCriticasIntegracaoResult> </ObterCriticasIntegracaoResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ObterCriticasIntegracaoResponse xmlns="http://www.senior.com.br/nfe"> <ObterCriticasIntegracaoResult i:type="a:RetornoCriticas" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:a="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Serializacao.Documento"> <a:Sucesso>true</a:Sucesso> <a:Criticas xmlns:b="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Dados.Documento"> <b:CriticaIntegracaoRetorno> <b:Chave>00000000000000000000000000000000000000000000</b:Chave> <b:DocumentoFilial>80680093000181</b:DocumentoFilial> <b:TipoDocumentoFilial>1</b:TipoDocumentoFilial> <b:TipoDocumento>1</b:TipoDocumento> <b:TipoAmbiente>2</b:TipoAmbiente> <b:Critica>Verifique a licença, a filial 80.680.093/0001-81 - Senior Sistemas não possui autorização para NF-e.</b:Critica> <b:Data>2019-08-13T09:51:50</b:Data> </b:CriticaIntegracaoRetorno> <b:CriticaIntegracaoRetorno> <b:Chave>00000000000000000000000000000000000000000000</b:Chave> <b:DocumentoFilial>80680093000181</b:DocumentoFilial> <b:TipoDocumentoFilial>1</b:TipoDocumentoFilial> <b:TipoDocumento>1</b:TipoDocumento> <b:TipoAmbiente>2</b:TipoAmbiente> <b:Critica>Verifique a licença, a filial 80.680.093/0001-81 - Senior Sistemas não possui autorização para NF-e.</b:Critica> <b:Data>2019-08-13T09:45:30</b:Data> </b:CriticaIntegracaoRetorno> </a:Criticas> </ObterCriticasIntegracaoResult> </ObterCriticasIntegracaoResponse> </s:Body> </s:Envelope>
ObterCriticasPorIdentificador(String, String, Int32, List<String>)
Retorna as críticas de integração dos documento de acordo com identificadores informados e tipo.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento das críticas. |
| identificadores | System.Collections.Generic.List<System.String> | Identificadores dos documentos vinculados as críticas. |
Retorno
- Caso ocorra algum erro que impeça o eDocs de consultar as críticas dos documentos informados será retornado uma instância de RetornoIntegracaoGenerico com mensagem e código de erro
- Caso o sistema consiga consultar as críticas dos documentos informados será retornada uma instância de RetornoCriticas com as críticas encontradas
<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:ObterCriticasPorIdentificador> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:tipoDocumento>1</nfe:tipoDocumento> <nfe:identificadores> <arr:string>00000000000000000000000000000000000000000000</arr:string> <arr:string>11111111111111111111111111111111111111111111</arr:string> </nfe:identificadores> </nfe:ObterCriticasPorIdentificador> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ObterCriticasPorIdentificadorResponse xmlns="http://www.senior.com.br/nfe"> <ObterCriticasPorIdentificadorResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </ObterCriticasPorIdentificadorResult> </ObterCriticasPorIdentificadorResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ObterCriticasPorIdentificadorResponse xmlns="http://www.senior.com.br/nfe"> <ObterCriticasPorIdentificadorResult i:type="a:RetornoCriticas" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:a="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Serializacao.Documento"> <a:Sucesso>true</a:Sucesso> <a:CriticasIdentificador> <a:CriticaIdentificador> <a:Criticas xmlns:b="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Dados.Documento"> <b:CriticaIntegracaoRetorno> <b:Chave>00000000000000000000000000000000000000000000</b:Chave> <b:DocumentoFilial>80680093000181</b:DocumentoFilial> <b:TipoDocumentoFilial>1</b:TipoDocumentoFilial> <b:TipoDocumento>1</b:TipoDocumento> <b:TipoAmbiente>2</b:TipoAmbiente> <b:Critica>Verifique a licença, a filial 80.680.093/0001-81 - Senior Sistemas não possui autorização para NF-e.</b:Critica> <b:Data>2019-08-13T09:45:30</b:Data> </b:CriticaIntegracaoRetorno> <b:CriticaIntegracaoRetorno> <b:Chave>00000000000000000000000000000000000000000000</b:Chave> <b:DocumentoFilial>80680093000181</b:DocumentoFilial> <b:TipoDocumentoFilial>1</b:TipoDocumentoFilial> <b:TipoDocumento>1</b:TipoDocumento> <b:TipoAmbiente>2</b:TipoAmbiente> <b:Critica>Verifique a licença, a filial 80.680.093/0001-81 - Senior Sistemas não possui autorização para NF-e.</b:Critica> <b:Data>2019-08-13T09:51:50</b:Data> </b:CriticaIntegracaoRetorno> </a:Criticas> <a:Identificador>00000000000000000000000000000000000000000000</a:Identificador> </a:CriticaIdentificador> <a:CriticaIdentificador> <a:Criticas xmlns:b="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Dados.Documento"/> <a:Identificador>11111111111111111111111111111111111111111111</a:Identificador> </a:CriticaIdentificador> </a:CriticasIdentificador> </ObterCriticasPorIdentificadorResult> </ObterCriticasPorIdentificadorResponse> </s:Body> </s:Envelope>
ObterMensagensSat(String, String, Int64, String, Int32, Int32)
ObterMensagensSat(String, String, Int64, String, Int32, Int32)
Retorna as mensagens de SAT de acordo com os filtros informados na requisição.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| documentoFilial | System.Int64 | Documento da filial que se deseja consultar as mensagens. |
| dataInicial | System.String | Data para filtro das mensagens, somente serão retornadas mensagens que foram geradas depois dessa data. Deve ser informado no formato yyyy-MM-ddTHH:mm:ss, exemplo 2019-09-13T13:05:30. Se não for informado esse campo ou se for informada uma data inválida esse filtro não será aplicado. |
| registroInicial | System.Int32 | Registro inicial para paginação. Pode ser usado ao invés da data para controlar o último registro buscado. |
| numeroRegistros | System.Int32 | Número de registros que devem ser retornados. |
Retorno
- Sempre retornará uma instância de RetornoMensagensSat, somente variando os campos que são retornados em caso de sucesso ou rejeição.
- Caso a requisição seja atendida com sucesso serão preenchidos os campos Sucesso com o valor true e o campo Mensagens com as mensagens encontradas.
- Caso ocorra algum problema que impeça o sistema de completar a requisição será preenchido o campo Sucesso com o valor false e os campos Codigo e Mensagens com um código e mensagem indicando o problema que ocorreu.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe"> <soapenv:Header/> <soapenv:Body> <nfe:ObterMensagensSat> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:documentoFilial>00000000000000</nfe:documentoFilial> <nfe:dataInicial>2019-09-12T11:09:30</nfe:dataInicial> <nfe:registroInicial>0</nfe:registroInicial> <nfe:numeroRegistros>5</nfe:numeroRegistros> </nfe:ObterMensagensSat> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ObterMensagensSatResponse xmlns="http://www.senior.com.br/nfe"> <ObterMensagensSatResult xmlns:a="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Dados.Cfe" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:Sucesso>false</a:Sucesso> <a:Mensagem>Usuário e/ou senha incorretos.</a:Mensagem> <a:Codigo>10014</a:Codigo> </ObterMensagensSatResult> </ObterMensagensSatResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ObterMensagensSatResponse xmlns="http://www.senior.com.br/nfe"> <ObterMensagensSatResult xmlns:a="http://schemas.datacontract.org/2004/07/Senior.SapiensNfe.DataAccess.Domain.Model.Dados.Cfe" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <a:Sucesso>true</a:Sucesso> <a:Mensagens> <a:RetornoMensagemSat> <a:Mensagem>Mensagem 1</a:Mensagem> <a:Codigo>100</a:Codigo> <a:Data>2019-09-12T09:59:27</a:Data> </a:RetornoMensagemSat> <a:RetornoMensagemSat> <a:Mensagem>Mensagem 2</a:Mensagem> <a:Codigo>200</a:Codigo> <a:Data>2019-09-13T09:12:39</a:Data> </a:RetornoMensagemSat> <a:RetornoMensagemSat> <a:Mensagem>Mensagem 3</a:Mensagem> <a:Codigo>300</a:Codigo> <a:Data>2019-09-13T11:01:32</a:Data> </a:RetornoMensagemSat> <a:RetornoMensagemSat> <a:Mensagem>Mensagem 4</a:Mensagem> <a:Codigo>400</a:Codigo> <a:Data>2019-09-13T11:01:32</a:Data> </a:RetornoMensagemSat> <a:RetornoMensagemSat> <a:Mensagem>Mensagem 5</a:Mensagem> <a:Codigo>500</a:Codigo> <a:Data>2019-09-13T11:01:32</a:Data> </a:RetornoMensagemSat> </a:Mensagens> </ObterMensagensSatResult> </ObterMensagensSatResponse> </s:Body> </s:Envelope>
RequisitarConsultaDocumento(String, String, Int32, Int32, String, Nullable<Int64>)
Tenta marcar o documento com a chave informada para consulta. A consulta a Sefaz será realizada posteriormente. Documentos suportados: NF-e e NFC-e
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo do documento eletrônico a ser consultado. Para valores aceitos ver TipoDocumentoEletronico. |
| tipoProcessamento | System.Int32 | Tipo de processamento do documento sendo consultado (1 - emissão e 2 - recebimento). |
| chaveDocumento | System.String | Chave do documento que será consultado. |
| documentoFilial | System.Nullable<System.Int64> | Documento da Filial que será consultada.(Usado apenas para a consulta do Bloco X) |
Retorno
Sempre será retornado um RetornoIntegracaoGenerico, variando o valor do campo `Sucesso` de acordo com o resultado 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:RequisitarConsultaDocumento> <nfe:usuario>usuario</nfe:usuario> <nfe:senha>senha</nfe:senha> <nfe:tipoDocumento>1</nfe:tipoDocumento> <nfe:tipoProcessamento>1</nfe:tipoProcessamento> <nfe:chaveDocumento>?</nfe:chaveDocumento> </nfe:RequisitarConsultaDocumento> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <RequisitarConsultaDocumentoResponse xmlns="http://www.senior.com.br/nfe"> <RequisitarConsultaDocumentoResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>999</Codigo> <Mensagem>NF-e com a chave e tipo de processamento informados não foi encontrada na base de dados.</Mensagem> <Sucesso>false</Sucesso> </RequisitarConsultaDocumentoResult> </RequisitarConsultaDocumentoResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <RequisitarConsultaDocumentoResponse xmlns="http://www.senior.com.br/nfe"> <RequisitarConsultaDocumentoResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> </RequisitarConsultaDocumentoResult> </RequisitarConsultaDocumentoResponse> </s:Body> </s:Envelope>
IUploadServico
Esse serviço disponibiliza funcionalidades relacionadas ao upload de XML, PDF e ZIP dos documentos de recebimento.
Importante
Por padrão esse serviço será iniciado no caminho SDE/Upload. Para maiores informações sobre a composição da URL dos webservices clique aqui.
Métodos
UploadArquivo(String, String, Int32, String, String)
Permite o upload de arquivos XML, PDF e ZIP do documento de Recebimento
Serviço disponível apenas para o documento NFS-e
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoDocumento | System.Int32 | Tipo de documento que se deseja realizar o upload. Para valores aceitos ver TipoDocumentoEletronico. |
| nomeArquivo | System.String | Nome do arquivo para Upload. |
| arquivo | System.String | Arquivo para Upload string em Base64. |
Retorno
- Caso ocorra algum erro que impeça o sistema de receber os arquivos será retornado uma instância de RetornoIntegracaoGenerico com mensagem e código de erro.
- Caso o sistema consiga receber os arquivos será retornada uma instância de RetornoUpload com sucesso.
- A resposta apenas indica que o processo de segundo plano que inicia o upload foi iniciado e não garante o efetivo recebimento do documento.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe"> <soapenv:Header/> <soapenv:Body> <nfe:UploadArquivo> <nfe:usuario>sde</nfe:usuario> <nfe:senha>sde</nfe:senha> <nfe:tipoDocumento>2</nfe:tipoDocumento> <nfe:nomeArquivo>teste.xml</nfe:nomeArquivo> <nfe:arquivo>PG5mc2UgSWQ9IklEMjMwMjIzNjM0Nzk0MDAwMjIxMDIwMjMwMjUyMjAwMDAwMDAyMDAzNTYyNiIgdmVyc2FvPSIxLjAwIj4K...</nfe:arquivo> </nfe:UploadArquivo> </soapenv:Body> </soapenv:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <UploadArquivoResponse xmlns="http://www.senior.com.br/nfe"> <UploadArquivoResult i:type="RetornoUpload" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Codigo>10014</Codigo> <Mensagem>Usuário e/ou senha incorretos.</Mensagem> <Sucesso>false</Sucesso> </UploadArquivoResult> </UploadArquivoResponse> </s:Body> </s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <UploadArquivoResponse xmlns="http://www.senior.com.br/nfe"> <UploadArquivoResult i:type="RetornoUpload" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Sucesso>true</Sucesso> </UploadArquivoResult> </UploadArquivoResponse> </s:Body> </s:Envelope>
UploadDocumento(String, String, Int32, String, Boolean, Boolean, String)
Realiza o upload síncrono de um documento XML, permitindo a importação imediata no sistema tanto para documentos de recebimento quanto de emissão, retornando o resultado da operação no momento da execução. Este método segue as mesmas premissas do importador via tela do e-Docs, mantendo o mesmo comportamento e regras já estabelecidas para esse processo.
Parâmetros
| Parâmetro | Tipo | Descrição |
| usuario | System.String | Usuário configurado na empresa para acesso ao webservice. |
| senha | System.String | Senha configurada na empresa para acesso ao webservice. |
| tipoProcessamento | System.Int32 | Tipo de processamento (1 - emissão / 2 - recebimento). |
| xml | System.String | Conteúdo do XML do documento a ser importado. |
| consultarDocumento | System.Boolean | Indica se o documento deve ser consultado. |
| marcarRetornoPendente | System.Boolean | Indica se o documento deve ser retornado ao ERP. |
| usuarioExterno | System.String | Usuário externo no qual o documento foi autorizado. |
Retorno
IRetornoRequisicaoSde
- Caso ocorra alguma situação que impeça a importação do documento, será retornada uma instância de RetornoIntegracaoGenerico contendo mensagem e código informativo.
- Caso a importação seja realizada com sucesso, será retornada uma instância de RetornoIntegracaoGenerico indicando sucesso na operação.
- A resposta representa o resultado imediato do processamento, uma vez que a execução ocorre de forma síncrona.
English
Español
English
Español


