--- title: "Resumo de NFSe´s." url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-Nfse-Resumo/get" --- > Full API specification: https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050.md # Resumo de NFSe´s. `GET` `/api/v1/Nfse/Resumo` Fornece dados totalizados e consolidados de notas fiscais de serviço 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. Os totais são agrupados por status: Aprovadas, Canceladas, Rejeitadas, Pendentes e Substituídas. ## Query parameters - `notaFiscalServicoId` (string, uuid, optional) - Filtrar pelo identificador único da nota fiscal de serviço no sistema. - `codigoErp` (string, optional) - Filtrar pelo código ERP. - `busca` (string, optional) - Filtrar pelo termo de busca genérica. - `numeroDps` (string, optional) - Filtrar pelo número sequencial da DPS. - `serie` (string, optional) - Filtrar pela série da DPS. - `chaves` (array, optional) - Filtrar pela lista de chaves (ChaveDps — 45 chars, ou ChaveNfse — 53 chars). - `documentoTomador` (string, optional) - Filtrar pelo documento (CPF/CNPJ) do tomador do serviço. - `nomeTomador` (string, optional) - Filtrar pelo nome ou razão social do tomador do serviço. - `documentoPrestador` (string, optional) - Filtrar pelo documento (CPF/CNPJ) do prestador do serviço. - `nomePrestador` (string, optional) - Filtrar pelo nome ou razão social do prestador do serviço. - `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. - `valorServicoInicial` (number, double, optional) - Filtrar pelo valor mínimo do serviço. - `valorServicoFinal` (number, double, optional) - Filtrar pelo valor máximo do serviço. - `status` (string, optional) - Filtrar pelo status atual da nota fiscal de serviç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/Nfse/Resumo: get: tags: - Nfse summary: Resumo de NFSe´s. description: >- Fornece dados totalizados e consolidados de notas fiscais de serviço 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. Os totais são agrupados por status: Aprovadas, Canceladas, Rejeitadas, Pendentes e Substituídas. parameters: - name: notaFiscalServicoId in: query description: Filtrar pelo identificador único da nota fiscal de serviço 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: numeroDps in: query description: Filtrar pelo número sequencial da DPS. schema: type: string - name: serie in: query description: Filtrar pela série da DPS. schema: type: string - name: chaves in: query description: Filtrar pela lista de chaves (ChaveDps — 45 chars, ou ChaveNfse — 53 chars). schema: type: array items: type: string - name: documentoTomador in: query description: Filtrar pelo documento (CPF/CNPJ) do tomador do serviço. schema: type: string - name: nomeTomador in: query description: Filtrar pelo nome ou razão social do tomador do serviço. schema: type: string - name: documentoPrestador in: query description: Filtrar pelo documento (CPF/CNPJ) do prestador do serviço. schema: type: string - name: nomePrestador in: query description: Filtrar pelo nome ou razão social do prestador do serviço. 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: valorServicoInicial in: query description: Filtrar pelo valor mínimo do serviço. schema: type: number format: double - name: valorServicoFinal in: query description: Filtrar pelo valor máximo do serviço. schema: type: number format: double - name: status in: query description: Filtrar pelo status atual da nota fiscal de serviço. schema: $ref: "#/components/schemas/StatusNotaFiscalServicoModelEnum" - name: DocumentoEmissor in: header description: Documento do emissor. required: true schema: type: string responses: "200": description: OK content: text/plain: schema: $ref: "#/components/schemas/ObterTotalizacaoListagemNfseViewModel" application/json: schema: $ref: "#/components/schemas/ObterTotalizacaoListagemNfseViewModel" text/json: schema: $ref: "#/components/schemas/ObterTotalizacaoListagemNfseViewModel" "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: StatusNotaFiscalServicoModelEnum: enum: - Pendente - Autorizada - Cancelada - Rejeitada - EmCancelamento - Substituida - Inutilizada type: string description: Status da nota fiscal de serviço. ObterTotalizacaoListagemNfseViewModel: type: object properties: quantidadeTotalNotas: type: integer description: Quantidade total de notas. format: int32 quantidadeTotalNotasAprovadas: type: integer description: Quantidade total de notas autorizadas. format: int32 quantidadeTotalNotasCanceladas: type: integer description: Quantidade total de notas canceladas. 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 quantidadeTotalNotasSubstituidas: type: integer description: Quantidade total de notas substituídas por nova emissão. format: int32 valorTotalNotas: type: number description: Valor total em notas fiscais de serviço. format: double valorTotalNotasAprovadas: type: number description: Valor total de notas autorizadas. format: double valorTotalNotasCanceladas: type: number description: Valor total de notas canceladas. 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 valorTotalNotasSubstituidas: type: number description: Valor total de notas substituídas por nova emissão. format: double additionalProperties: false description: Dados totalizados da listagem de notas fiscais de serviço (NFS-e Nacional). 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 ```