Skip to content
API/
/Categorias

Categorias

Consulta de categorias financeiras (classificação de receitas e despesas) e da configuração padrão de categorias por operação, apoiando o agrupamento e a geração de relatórios.

Operations

Retornar as categorias por filtro

Request

Security
BearerAuth
Query
paginainteger, >= 1

Número da página

Default:1
tamanho_paginainteger, [ 1 .. 1000 ]

Tamanho da página

Default:10
campo_ordenado_ascendentestring

Ordenação ascendente (case-insensitive)

Enum:"NOME""TIPO"
campo_ordenado_descendentestring

Ordenação descendente (case-insensitive)

Enum:"NOME""TIPO"
apenas_filhosboolean

Filtrar apenas categorias filhas

permite_apenas_filhosboolean

Permite apenas categorias filhas

tipostring

Tipo da categoria financeira

Enum:"RECEITA""DESPESA"
nomestring

Nome da categoria financeira

buscastring

Busca textual pela categoria

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/financeiro/categorias?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=NOME&campo_ordenado_descendente=NOME&apenas_filhos=true&permite_apenas_filhos=true&tipo=RECEITA&nome=string&busca=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
itensArray of objects(CategoriaFinanceira)

Itens de categorias financeiras

itens_totaisinteger

Total de itens encontrados

Example:100
Response
{
  "itens": [
    { … }
  ],
  "itens_totais": 100
}