Categorias
Categorias formam o plano de contas: as categorias de receita e de despesa usadas para classificar cada lançamento. Cada categoria pode ser ligada a uma linha da Demonstração do Resultado do Exercício (DRE). As linhas da DRE são fixas no sistema. Corresponde à aba Categorias da tela Configurações do menu Financeiro.
Os endereços a seguir são relativos a https://api.pedagogo.app. Este recurso é identificado pelo uuid.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /financial/settings/categories | Lista as categorias |
| POST | /financial/settings/categories | Cadastra uma categoria |
| GET | /financial/settings/categories/{uuid} | Consulta uma categoria |
| PUT | /financial/settings/categories/{uuid} | Altera uma categoria |
| DELETE | /financial/settings/categories/{uuid} | Apaga uma categoria |
| GET | /financial/settings/income-statements | Linhas da DRE (lista de apoio) |
| GET | /financial/settings/income-statements/{release_type_id} | Linhas da DRE de um tipo de lançamento (lista de apoio) |
| GET | /financial/settings/release-types | Tipos de lançamento (lista de apoio) |
Cadastrar
POST /financial/settings/categories
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
release_type_id | Sim | Número | Tipo: 1 para crédito (receita) e 2 para débito (despesa). Use um id de /financial/settings/release-types |
category | Não | Texto | Nome da categoria |
income_statement_id | Não | Número | Linha da DRE (id de /financial/settings/income-statements) |
Resposta (200): a categoria criada, com o uuid.
curl -X POST https://api.pedagogo.app/financial/settings/categories \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"release_type_id": 2, "category": "Categoria exemplo"}'
Listar
GET /financial/settings/categories
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
search | Texto livre. Busca no nome da categoria e no tipo |
release_type_id | Filtra pelo tipo de lançamento |
column e order | Ordena pela coluna informada e pelo sentido (asc ou desc). Sem eles, a lista vem em ordem alfabética pelo nome da categoria |
per_page e page | Paginação, conforme Convenções |
Resposta (200): lista com uuid, category, release_type_id, release_type, income_statement_id, income_statement e os nomes de quem criou e alterou o registro.
Consultar, alterar e apagar
GET /financial/settings/categories/{uuid}
Devolve a categoria com o uuid informado.
PUT /financial/settings/categories/{uuid}
Altera uma categoria. Envie somente os campos que mudam.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
release_type_id | Não | Número | Tipo do lançamento |
category | Não | Texto | Nome da categoria |
income_statement_id | Não | Número | Linha da DRE |
Resposta (200): a categoria alterada.
DELETE /financial/settings/categories/{uuid}
Apaga a categoria. Resposta 200, sem corpo.
Linhas da DRE
GET /financial/settings/income-statements
Linhas da Demonstração do Resultado do Exercício disponíveis para ligar uma categoria. Cada linha tem id, income_statement, release_type_id e release_type. Aceita search, column, order, per_page e page.
GET /financial/settings/income-statements/{release_type_id}
Mesma lista, filtrada pelo tipo de lançamento informado no caminho (1 para receita e 2 para despesa).
Tipos de lançamento
GET /financial/settings/release-types
Tipos de lançamento que o usuário pode escolher: Crédito (1), receita, e Débito (2), despesa. Resposta com id e release_type.
As listas de tipo de lançamento de outras telas estão descritas em Contas a pagar, Contas a receber e Movimentação financeira.