Manual do usuário - eDocs > Integrações > Web Services > Senior.SapiensNfe.DataAccess.Dados.Sistema

Senior.SapiensNfe.DataAccess.Dados.Sistema

Classes Interfaces
DadosAplicacao IRetornoRequisicaoSde
DadosContingencia  
ParametroImpressao  
PdfRetorno  
RetornoDownload  
RetornoGeracaoImpressoes  
RetornoIntegracaoGenerico  
RetornoIntegracaoXml  
RetornoUpload  
SituacaoContingencia  
SituacaoContingenciaV2  

Classes

DadosAplicacao

Informações gerais da instância do eDocs consultado.

Propriedades Tipo Descrição Implementações
Codigo System.Nullable<System.Int64> Código, em caso de erro. Para os possíveis códigos e mensagens de retorno, ver TipoCodigoRetorno. IRetornoRequisicaoSde.Codigo
Mensagem System.String Mensagem em casos de erro. IRetornoRequisicaoSde.Mensagem
NomeAmbiente System.String Nome da instalação do eDocs que foi consultada. Definido na instalação do produto. -
Sucesso System.Boolean true se a requisição foi finalizada com sucesso, false caso contrário. IRetornoRequisicaoSde.Sucesso
TipoAmbiente TipoAmbiente Tipo de ambiente do sistema consultado. -
VersaoAmbiente System.String Versão do eDocs que foi consultado. Será retornado no formato "X.XX.XX.XX" sem os zeros não significativos, então por exemplo para a versão 5.08.10.25 será retornado 5.8.10.25. -

DadosContingencia

Propriedades Tipo Descrição
CodigoEstado System.Nullable<System.Int32> Código IBGE do estado em contingência.
DataEntrada System.DateTime Data de entrada em contingência. Retornará no formato yyyy-MM-ddTHH:mm:ss exemplo: 2018-08-25T18:45:30.
Motivo System.String Motivo da entrada de contingência.
TipoEmissao System.Int32 Indica qual o tipo de emissão ativo para esse tipo de documento para a filial. Para possíveis valores ver TipoEmissaoSefaz.
TipoEntradaContingencia System.Nullable<System.Int32> Quando em contingência informa o tipo de entrada em contingencia. Para possíveis valores ver TipoContingencia.
UfEstado System.String Sigla UF do estado em contingência.

ParametroImpressao

Modelo para passagem dos parametros de impressão do DANFE. Sempre que qualquer propriedade é adicionada nesse modelo devem ser atualizadas as referências dele tanto no PrintService quanto no eDocs e seus respectivos conversores do modelo do webservice para o modelo original.

Propriedades Tipo Descrição
Documento System.Collections.Generic.List<System.Byte[]> Documento a ser impresso, cada página é um array de byte, sendo a lista o documento todo.
ImpressaoPdf System.Boolean Indica se o sistema realizará a impressão para arquivo PDF.
ImpressoraNormal System.String Nome da impressora para impressão normal.
ImprimirDuasPaginasPorFolha System.Boolean Indica se devem ser impressas duas páginas do documento em um único lado da folha.
NomeArquivo System.String Nome do arquivo a ser impresso.
Paisagem System.Boolean Indica se a impressão ocorre no formato paisagem.
PdfsAdicionais System.Collections.Generic.List<System.Byte[]> PDFs adicionais.
QuantidadeAdicionalCopias System.Int32 Quantidade adicional de cópias a serem impressas.
ServidorImpressao System.String URL do servidor de impressão.

Métodos

ConverterEnvio()
Converte o modelo para referencia de envio.

Retorno

Senior.SapiensNfe.DataAccess.Impressao.ParametroImpressao

PdfRetorno

Representa o conteúdo de um PDF retornado por webservice.

Propriedades Tipo Descrição
Conteudo System.Byte[] Conteúdo do PDF.
TipoDocumentoAuxiliar System.Int32 Tipo do documento auxiliar. Será sempre retornado um PDF com o valor 1, que indica o PDF do documento principal, e os PDFs adicionais requisitados (quando for possível gerá-los). Para valores possíveis ver TipoDocumentoAuxiliar.

RetornoDownload

Representa o retorno de uma requisição de download.

Propriedades Tipo Descrição Implementações
Codigo System.Nullable<System.Int64> Código, em caso de erro. IRetornoRequisicaoSde.Codigo
Mensagem System.String Mensagem de erro caso requisição não seja atendida. IRetornoRequisicaoSde.Mensagem
Pdf System.Byte[] Quando a requisição trata de PDF retorna o arquivo gerado. -
Pdfs System.Collections.Generic.List<PdfRetorno> Quando a requisição tiver mais de um retorno de PDF será utilizado esse campo. -
Sucesso System.Boolean true se a requisição foi finalizada com sucesso, false caso contrário. IRetornoRequisicaoSde.Sucesso
Xmls System.String[] Quando a requisição trata XMLs retorna lista de arquivos encontrados. -

RetornoGeracaoImpressoes

Retorno da requisição de geração de impressões.

Propriedades Tipo Descrição
Impressoes System.Collections.Generic.List<ParametroImpressao> Lista com o binário das impressões.
MaiorNsu System.Int64 Maior NSU dessa requisição.
Mensagem System.String Mensagem caso ocorra algum erro.
Sucesso System.Boolean Indica se a requisição foi atendida com sucesso ou não.
TemMaisImpressoes System.Boolean Indica se tem mais alguma impressão disponível.

