---
title: "Resumo de NFCe´s."
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-Nfce-Resumo/get"
---

> Full API specification: https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050.md

# Resumo de NFCe´s.

`GET` `/api/v1/Nfce/Resumo`

Fornece dados <strong>totalizados e consolidados</strong> de notas fiscais de consumidor eletrônicas (NFCe) com base nos filtros aplicados. Este recurso é ideal para alimentar dashboards, painéis de conferência ou indicadores financeiros (KPIs), permitindo uma visão macro do volume de documentos e valores sem a necessidade de processar a listagem completa. A consulta suporta múltiplos critérios de filtragem, abrangendo desde dados básicos do documento (número, série, chave) até informações de atores envolvidos (participante, transportador e intermediador). 🔍 **DICA DE PERFORMANCE**: Para consultas em grandes volumes de dados, priorize o uso da <strong>Chave de Acesso</strong> ou o intervalo de <strong>Data de Emissão</strong> para garantir maior agilidade no retorno.

## Query parameters

- `notaFiscalId` (string, uuid, optional) - Filtrar pelo identificador único da nota fiscal no sistema.
- `codigoErp` (string, optional) - Filtrar pelo código ERP.
- `busca` (string, optional) - Filtrar pelo termo de busca genérica.
- `inscricaoEstadualEmissor` (string, optional) - Filtrar pela inscrição estadual do emissor do documento.
- `numeroDocumento` (string, optional) - Filtrar pelo número sequencial do documento fiscal.
- `serie` (string, optional) - Filtrar pela série do documento fiscal.
- `chaveAcesso` (array, optional) - Filtrar pel lista de chaves de acesso (44 dígitos).
- `documentoParticipante` (string, optional) - Filtrar pelo documento (CPF/CNPJ) do participante.
- `nomeParticipante` (string, optional) - Filtrar pel nome ou razão social do participante.
- `dataEmissaoInicial` (string, date-time, optional) - Filtrar documentos emitidos a partir desta data.
- `dataEmissaoFinal` (string, date-time, optional) - Filtrar documentos emitidos até esta data.
- `dataCancelamentoInicial` (string, date-time, optional) - Filtrar documentos cancelados a partir desta data.
- `dataCancelamentoFinal` (string, date-time, optional) - Filtrar documentos cancelados até esta data.
- `valorDocumentoInicial` (number, double, optional) - Filtrar pelo valor mínimo do documento.
- `valorDocumentoFinal` (number, double, optional) - Filtrar pel valor máximo do documento.
- `status` (string, optional) - Filtrar pelo status atual da nota fiscal.
- `consumidorFinal` (boolean, optional) - Filtrar pelo indicador do documento emitido para consumidor final.
- `documentoTransportador` (string, optional) - Filtrar pelo documento (CPF/CNPJ) da transportadora.
- `nomeTransportador` (string, optional) - Filtrar pelo nome ou razão Social da transportadora.
- `modalidadeFrete` (string, optional) - Filtrar pela modalidade do frete.
- `documentoIntermediador` (string, optional) - Filtrar pelo documento (CPF/CNPJ) do intermediador.
- `identificadorIntermediador` (string, optional) - Filtrar pelo identificador do intermediador na plataforma.
- `modoContingenciaOffline` (boolean, optional) - Filtrar por notas que foram geradas em modo de contingência offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.

## Header parameters

- `DocumentoEmissor` (string, required) - Documento do emissor.

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: Stone Tax API
  version: 1.0.0
servers:
  - url: https://stone-tax-sdx.stone.com.br
    description: Ambiente de Desenvolvimento
  - url: https://stone-tax.stone.com.br
    description: Ambiente de Produção
