---
title: "Códigos de benefício - Listar."
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-RecursosAdicionais-CodigoBeneficio-Listar/get"
---

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

# Códigos de benefício - Listar.

`GET` `/api/v1/RecursosAdicionais/CodigoBeneficio/Listar`

Permite a consulta e listagem dos <strong>códigos de benefício fiscal</strong> parametrizados na plataforma. Este recurso é essencial para a correta identificação de incentivos fiscais vinculados a determinados produtos ou operações, garantindo a conformidade na emissão de documentos fiscais eletrônicos. 🔍 **FILTROS**: A busca pode ser refinada combinando o código técnico do benefício, termos contidos em sua descrição ou restringindo os resultados a uma <strong>Unidade Federativa (UF)</strong> específica. 📑 **PAGINAÇÃO**: O retorno é paginado, permitindo o controle de fluxo de dados através dos parâmetros de offset e limit.

## Query parameters

- `codigoBeneficio` (string, optional) - Filtrar pelo código do benefício.
- `busca` (string, optional) - Filtrar por campo de busca genérico.
- `uf` (string, optional) - Filtrar pela Unidade Federativa (UF).
- `offset` (integer, int32, optional) - Paginação da listagem - offset.
- `limit` (integer, int32, optional) - Paginação da listagem - limit.

## Header parameters

- `DocumentoEmissor` (string, optional) - 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/RecursosAdicionais/CodigoBeneficio/Listar:
    get:
      tags:
        - RecursosAdicionais
      summary: Códigos de benefício - Listar.
      description: >-
        Permite a consulta e listagem dos <strong>códigos de benefício
        fiscal</strong> parametrizados na plataforma. 

        Este recurso é essencial para a correta identificação de incentivos
        fiscais vinculados a determinados produtos ou operações, 

        garantindo a conformidade na emissão de documentos fiscais eletrônicos.


        🔍 **FILTROS**: A busca pode ser refinada combinando o código técnico do
        benefício, termos contidos em sua descrição 

        ou restringindo os resultados a uma <strong>Unidade Federativa
        (UF)</strong> específica.


        📑 **PAGINAÇÃO**: O retorno é paginado, permitindo o controle de fluxo
        de dados através dos parâmetros de offset e limit.
      parameters:
        - name: codigoBeneficio
          in: query
          description: Filtrar pelo código do benefício.
          schema:
            type: string
        - name: busca
          in: query
          description: Filtrar por campo de busca genérico.
          schema:
            type: string
        - name: uf
          in: query
          description: Filtrar pela Unidade Federativa (UF).
          schema:
            $ref: "#/components/schemas/UfCodigoBeneficioModelEnum"
        - name: offset
          in: query
          description: Paginação da listagem - offset.
          schema:
            type: integer
            format: int32
            default: 1
        - name: limit
          in: query
          description: Paginação da listagem - limit.
          schema:
            type: integer
            format: int32
            default: 10
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/ListarCodigosBeneficioViewModelListPaginationRespon\
                  se"
            application/json:
              schema:
                $ref: "#/components/schemas/ListarCodigosBeneficioViewModelListPaginationRespon\
                  se"
            text/json:
              schema:
                $ref: "#/components/schemas/ListarCodigosBeneficioViewModelListPaginationRespon\
                  se"
        "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:
    UfCodigoBeneficioModelEnum:
      enum:
        - RO
        - AC
        - AM
        - RR
        - PA
        - AP
        - TO
        - MA
        - PI
        - CE
        - RN
        - PB
        - PE
        - AL
        - SE
        - BA
        - MG
        - ES
        - RJ
        - SP
        - PR
        - SC
        - RS
        - MS
        - MT
        - GO
        - DF
      type: string
      description: Unidade Federativa.
    ListarCodigosBeneficioViewModelListPaginationResponse:
      type: object
      properties:
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        data:
          type: array
          items:
            $ref: "#/components/schemas/ListarCodigosBeneficioViewModel"
          nullable: true
      additionalProperties: false
    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
    ListarCodigosBeneficioViewModel:
      type: object
      properties:
        codigo:
          type: string
          description: Código do benefício fiscal.
          nullable: true
        descricao:
          type: string
          description: Descrição detalhada do benefício.
          nullable: true
        uf:
          $ref: "#/components/schemas/UfCodigoBeneficioModelEnum"
      additionalProperties: false
      description: Dados de listagem do código de benefício fiscal.
  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
```