Interface 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/Integracao. Para maiores informações sobre a composição da URL dos webservices clique aqui

Métodos

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 cnpjFilial

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.
System.String xml

XML do documento a ser emitido.
System.String identificacaoGerador

Valor única gerado pelo emissor do documento, esse valor será retornado em consultas.
System.Collections.Generic.List<Arquivo> arquivos

Arquivos adicionais integrados junto ao documento. Atualmente são anexados no envio de e-mail após a autorização do documento.
System.Nullable<System.Boolean> ativarEnvioEmail

Indica se deve enviar o email ao emitir o documento.
Retorno
IRetornoRequisicaoSde

  • 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
Exemplos

Exemplo da requisição:

<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>

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
System.String usuario

System.String senha

DadosFilial dados

Retorno
IRetornoRequisicaoSde

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 documentoFilial

Documento da filial que se deseja consultar as mensagens.
System.String documentoEnvio

Documento que será enviado na consulta IE/Recibo (informar de acordo com o tipo de consulta a ser realizado)
System.Int32 tipoConsulta

Tipo de consulta que será efetuado. Para ver os valores possiveis Senior.SapiensNfe.DataAccess.Enums.TipoConsultaBlocoX.
Retorno
RetornoConsultaBlocoX

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.
Exemplos

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
   <soapenv:Header/>
   <soapenv:Body>
      <nfe: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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 cnpjFilial

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.
System.Int64 documentoConsulta

Documento a ser consultado na Sefaz. Pode ser um CNPJ, um CPF ou uma Inscrição Estadual.
System.Int32 tipoDocumentoConsulta

Tipo do documento informado no parâmetro documentoConsulta. Opções: 1 - CNPJ; 2 - CPF; 3 - Inscrição Estadual.
System.Int32 uf

Código IBGE do estado do contribuinte a ser consultado.
Retorno
IRetornoRequisicaoSde

  • 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
Exemplos

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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int32 tipoDocumento

Tipo de documento a ser consultado. Para valores aceitos ver TipoDocumentoEletronico.
System.Int32 tipoProcessamento

Tipo de processamento do documento (1 - emissão ou 2 - recebimento)
System.Collections.Generic.IList<IdentificacaoDocumento> documentos

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
Exemplos

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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 cnpjFilial

CNPJ da filial a ser consultada.
System.Int32 tipoDocumento

Tipo do documento eletrônico a ser consultado. Para valores permitidos ver TipoDocumentoEletronico.
Retorno
IRetornoRequisicaoSde

  • 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
Exemplos

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
  <soapenv:Header/>
  <soapenv:Body>
    <nfe: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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 documentoFilial

CNPJ da filial a ser consultada.
System.Int32 tipoDocumento

Tipo do documento eletrônico a ser consultado. Para valores permitidos ver TipoDocumentoEletronico.
Retorno
IRetornoRequisicaoSde

  • 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
Exemplos

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
  <soapenv:Header/>
  <soapenv:Body>
    <nfe: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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 cnpjFilial

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.
System.Int32 tipoDocumento

Informe 0 nesse campo, mantido apenas para compatibilidade.
System.Collections.Generic.IList<System.String> xmls

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.
System.Nullable<System.Boolean> ativarEnvioEmail

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
Exemplos

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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 cnpjFilial

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.
System.Int32 tipoDocumento

Informe 0 nesse campo, mantido apenas para compatibilidade.
System.Collections.Generic.IList<IntegracaoDocumento> documentos

XMLs com as informações vinculadas a cada um.
System.Nullable<System.Boolean> ativarEnvioEmail

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
Exemplos

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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 cnpjFilial

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.
System.Collections.Generic.IList<IntegracaoDocumento> documentos

XMLs com as informações vinculadas a cada um.
System.String identificadorOrigem

Identificador textual do sistema origem do documento.
System.Nullable<System.Boolean> ativarEnvioEmail

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
Exemplos

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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int32 tipoDocumento

Tipo de documento a ser marcado. Para valores aceitos ver TipoDocumentoEletronico.
System.Int32 tipoOperacao

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
System.Int32 tipoProcessamento

Tipo de processamento do documento (1 - emissão ou 2 - recebimento)
System.String chave

Chave/identificador do documento ou evento que deve ser marcado para retorno.
System.Int32 tipoRetorno

Tipo de retorno, sucesso ou erro (0 - sucesso, 1 - erro)
System.String mensagem

Quando retorno de erro, mensagem com a descrição do problema.
Retorno
RetornoIntegracaoGenerico

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.
Exemplos

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
   <soapenv:Header/>
   <soapenv:Body>
      <nfe: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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 documentoFilial

Documento da filial vinculada as críticas.
System.Int32 tipoDocumento

Tipo de documento das críticas. Para valores aceitos ver TipoDocumentoEletronico.
System.Int32 registroInicial

Registro inicial, usado para paginação.
System.Int32 quantidadeRegistros

Quantidade de registros retornados, usado para paginação.
Retorno
IRetornoRequisicaoSde

  • 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
Exemplos

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
  <soapenv:Header/>
  <soapenv:Body>
    <nfe: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>

ObterCriticasPorIdentificador(String, String, Int32, List<String>)

Retorna as críticas de integração dos documento de acordo com identificadores informados e tipo.

Parâmetros
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int32 tipoDocumento

Tipo de documento das críticas.
System.Collections.Generic.List<System.String> identificadores

Identificadores dos documentos vinculados as críticas.
Retorno
IRetornoRequisicaoSde

  • 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
Exemplos

Exemplo da requisição:

<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>

ObterMensagensSat(String, String, Int64, String, Int32, Int32)

Retorna as mensagens de SAT de acordo com os filtros informados na requisição.

Parâmetros
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int64 documentoFilial

Documento da filial que se deseja consultar as mensagens.
System.String dataInicial

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.
System.Int32 registroInicial

Registro inicial para paginação. Pode ser usado ao invés da data para controlar o último registro buscado.
System.Int32 numeroRegistros

Número de registros que devem ser retornados.
Retorno
RetornoMensagensSat

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.
Exemplos

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
   <soapenv:Header/>
   <soapenv:Body>
      <nfe: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>

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
System.String usuario

Usuário configurado na empresa para acesso ao webservice.
System.String senha

Senha configurada na empresa para acesso ao webservice.
System.Int32 tipoDocumento

Tipo do documento eletrônico a ser consultado. Para valores aceitos ver TipoDocumentoEletronico.
System.Int32 tipoProcessamento

Tipo de processamento do documento sendo consultado (1 - emissão e 2 - recebimento).
System.String chaveDocumento

Chave do documento que será consultado.
System.Nullable<System.Int64> documentoFilial

Documento da Filial que será consultada.(Usado apenas para a consulta do Bloco X)
Retorno
IRetornoRequisicaoSde

Sempre será retornado um RetornoIntegracaoGenerico, variando o valor do campo Sucesso de acordo com o resultado da requisição.
Exemplos

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
  <soapenv:Header/>
  <soapenv:Body>
    <nfe: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>