# Retornar as categorias por filtro

Permite listar as categorias utilizadas para classificação de receitas ou despesas. Auxilia no controle, agrupamento e geração de relatórios financeiros baseados em categorias.

Endpoint: GET /v1/categorias
Version: v1
Security: BearerAuth

## Security:

  - `BearerAuth` (unknown)
    http bearer JWT

## Query parameters:

  - `pagina` (number, required)
    Página

  - `tamanho_pagina` (number, required)
    Tamanho da página

  - `campo_ordenado_ascendente` (string)
    Campo para ordenação ascendente. Se informado ele desconsidera o valor do  campo_ordenado_descendente. É possível ordenar por 'NOME' ou 'TIPO'

  - `campo_ordenado_descendente` (string)
    Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não  deverá ser informado. É possível ordenar por 'NOME' ou 'TIPO'

  - `busca` (string)
    Busca textual por nome ou código

  - `tipo` (string)
    Tipo da categoria

  - `apenas_filhos` (boolean)
    Filtrar apenas categorias filhas

  - `nome` (string)
    Nome da categoria

  - `permite_apenas_filhos` (boolean, required)
    Permite apenas categorias filhas

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `itens_totais` (integer)
    Example: 6

  - `itens` (array)

  - `itens.id` (string)
    Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b

  - `itens.versao` (integer)
    Example: 0

  - `itens.nome` (string)
    Example: Eletrônicos

  - `itens.categoria_pai` (string)
    Example: 3d39b8d2-8b16-42d6-abd8-6cfd9d2e06c4

  - `itens.tipo` (string)
    Example: RECEITA

  - `itens.entrada_dre` (string)
    Example: DESPESAS_ADMINISTRATIVAS

  - `itens.considera_custo_dre` (boolean)
    Example: true

  - `totais` (object)

  - `totais.ativo` (integer)
    Total de centros de custo ativos
    Example: 6

  - `totais.inativo` (integer)
    Total de centros de custo inativos
    Example: 0

  - `totais.todos` (integer)
    Total de centros de custo
    Example: 6

## Response 400:

  - `400` (unknown)
    Bad Request

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 429:

  - `429` (unknown)
    Too Many Requests

## Response 500:

  - `500` (unknown)
    Internal Server Error