paths:
  /api/v1/Nfce/Resumo:
    get:
      tags:
        - Nfce
      summary: Resumo de NFCe´s.
      description: >-
        Fornece dados <strong>totalizados e consolidados</strong> de notas
        fiscais de consumidor eletrônicas (NFCe) com base nos filtros
        aplicados. 

        Este recurso é ideal para alimentar dashboards, painéis de conferência
        ou indicadores financeiros (KPIs), 

        permitindo uma visão macro do volume de documentos e valores sem a
        necessidade de processar a listagem completa.



        A consulta suporta múltiplos critérios de filtragem, abrangendo desde
        dados básicos do documento (número, série, chave) 

        até informações de atores envolvidos (participante, transportador e
        intermediador).


        🔍 **DICA DE PERFORMANCE**: Para consultas em grandes volumes de dados,
        priorize o uso da <strong>Chave de Acesso</strong> 

        ou o intervalo de <strong>Data de Emissão</strong> para garantir maior
        agilidade no retorno.
      parameters:
        - name: notaFiscalId
          in: query
          description: Filtrar pelo identificador único da nota fiscal no sistema.
          schema:
            type: string
            format: uuid
        - name: codigoErp
          in: query
          description: Filtrar pelo código ERP.
          schema:
            type: string
        - name: busca
          in: query
          description: Filtrar pelo termo de busca genérica.
          schema:
            type: string
        - name: inscricaoEstadualEmissor
          in: query
          description: Filtrar pela inscrição estadual do emissor do documento.
          schema:
            type: string
        - name: numeroDocumento
          in: query
          description: Filtrar pelo número sequencial do documento fiscal.
          schema:
            type: string
        - name: serie
          in: query
          description: Filtrar pela série do documento fiscal.
          schema:
            type: string
        - name: chaveAcesso
          in: query
          description: Filtrar pel lista de chaves de acesso (44 dígitos).
          schema:
            type: array
            items:
              type: string
        - name: documentoParticipante
          in: query
          description: Filtrar pelo documento (CPF/CNPJ) do participante.
          schema:
            type: string
        - name: nomeParticipante
          in: query
          description: Filtrar pel nome ou razão social do participante.
          schema:
            type: string
        - name: dataEmissaoInicial
          in: query
          description: Filtrar documentos emitidos a partir desta data.
          schema:
            type: string
            format: date-time
        - name: dataEmissaoFinal
          in: query
          description: Filtrar documentos emitidos até esta data.
          schema:
            type: string
            format: date-time
        - name: dataCancelamentoInicial
          in: query
          description: Filtrar documentos cancelados a partir desta data.
          schema:
            type: string
            format: date-time
        - name: dataCancelamentoFinal
          in: query
          description: Filtrar documentos cancelados até esta data.
          schema:
            type: string
            format: date-time
        - name: valorDocumentoInicial
          in: query
          description: Filtrar pelo valor mínimo do documento.
          schema:
            type: number
            format: double
        - name: valorDocumentoFinal
          in: query
          description: Filtrar pel valor máximo do documento.
          schema:
            type: number
            format: double
        - name: status
          in: query
          description: Filtrar pelo status atual da nota fiscal.
          schema:
            $ref: "#/components/schemas/StatusNotaFiscalModelEnum"
        - name: consumidorFinal
          in: query
          description: Filtrar pelo indicador do documento emitido para consumidor final.
          schema:
            type: boolean
        - name: documentoTransportador
          in: query
          description: Filtrar pelo documento (CPF/CNPJ) da transportadora.
          schema:
            type: string
        - name: nomeTransportador
          in: query
          description: Filtrar pelo nome ou razão Social da transportadora.
          schema:
            type: string
        - name: modalidadeFrete
          in: query
          description: Filtrar pela modalidade do frete.
          schema:
            $ref: "#/components/schemas/ModalidadeFreteNotaFiscalModelEnum"
        - name: documentoIntermediador
          in: query
          description: Filtrar pelo documento (CPF/CNPJ) do intermediador.
          schema:
            type: string
        - name: identificadorIntermediador
          in: query
          description: Filtrar pelo identificador do intermediador na plataforma.
          schema:
            type: string
        - name: modoContingenciaOffline
          in: query
          description: Filtrar por notas que foram geradas em modo de contingência
            offline, ou seja, sem comunicação com a SEFAZ no momento da emissão.
          schema:
            type: boolean
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/ObterTotalizacaoListagemViewModel"
            application/json:
              schema:
                $ref: "#/components/schemas/ObterTotalizacaoListagemViewModel"
            text/json:
              schema:
                $ref: "#/components/schemas/ObterTotalizacaoListagemViewModel"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
      security:
        - BearerAuth: []
security:
  - BearerAuth: []
components:
  schemas:
    StatusNotaFiscalModelEnum:
      enum:
        - Pendente
        - Autorizada
        - Cancelada
        - Inutilizada
        - Rejeitada
        - Denegada
        - EmCancelamento
        - EmContingencia
        - Substituida
      type: string
      description: Status do documento eletrônico.
    ModalidadeFreteNotaFiscalModelEnum:
      enum:
        - Cif
        - Fob
        - FretePorContaDeTerceiros
        - TransporteProprioRemetente
        - TransporteProprioDestinatario
        - SemOcorrenciaDeTransporte
      type: string
      description: Modalidade de frete.
    ObterTotalizacaoListagemViewModel:
      type: object
      properties:
        quantidadeTotalNotas:
          type: integer
          description: Quantidade total de notas.
          format: int32
        quantidadeTotalNotasAprovadas:
          type: integer
          description: Quantidade total de notas aprovadas.
          format: int32
        quantidadeTotalNotasCanceladas:
          type: integer
          description: Quantidade total de notas canceladas, em cancelamento ou
            inutilizadas.
          format: int32
        quantidadeTotalNotasRejeitadas:
          type: integer
          description: Quantidade total de notas rejeitadas.
          format: int32
        quantidadeTotalNotasPendentes:
          type: integer
          description: Quantidade total de notas pendentes de emissão.
          format: int32
        quantidadeTotalNotasEmContingencia:
          type: integer
          description: Quantidade total de notas geradas em contingência pendentes de
            transmissão.
          format: int32
        quantidadeTotalNotasSubstituidas:
          type: integer
          description: Quantidade total de notas substituidas por nota em contingencia
            devido a timed out na emissão.
          format: int32
        valorTotalNotas:
          type: number
          description: Valor total em notas fiscais.
          format: double
        valorTotalNotasAprovadas:
          type: number
          description: Valor total de notas aprovadas.
          format: double
        valorTotalNotasCanceladas:
          type: number
          description: Valor total de notas canceladas, em cancelamento ou inutilizadas.
          format: double
        valorTotalNotasRejeitadas:
          type: number
          description: Valor total de notas rejeitadas.
          format: double
        valorTotalNotasPendentes:
          type: number
          description: Valor total de notas pendentes de emissão.
          format: double
        valorTotalNotasEmContingencia:
          type: number
          description: Valor total de notas geradas em contingência pendentes de
            transmissão.
          format: double
        valorTotalNotasSubstituidas:
          type: number
          description: Valor total de notas substituidas por nota em contingencia devido a
            timed out na emissão.
          format: double
      additionalProperties: false
      description: Dados totalizados da listagem de notas fiscais.
    ResponseErrorResult:
      type: object
      properties:
        status:
          type: integer
          format: int32
        titulo:
          type: string
          nullable: true
        erros:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      description: Autenticação via token JWT. Obtenha o token através do endpoint
        /Autenticacao/ObterToken usando Basic Auth. O token expira em 1 hora.
      scheme: bearer
      bearerFormat: JWT
```