RetornoIntegracaoGenerico

Estrutura genérica para retornos de requisições.

Propriedades Tipo Descrição Implementações
Codigo System.Nullable<System.Int64> Código, em caso de erro. Para os possíveis códigos e mensagens de retorno, ver TipoCodigoRetorno. IRetornoRequisicaoSde.Codigo
Denegacao System.Boolean true se for o retorno de um documento denegado, false caso contrário. -
Identificador System.String Somente será sempre preenchido quando for informado um identificador na integração de um documento. Pode ser usado quando é retornada uma lista de críticas pelo sistema para localizar qual documento cada crítica referencia. IRetornoRequisicaoSde.Identificador
Mensagem System.String Mensagem em casos de erro. IRetornoRequisicaoSde.Mensagem
Sucesso System.Boolean true se a requisição foi finalizada com sucesso, false caso contrário. IRetornoRequisicaoSde.Sucesso

Métodos

ConverterPara<T>()
Converte este retorno genérico para outro tipo que implementa a mesma interface de retorno.

Retorno e Parâmetros Genéricos

T

RetornoIntegracaoXml

Representa um tipo de retorno das integrações via Web Service que contém o XML retornado pela Sefaz.

Propriedades Tipo Descrição Implementações
Codigo System.Nullable<System.Int64> Código, em caso de erro. IRetornoRequisicaoSde.Codigo
Mensagem System.String Retorna mensagem de erro caso a solicitação não seja atendida corretamente. IRetornoRequisicaoSde.Mensagem
Sucesso System.Boolean true se a requisição foi finalizada com sucesso, false caso contrário. IRetornoRequisicaoSde.Sucesso
XmlRetorno System.String XML retornado pela Sefaz. -

RetornoUpload

Representa o retorno de uma requisição de upload.

Propriedades Tipo Descrição Implementações
Codigo System.Nullable<System.Int64> Código, em caso de erro. IRetornoRequisicaoSde.Codigo
Mensagem System.String Mensagem de erro caso requisição não seja atendida. IRetornoRequisicaoSde.Mensagem
Sucesso System.Boolean true se a requisição foi finalizada com sucesso, false caso contrário. IRetornoRequisicaoSde.Sucesso

SituacaoContingencia

Propriedades Tipo Descrição Implementações
CnpjFilial System.Int64 CNPJ da filial consultada. -
Codigo System.Nullable<System.Int64> Código, em caso de erro. IRetornoRequisicaoSde.Codigo
Mensagem System.String Mensagem em casos de erro. IRetornoRequisicaoSde.Mensagem
Sucesso System.Boolean true se a requisição for finalizada com sucesso, false caso contrário. IRetornoRequisicaoSde.Sucesso
TipoAmbiente System.Int32 Tipo do ambiente configurado no sistema. -
TipoDocumento System.Int32 Tipo de documento consultado. -
TipoEmissao System.Int32 Indica qual o tipo de emissão ativo para esse tipo de documento para a filial. Para valores possíveis ver TipoEmissaoSefaz. -
TipoEntradaContingencia System.Nullable<System.Int32> Quando em contingência informa o tipo de entrada em contingencia. Para valores possíveis ver TipoContingencia. -
Versao System.String Versão do eDocs. -

SituacaoContingenciaV2

Propriedades Tipo Descrição Implementações
Codigo System.Nullable<System.Int64> Código, em caso de erro. IRetornoRequisicaoSde.Codigo
Contingencias System.Collections.Generic.List<DadosContingencia> Lista de contingências por estado para a filial. -
DocumentoFilial System.Int64 Documento da filial consultada. -
EmContingencia System.Boolean true se a filial estiver em contingência em algum estado, false caso contrário. -
Mensagem System.String Mensagem em casos de erro. IRetornoRequisicaoSde.Mensagem
Sucesso System.Boolean true se a requisição for finalizada com sucesso, false caso contrário. IRetornoRequisicaoSde.Sucesso
TipoAmbiente System.Int32 Tipo do ambiente configurado no sistema. -
TipoDocumento System.Int32 Tipo de documento consultado. -
TipoDocumentoFilial System.Int32 Tipo do documento da filial consultada. -
Versao System.String Versão do sistema. -

Interfaces

IRetornoRequisicaoSde

Estrutura padrão de retorno de requisições WCF.

Propriedades Tipo Descrição
Codigo System.Nullable<System.Int64> Código de erro caso a solicitação não seja atendida corretamente. Pode ser tanto um código de rejeição de um documento quanto uma exceção gerada pelo sistema, para uma lista dos códigos de rejeição gerados pelo sistema ver TipoCodigoRetorno.
Identificador System.String Identificador de um item na requisição passado pelo software usuário do serviço. O mesmo valor passado na requisição é devolvido na resposta, assim é possível identificar o item por esse valor e não exclusivamente pela posição.
Mensagem System.String Retorna mensagem de erro caso a solicitação não seja atendida corretamente.
Sucesso System.Boolean true se a requisição foi finalizada com sucesso, false caso contrário.

Este artigo ajudou você?