English
Español
Manual do usuário - eDocs > Integrações > Web Services > Senior.SapiensNfe.DataAccess.Serializacao.Documento
Senior.SapiensNfe.DataAccess.Serializacao.Documento
Classes
- Arquivo
- Auditoria
- CriticaIdentificador
- DetalheCritica
- IdentificacaoDocumento
- IntegracaoDocumento
- ItemEvento
- ItemPendenteRetorno
- PendenteRetorno
- RetornoConsultaBlocoX
- RetornoCriticas
- SituacaoCancelamento
- SituacaoDocumento
- SituacaoEvento
Arquivo
Documento vinculado a um documento eletrônico vinculado ao sistema.
| Propriedades | Tipo | Descrição |
| Conteudo | System.String | Conteúdo do arquivo em base64. |
| Nome | System.String | Nome do arquivo. |
Auditoria
Representa os dados da auditoria da nota.
| Propriedades | Tipo | Descrição |
| Situacao | TipoSituacaoAuditoriaFiscal | Situação da auditoria. |
| Mensagem | System.String | Mensagem da auditoria. |
CriticaIdentificador
Retorno de críticas de integração por identificador.
| Propriedades | Tipo | Descrição |
| Criticas | System.Collections.Generic.List<CriticaIntegracaoRetorno> | Lista de críticas. |
| Identificador | System.String | Identificador do documento. |
DetalheCritica
Representa o detalhamento de uma critica ou rejeição.
| Propriedades | Tipo | Descrição |
| Codigo | System.String | Código do detalhamento. |
| Localizacao | System.String | Localização dentro do XML do problema ocorrido. Atualmente só usado para eSocial e REINF. |
| Mensagem | System.String | Descrição do detalhamento. |
| Tipo | System.Nullable<System.Int32> | Indica se é um erro ou advertência. Atualmente só usado para eSocial. |
IdentificacaoDocumento
Dados de identificação de um documento eletrônico.
Propriedades
| Propriedades | Tipo | Descrição |
| ChaveDocumentoContigencia | System.String | Chave do documento na entidade autorizadora, caso a chave seja alterada devido a contingência retorna nova chave. |
| DigestValue | System.String | DigestValue gerado somente para NF-e e NFC-e quando disponível. |
| IdentificadorGerador | System.String | Identificador do software gerador do XML. |
| NumeroFinal | System.Nullable<System.Int32> | Número de término da faixa de inutilização. Só será informado quando for uma inutilização. |
| ChaveDocumento | System.String | Chave ou ID do documento. |
| CnpjEmissor | System.Int64 | CNPJ do emissor do documento. |
| Numero | System.Nullable<System.Int32> | Número do documento. |
| NumeroNfse | System.Nullable<System.Int64> | Como o campo Numero retornará o número do RPS para NFS-e, esse campo retornará o número da NFS-e gerada quando a nota consultada estiver Emitida. |
| Serie | System.String | Série fiscal do documento. |
| InscricaoMunicipal | System.String | Inscricao Municipal. |
| CodigoSiafi | System.String | Código SIAFI. |
IntegracaoDocumento
Representa documento para integração.
Propriedades
| Propriedades | Tipo | Descrição |
| Identificador | System.String | Identificador do documento, pode ser qualquer valor que usado apenas para identificar o retorno ao chamador. |
| Xml | System.String | XML a ser integrado. |
| AnexosEmail | System.Collections.Generic.List<Arquivo> | Arquivos vinculados ao documento eletrônico integrado |
ItemEvento
Itens do evento.
Propriedades
| Propriedades | Tipo | Descrição |
| Justificativa | System.String | Justificativa da situação do item. |
| NumeroItem | System.Int32 | Número do item. |
| Situacao | TipoSituacaoDocumentoEletronico | Situação do item. |
ItemPendenteRetorno
Representa documentos/eventos que ainda não realizaram o retorno.
Propriedades
| Propriedades | Tipo | Descrição |
| Chave | System.String | Chave/identificador do documento. |
| ChaveDocumento | System.String | Quando o item for um evento será a chave do documento vinculado a ele. Caso for um documento esse campo não será retornado. |
| TipoDocumento | System.Int32 | Tipo do documento. |
| TipoEvento | System.String | Somente será preenchido quando o item for um evento, será o código do evento de acordo com o manual da entidade autorizadora. Caso for um documento esse campo não será retornado. |
PendenteRetorno
Representa documentos que ainda não foram retornados pelo sistema.
Propriedades
| Propriedades | Tipo | Descrição | Implementações |
| Codigo | System.Nullable<System.Int64> | Código de erro caso a solicitação não seja atendida corretamente. | IRetornoRequisicaoSde.Codigo |
| Documentos | System.Collections.Generic.List<ItemPendenteRetorno> | Lista de documentos que ainda estão pendentes de retorno. | - |
| 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 |
RetornoConsultaBlocoX
Representa retorno das consultas de Bloco X
Propriedades
| Propriedades | Tipo | Descrição | Implementações |
| Codigo | System.Nullable<System.Int64> | Código retornado | IRetornoRequisicaoSde.Codigo |
| Identificador | System.String | Identificador de retorno | IRetornoRequisicaoSde.Identificador |
| Mensagem | System.String | Mensagem do retorno | IRetornoRequisicaoSde.Mensagem |
| Sucesso | System.Boolean | Situação do retorno | IRetornoRequisicaoSde.Sucesso |
| XmlRetorno | System.String | XML retornado da consulta. | - |
RetornoCriticas
Retorno com as críticas de integração consultadas.
Propriedades
| Propriedades | Tipo | Descrição | Implementações |
| Codigo | System.Nullable<System.Int64> | Código em casos de erro. | IRetornoRequisicaoSde.Codigo |
| 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 |
| Criticas | System.Collections.Generic.IList<CriticaIntegracaoRetorno> | Críticas de integração obedecendo filtros de tipo de documento e paginação. Preenchido quando for usado o método ObterCriticasIntegracao(String, String, Int64, Int32, Int32, Int32). | - |
| CriticasIdentificador | System.Collections.Generic.List<CriticaIdentificador> | Críticas de integração vinculadas a uma lista de identificadores informados na requisição. Preenchido quando for usado o método ObterCriticasPorIdentificador(String, String, Int32, List<String>). | - |
SituacaoCancelamento
Situação do cancelamento
Propriedades
| Propriedades | Tipo | Descrição |
| DataAutorizacao | System.Nullable<System.DateTime> | Data e hora de autorização se autorizado. |
| ProtocoloAutorizacao | System.String | Número do protocolo de autorização se autorizado. |
| Situacao | TipoSituacaoDocumentoEletronico | Situação do documento. |
SituacaoDocumento
Modelo para serialização da situação de documentos eletrônicos.
Construtuores
SituacaoDocumento()
Propriedades
| Propriedades | Tipo | Descrição | Implementações |
| Cancelamento | SituacaoCancelamento | Situação do cancelamento associado ao documento. Quando existir. Somente cancelamento que não é gerado via evento. | - |
| Codigo | System.Nullable<System.Int64> | 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. | IRetornoRequisicaoSde.Codigo |
| CodigoBarras | System.String | Valor do código de barras. Somente usado na consulta de GNRE. | - |
| CodigoMensagemAutorizador | System.Nullable<System.Int32> | 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. | - |
| DataAutorizacao | System.String | 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 |
- |
| DataConsulta | System.DateTime | Data da consulta de situação do documento. Retornará no formato yyyy-MM-ddTHH:mm:ss exemplo: 2018-08-25T18:45:30. |
- |
| DataRecepcao | System.String | 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. |
- |
| DetalhesCritica | System.Collections.Generic.List<DetalheCritica> | Quando rejeitado retorna delhes da critica (quando existir). Atualmente usado por: Receituário agronômico NFS-e eSocial REINF Recinto aduaneiro |
- |
| Documento | IdentificacaoDocumento | Dados de identificação do documento. | - |
| Eventos | System.Collections.Generic.List<SituacaoEvento> | Situação dos eventos associados ao documento. Para eSocial e REINF também serão retornados nessa lista os totalizadores vinculados a um evento. |
- |
| Gnres | System.Collections.Generic.List<SituacaoDocumento> | Situação das GNREs associadas ao documento. Somente retornado na consulta de NF-es e CT-es com GNREs vinculadas geradas pelo sistema. | - |
| Identificador | System.String | 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. | IRetornoRequisicaoSde.Identificador |
| Localizador | System.String | Localizador do documento. Usado somente para consulta de GNREs geradas pelo sistema. | - |
| Mensagem | System.String | Mensagem em casos de erro ou rejeição. | IRetornoRequisicaoSde.Mensagem |
| MensagemAutorizador | System.String | 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. | - |
| ProtocoloAutorizacao | System.String | Protocolo de autorização de uso do documento. | - |
| Situacao | TipoSituacaoDocumentoEletronico | Situação do documento. | - |
| Sucesso | System.Boolean | true se a requisição for finalizada com sucesso, false caso contrário. | IRetornoRequisicaoSde.Sucesso |
| TipoAmbiente | TipoAmbiente | Tipo de ambiente que o documento foi emitido. | - |
| TipoDocumento | TipoDocumentoEletronico | Tipo de documento. | - |
| XmlAutorizado | System.String | XML autorizado na Sefaz. | - |
| Auditoria | Auditoria | Dados da auditoria da NF-e recebida. | - |
SituacaoEvento
Situação de eventos associados a um documento.
Propriedades
| Propriedades | Tipo | Descrição |
| Codigo | System.Nullable<System.Int64> | Código da rejeição quando existir. Pode ser tanto a rejeição da entidade autorizadora quanto um código de rejeição do eDocs, para os códigos de rejeição que podem ser gerados pelo eDocs consultar TipoCodigoRetorno. |
| DataAutorizacao | System.String | Data de autorização do documento. Quando a entidade autorizadora retornar um fuso horário 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 |
| DataProcessamento | System.String | Data de processamento do evento formatado em yyyy-MM-ddTHH:mm:ss. |
| DetalhesCritica | System.Collections.Generic.List<DetalheCritica> | Quando rejeitado retorna detalhes da crítica. Somente usado para cancelamentos de receituário agronômico. |
| Itens | System.Collections.Generic.List<ItemEvento> | Itens do evento. Somente usado para pedidos de prorrogação de suspensão do ICMS. |
| Mensagem | System.String | Mensagem da rejeição quando existir. |
| ProtocoloAutorizacao | System.String | Número do protocolo de autorização se autorizado. |
| Sequencia | System.Nullable<System.Int32> | Indica o número sequencial do evento. |
| Situacao | TipoSituacaoDocumentoEletronico | Situação do evento. |
| TipoEvento | System.String | Tipo do evento. No caso de eventos fiscais será retornado o código do evento conforme manual da Sefaz. Para totalizadores do eSocial e REINF serão retornados o código do evento totalizador, exemplo S5011 para um totalizador do eSocial ou R5001 para o REINF. Para manutenção de Bloco X é preenchido de acordo com o TipoManutencaoBlocoX. |
| XmlAutorizado | System.String | XML autorizado na Sefaz. Retorna o conteúdo do XML em base64. |
English
Español
