Totais agregados

Filtra por tipo. Aceita múltiplos separados por vírgula: tipo=NFe,NFCe. Valores aceitos: NFe, NFCe, NFSe.

Filtra por situação. Múltiplos separados por vírgula. Valores aceitos: autorizada, resumida, cancelada, denegada, desconhecido.

Filtra pelo vínculo da sua empresa com o documento. Múltiplos separados por vírgula. indefinido retorna os documentos cujo vínculo ainda não foi determinado. Valores aceitos: emissor, receptor, transportador, terceiro, indefinido.

Filtra pela manifestação registrada. Múltiplos separados por vírgula. Valores aceitos: ciencia, confirmacao, desconhecimento, nao_realizada.

Data de referência a partir de (AAAA-MM-DD ou ISO 8601). A data de referência é a mesma da coluna "Data" do painel: emissão em NF-e e NFC-e, competência em NFS-e. Atenção: documentos sem essa data (só resumo) são excluídos quando este filtro é usado.

Data de referência até, inclusive o dia inteiro. AAAA-MM-DD ou ISO 8601.

Data de emissão a partir de (AAAA-MM-DD ou ISO 8601). Atenção: documentos sem data de emissão (só resumo) são excluídos quando este filtro é usado.

Data de emissão até, inclusive o dia inteiro. AAAA-MM-DD ou ISO 8601.

Filtra por quando o documento entrou no NotaGuard (criada_em), a partir de. AAAA-MM-DD ou ISO 8601.

Filtra por quando o documento entrou no NotaGuard (criada_em), até, inclusive o dia inteiro. AAAA-MM-DD ou ISO 8601.

Retorna apenas documentos alterados depois deste instante (AAAA-MM-DD ou ISO 8601). É o parâmetro recomendado para sincronização incremental: guarde o maior atualizada_em recebido e mande de volta na próxima chamada.

Valor mínimo. Documentos sem valor conhecido são excluídos quando este filtro é usado.

Valor máximo. Documentos sem valor conhecido são excluídos quando este filtro é usado.

Busca exata por chave de acesso.

Busca exata pelo número do documento.

CNPJ ou CPF do emissor, somente dígitos.

Busca textual em nome do emissor, chave e número. Use para consulta livre; para filtro exato prefira os parâmetros dedicados.

true retorna apenas documentos com XML completo disponível; false, apenas os que têm só o resumo.

Filtra por etiqueta aplicada no painel. etiqueta=centro-custo retorna notas que têm a etiqueta com qualquer valor; etiqueta=centro-custo:matriz filtra pelo valor (aceita o valor ou o rotulo da opção; em booleanas use true/false; em data use AAAA-MM-DD). Os slugs vêm de GET /v1/etiquetas.

Inverso de etiqueta, mesmo formato. sem_etiqueta=centro-custo retorna as notas que ainda não têm a etiqueta; sem_etiqueta=centro-custo:matriz retorna as que não têm esse valor, incluindo as sem a etiqueta. Serve para classificar em rodadas, pegando só o que falta.

Filtra por CFOP dos itens. Múltiplos separados por vírgula: cfop=5905,6905 retorna documentos com item em qualquer um deles. O CFOP vem dos itens do XML completo, então documentos sem extração completa são excluídos quando este filtro é usado; NFS-e não tem CFOP e também fica de fora.