Retornar as categorias por filtro

Request

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.

Security

BearerAuth

Query

paginanumberrequired

Página

Example:pagina=1

tamanho_paginanumberrequired

Tamanho da página

Enum:1020501002005001000

Example:tamanho_pagina=10

campo_ordenado_ascendentestring

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

Enum:"NOME""TIPO"

Example:campo_ordenado_ascendente=NOME

campo_ordenado_descendentestring

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'

Enum:"NOME""TIPO"

Example:campo_ordenado_descendente=TIPO

buscastring

Busca textual por nome ou código

Example:busca=010

tipostring

Tipo da categoria

Enum:"RECEITA""DESPESA"

Example:tipo=RECEITA

apenas_filhosboolean

Filtrar apenas categorias filhas

Example:apenas_filhos=true

nomestring

Nome da categoria

Example:nome=Eletrônicos

permite_apenas_filhosbooleanrequired

Permite apenas categorias filhas

Example:permite_apenas_filhos=true

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/categorias?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=NOME&campo_ordenado_descendente=TIPO&busca=010&tipo=RECEITA&apenas_filhos=true&nome=Eletr%C3%B4nicos&permite_apenas_filhos=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

itens_totaisinteger

Example:6

itensArray of objects(Categoria)

totaisobject(Totais)

Response

{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}