Classe SituacaoDocumento

Modelo para serialização da situação de documentos eletrônicos.

Construtores

SituacaoDocumento()

  			public SituacaoDocumento()
  		

Propriedades

Auditoria

Dados da auditoria da NF-e recebida.

  			[DataMember(Order = 21, EmitDefaultValue = false)]
public Auditoria Auditoria { get; set; }
  		
Tipo
Auditoria

Cancelamento

Situação do cancelamento associado ao documento. Quando existir. Somente cancelamento que não é gerado via evento.

  			[DataMember(Order = 0, EmitDefaultValue = false)]
public SituacaoCancelamento Cancelamento { get; set; }
  		
Tipo
SituacaoCancelamento

Codigo

Código, em casos de erro ou rejeição. Esse campo pode ter tanto o código de rejeição da entidade autorizadora do documento quanto um código gerado pelo sistema, para uma lista dos códigos que podem ser gerados pelo sistema consulte TipoCodigoRetorno.

  			[DataMember(Order = 1, EmitDefaultValue = false)]
public long? Codigo { get; set; }
  		
Tipo
System.Nullable<System.Int64>

Implementações
IRetornoRequisicaoSde.Codigo

CodigoBarras

Valor do código de barras. Somente usado na consulta de GNRE.

  			[DataMember(Order = 2, EmitDefaultValue = false)]
public string CodigoBarras { get; set; }
  		
Tipo
System.String

CodigoMensagemAutorizador

Código da mensagem retornada pelo autorizador do documento. Não é relacionado a autorização do documento, mas sim uma mensagem que o autorizador deseja passar para o emitente.

  			[DataMember(Order = 3, EmitDefaultValue = false)]
public int? CodigoMensagemAutorizador { get; set; }
  		
Tipo
System.Nullable<System.Int32>

DataAutorizacao

Data e hora de autorização do documento. Se a entidade autorizadora retornar um fuso horário ele também será retornado nesse campo.

  • Formato sem fuso horário: yyyy-MM-ddTHH:mm:ss exemplo 2018-08-25T18:45:30
  • Formato com fuso horário: yyyy-MM-ddTHH:mm:sszzz exemplo 2018-08-25T18:45:30-03:00
  			[DataMember(Order = 4, Name = "DataAutorizacao", EmitDefaultValue = false)]
public string DataAutorizacao { get; set; }
  		
Tipo
System.String

DataConsulta

Data da consulta de situação do documento.
Retornará no formato yyyy-MM-ddTHH:mm:ss exemplo: 2018-08-25T18:45:30.

  			[DataMember(Order = 5, EmitDefaultValue = false)]
public DateTime DataConsulta { get; set; }
  		
Tipo
System.DateTime

DataRecepcao

Somente usado para eSocial, representa a data de recepção do documento no SERPRO.
Retornará no formato yyyy-MM-ddTHH:mm:ss exemplo: 2018-08-25T18:45:30.

  			[DataMember(Order = 6, EmitDefaultValue = false)]
public string DataRecepcao { get; set; }
  		
Tipo
System.String

DetalhesCritica

Quando rejeitado retorna delhes da critica (quando existir). Atualmente usado por:

  • Receituário agronômico
  • NFS-e
  • eSocial
  • REINF
  • Recinto aduaneiro
  			[DataMember(Order = 7, EmitDefaultValue = false)]
public List<DetalheCritica> DetalhesCritica { get; set; }
  		
Tipo
System.Collections.Generic.List<DetalheCritica>

Documento

Dados de identificação do documento.

  			[DataMember(Order = 8, EmitDefaultValue = false)]
public IdentificacaoDocumento Documento { get; set; }
  		
Tipo
IdentificacaoDocumento

Eventos

Situação dos eventos associados ao documento.
Para eSocial e REINF também serão retornados nessa lista os totalizadores vinculados a um evento.

  			[DataMember(Order = 9, EmitDefaultValue = false)]
public List<SituacaoEvento> Eventos { get; set; }
  		
Tipo
System.Collections.Generic.List<SituacaoEvento>

Gnres

Situação das GNREs associadas ao documento. Somente retornado na consulta de NF-es e CT-es com GNREs vinculadas geradas pelo sistema.

  			[DataMember(Order = 10, EmitDefaultValue = false)]
public List<SituacaoDocumento> Gnres { get; set; }
  		
Tipo
System.Collections.Generic.List<SituacaoDocumento>

Identificador

Identificador do documento quando for informado na requisição. Permite ao sistema emissor vincular os retornos ao documento integrado quando for realizada uma integração em lote.

  			[DataMember(Order = 11, EmitDefaultValue = false)]
public string Identificador { get; set; }
  		
Tipo
System.String

Implementações
IRetornoRequisicaoSde.Identificador

Localizador

Localizador do documento. Usado somente para consulta de GNREs geradas pelo sistema.

  			[DataMember(Order = 12, EmitDefaultValue = false)]
public string Localizador { get; set; }
  		
Tipo
System.String

Mensagem

Mensagem em casos de erro ou rejeição.

  			[DataMember(Order = 13, EmitDefaultValue = false)]
public string Mensagem { get; set; }
  		
Tipo
System.String

Implementações
IRetornoRequisicaoSde.Mensagem

MensagemAutorizador

Mensagem retornada pelo autorizador do documento. Não é relacionado a autorização do documento, mas sim uma mensagem que o autorizador deseja passar para o emitente.

  			[DataMember(Order = 14, EmitDefaultValue = false)]
public string MensagemAutorizador { get; set; }
  		
Tipo
System.String

ProtocoloAutorizacao

Protocolo de autorização de uso do documento.

  			[DataMember(Order = 15, EmitDefaultValue = false)]
public string ProtocoloAutorizacao { get; set; }
  		
Tipo
System.String

Situacao

Situação do documento.

  			[DataMember(Order = 16, EmitDefaultValue = false)]
public TipoSituacaoDocumentoEletronico Situacao { get; set; }
  		
Tipo
TipoSituacaoDocumentoEletronico

Sucesso

true se a requisição for finalizada com sucesso, false caso contrário.

  			[DataMember(Order = 17, EmitDefaultValue = true)]
public bool Sucesso { get; set; }
  		
Tipo
System.Boolean

Implementações
IRetornoRequisicaoSde.Sucesso

TipoAmbiente

Tipo de ambiente que o documento foi emitido.

  			[DataMember(Order = 18, EmitDefaultValue = false)]
public TipoAmbiente TipoAmbiente { get; set; }
  		
Tipo
TipoAmbiente

TipoDocumento

Tipo de documento.

  			[DataMember(Order = 19, EmitDefaultValue = false)]
public TipoDocumentoEletronico TipoDocumento { get; set; }
  		
Tipo
TipoDocumentoEletronico

XmlAutorizado

XML autorizado na Sefaz.

  			[DataMember(Order = 20, EmitDefaultValue = false)]
public string XmlAutorizado { get; set; }
  		
Tipo
System.String

Generated by DocFX