Plataforma e integrações
Auditoria
1 endpoints
POST
/api/audit/runExecutar auditoria fiscal
Executa a auditoria fiscal digital sobre as notas já armazenadas da empresa autenticada — sem gerar arquivo nem depender de validador externo. Escopo: NF-e (mod. 55), apenas notas de produção (homologação é ignorada). Roda duas regras: pulos/omissões na numeração (números ausentes entre o menor e o maior número autorizado, por série) e duplicidades (a mesma chave gravada mais de uma vez, ou o mesmo pedido autorizado mais de uma vez). O período é opcional; sem período, audita todas as notas da empresa.
Headers obrigatórios
| Header | Tipo | Descrição |
|---|---|---|
| token | string | Token da empresa |
| sign | string | Assinatura MD5 |
| timestamp | string | Unix timestamp em segundos |
Body — parâmetros (todos opcionais)
| Campo | Tipo | Descrição |
|---|---|---|
| month | number | Mês (1–12). Tem prioridade máxima: audita o mês inteiro. Combine com year. |
| year | number | Ano do month (padrão: ano corrente). Ignorado sem month. |
| start_date | string | Início do período, no formato dd/MM/aaaa ou dd/MM/aaaa HH:mm:ss. Sem a hora, assume 00:00:00. Fuso de São Paulo. Usado quando month não é enviado. |
| end_date | string | Fim do período (mesmo formato). O fim é exclusivo — para o mês inteiro, use o 1º dia do mês seguinte (ex.: 01/07/2026). |
| start_create_time | number | Início do período em Unix timestamp (milissegundos). Usado quando month e start_date/end_date não são enviados. |
| end_create_time | number | Fim do período em Unix timestamp (milissegundos, exclusivo). |
Todos os campos são opcionais. Precedência: month (+year) › start_date/end_date › start_create_time/end_create_time › nenhum (audita todas as notas).
Resposta — campos
| Campo | Tipo | Descrição |
|---|---|---|
| periodo | object | Período efetivamente auditado (fuso de São Paulo), com de e ate; null quando sem período (auditou tudo). |
| notas_puladas | array | Regra de numeração. Cada item = { serie, quantidade, notas }, onde notas são os números ausentes juntados por vírgula. |
| notas_duplicadas | array | Regra de duplicidade. Cada item traz quantidade + registros[] e é identificado por chave (mesmo documento gravado mais de uma vez) ou por pedido (mesmo pedido autorizado mais de uma vez). Cada registro = { serie, numero, chave, status, emitida_em }. |