Skip to main content
GET
Status de sincronização de NF-e Recebidas

Authorizations

X-Api-Key
string
header
required

Authorization By X-Api-Key inside request's header

Response

OK

Situação atual da sincronização automática de notas fiscais recebidas da empresa.

lastNsu
integer<int64>

Último NSU (Número Sequencial Único) lido na distribuição de documentos fiscais. É o ponto de onde a próxima leitura continua; 0 indica que nenhuma sincronização foi concluída ainda.

lastSyncAt
string<date-time> | null

Data e hora da última sincronização concluída com sucesso, no fuso horário da empresa. Fica em branco enquanto nenhuma tiver sido concluída.

nextAllowedSyncAt
string<date-time> | null

A partir de quando uma nova sincronização pode ser solicitada, no fuso horário da empresa. A autoridade fiscal limita a frequência das consultas: pedidos feitos antes desse horário são recusados.

lastAttemptOutcome
enum<string>

Resultado da última tentativa de sincronização de notas fiscais recebidas.

Valores possíveis:

  • neverAttempted: Nenhuma sincronização foi tentada ainda.
  • synchronized: A consulta foi concluída e trouxe documentos novos.
  • upToDate: A consulta foi concluída e não havia documentos novos.
  • throttledByAuthority: A autoridade fiscal recusou a consulta por excesso de consultas e bloqueou o acesso temporariamente. As consultas são retomadas automaticamente depois do bloqueio.
  • communicationFailure: Não foi possível se comunicar com a autoridade fiscal. A consulta é refeita automaticamente.
  • unexpectedResponse: A autoridade fiscal respondeu em um formato fora do esperado. A consulta é refeita automaticamente.
  • documentApplyFailure: A consulta foi feita, mas um dos documentos recebidos não pôde ser processado. Os documentos lidos antes dele foram importados normalmente, e a leitura é retomada do mesmo ponto na próxima tentativa.
  • certificateMissingOrExpired: A empresa está com o recebimento de notas habilitado, mas não tem certificado digital válido — sem ele não é possível consultar a autoridade fiscal. Envie um certificado válido para que a sincronização volte a acontecer.
  • unexpectedError: A sincronização não pôde ser concluída por uma falha inesperada, antes de a consulta chegar à autoridade fiscal. A consulta é refeita automaticamente.
Available options:
neverAttempted,
synchronized,
upToDate,
throttledByAuthority,
communicationFailure,
unexpectedResponse,
documentApplyFailure,
certificateMissingOrExpired,
unexpectedError
lastAttemptMessage
string | null

Mensagem devolvida pela autoridade fiscal na última tentativa, quando houver. Ajuda a entender o motivo de uma recusa.

lastAttemptAt
string<date-time> | null

Data e hora da última tentativa, no fuso horário da empresa. Diferente da última sincronização, é preenchida também quando a tentativa não teve sucesso.