Pular para o conteúdo
notemnotemDocumentação

Referência da API › Sincronização

Consultar sincronização

Mostra quando a empresa foi sincronizada com o governo pela última vez e o resultado.

GET/api/v1/empresas/{id}/sincronizacao

A sincronização traz as notas que a empresa emitiu fora da notem e as notas que ela recebeu. Ela é iniciada no painel da notem; pela API só é possível consultar a situação, no ambiente da chave.

Parâmetros

idtextono caminhoobrigatório
Empresa da organização da chave (de outra organização → 404). UUID (RFC 9562); fora do padrão → 400 REQUISICAO_INVALIDA com campo id. · UUID

Respostas

200 Situação da sincronização

Campos da resposta
ambientetexto
Valores: homologacao, producao
situacaotexto
Valores: nunca_sincronizada, em_andamento, atualizada, erro
ultimo_nsuinteiro ou null
ultima_consultatexto ou null
data e hora ISO 8601
proxima_consulta_permitidatexto ou null
null quando já é possível sincronizar · data e hora ISO 8601
primeira_sincronizacao_concluida_emtexto ou null
data e hora ISO 8601
documentos_importadosinteiro
sincronizacao_em_andamentoobjeto ou null
sincronizacao_em_andamento.tipotexto
Valores: novidades, periodo
sincronizacao_em_andamento.mesesinteiro ou null
Valores: 1, 3, 6, 12, 24
sincronizacao_em_andamento.etapatexto
Valores: busca_inicio_periodo, importacao
sincronizacao_em_andamento.documentos_importadosinteiro
sincronizacao_em_andamento.solicitada_emtexto ou null
data e hora ISO 8601
ultima_sincronizacaoobjeto ou null
ultima_sincronizacao.tipotexto
Valores: novidades, periodo
ultima_sincronizacao.mesesinteiro ou null
ultima_sincronizacao.resultadotexto
Valores: concluida, interrompida
ultima_sincronizacao.concluida_emtexto ou null
data e hora ISO 8601
ultima_sincronizacao.documentos_importadosinteiro
ultima_sincronizacao.mensagemtexto ou null
ultimo_erroobjeto ou null
ultimo_erro.codigotexto ou null
ultimo_erro.mensagemtexto
verificacao_diariaobjeto
Verificação automática diária das notas emitidas pela notem com cancelamento pendente
verificacao_diaria.ultima_execucaotexto ou null
data e hora ISO 8601
verificacao_diaria.notas_verificadasinteiro
verificacao_diaria.notas_atualizadasinteiro

401 Chave ausente, inválida ou revogada

404 Erro no formato padrão

Limites

Esta operação: 30 por minuto. Valem também os limites gerais da chave. Veja Limites de uso.