---
title: "Totais agregados"
method: GET
path: "/v1/notas/resumo"
tags: ["Notas"]
---

# Totais agregados

`GET /v1/notas/resumo`

## Request

- Base URL: `https://api.notaguard.com.br`
- URL: `https://api.notaguard.com.br/v1/notas/resumo`
- Auth: HTTP bearer

Devolve contagem e soma de valores para os mesmos filtros da listagem, em uma única chamada. Use no lugar de paginar tudo e somar no cliente.

## Query parameters

- `tipo` string: Filtra por tipo. Aceita múltiplos separados por vírgula: `tipo=NFe,NFCe`. Valores aceitos: NFe, NFCe, NFSe.
- `status` string: Filtra por situação. Múltiplos separados por vírgula. Valores aceitos: autorizada, resumida, cancelada, denegada, desconhecido.
- `vinculo` string: 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.
- `manifestacao` string: Filtra pela manifestação registrada. Múltiplos separados por vírgula. Valores aceitos: ciencia, confirmacao, desconhecimento, nao_realizada.
- `data_ref_de` string: 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_ref_ate` string: Data de referência até, **inclusive o dia inteiro**. AAAA-MM-DD ou ISO 8601.
- `data_emissao_de` string: 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_emissao_ate` string: Data de emissão até, **inclusive o dia inteiro**. AAAA-MM-DD ou ISO 8601.
- `data_criacao_de` string: Filtra por quando o documento entrou no NotaGuard (`criada_em`), a partir de. AAAA-MM-DD ou ISO 8601.
- `data_criacao_ate` string: Filtra por quando o documento entrou no NotaGuard (`criada_em`), até, **inclusive o dia inteiro**. AAAA-MM-DD ou ISO 8601.
- `data_atualizacao_apos` string: 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_min` number: Valor mínimo. Documentos sem valor conhecido são excluídos quando este filtro é usado.
- `valor_max` number: Valor máximo. Documentos sem valor conhecido são excluídos quando este filtro é usado.
- `chave` string: Busca exata por chave de acesso.
- `numero` integer: Busca exata pelo número do documento.
- `documento_emissor` string: CNPJ ou CPF do emissor, somente dígitos.
- `busca` string: Busca textual em nome do emissor, chave e número. Use para consulta livre; para filtro exato prefira os parâmetros dedicados.
- `xml_completo_disponivel` 'true' | 'false': `true` retorna apenas documentos com XML completo disponível; `false`, apenas os que têm só o resumo.
- `etiqueta` string: 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`.
- `sem_etiqueta` string: 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.
- `cfop` string: 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.

## Response `200`

Agregado calculado.

- ResumoNotas
  - `total` integer, required: Quantidade de documentos que casam com os filtros.
  - `valor_total` number, required: Soma de `valor`. Documentos sem valor conhecido contam em `total` mas somam zero aqui, por isso `total_sem_valor` existe.
  - `total_sem_valor` integer, required: Quantos dos documentos contados não têm valor conhecido. Se for alto, `valor_total` subestima a realidade.

## Other responses

- `400`: Parâmetro inválido ou cursor corrompido.
- `401`: Chave ausente, inválida, revogada ou expirada.
- `403`: Escopo insuficiente ou plano sem acesso via API.
- `429`: Limite de requisições excedido.
- `500`: Erro interno.

---

[API](https://skmtc.dev/notaguard/apis/api-notaguard.md) · [All operations](https://skmtc.dev/notaguard/apis/api-notaguard/llms.txt) · [OpenAPI document](https://skmtc.dev/notaguard/apis/api-notaguard/revisions/118f819f30d6?raw)