NFS-e Recebidas

Status de sincronização de NFS-e Recebidas

Retorna o status da sincronização: quando foi a última e a partir de quando uma nova sincronização é permitida, respeitando o intervalo mínimo entre chamadas.

get/v1/inbound-service-invoices/sync-status

Request

  • Base URL: https://api.spedy.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api.spedy.com.br/v1/inbound-service-invoices/sync-status
  • Auth: API key in header X-Api-Key

Response

OK

lastNsuinteger

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

lastSyncAtstring date-time nullable

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.

nextAllowedSyncAtstring date-time nullable

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'neverAttempted' | 'synchronized' | 'upToDate' | 'throttledByAuthority' | 'communicationFailure' | 'unexpectedResponse' | 'documentApplyFailure' | 'certificateMissingOrExpired' | 'unexpectedError'

Resultado da última tentativa de sincronização de notas fiscais recebidas.<p>Valores possíveis:</p>

<ul> <li><b>neverAttempted</b>: Nenhuma sincronização foi tentada ainda.</li> <li><b>synchronized</b>: A consulta foi concluída e trouxe documentos novos.</li> <li><b>upToDate</b>: A consulta foi concluída e não havia documentos novos.</li> <li><b>throttledByAuthority</b>: A autoridade fiscal recusou a consulta por excesso de consultas e bloqueou o acesso temporariamente. As consultas são retomadas automaticamente depois do bloqueio.</li> <li><b>communicationFailure</b>: Não foi possível se comunicar com a autoridade fiscal. A consulta é refeita automaticamente.</li> <li><b>unexpectedResponse</b>: A autoridade fiscal respondeu em um formato fora do esperado. A consulta é refeita automaticamente.</li> <li><b>documentApplyFailure</b>: 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.</li> <li><b>certificateMissingOrExpired</b>: 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.</li> <li><b>unexpectedError</b>: 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.</li> </ul>
lastAttemptMessagestring nullable

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

lastAttemptAtstring date-time nullable

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.

Changes

No recorded changes to this operation across all 1 revision of this API.