Documentação da API

POST /get_categories

Resumo

Este endpoint retorna categorias com base nos parâmetros fornecidos pelo usuário.

Descrição

Utilize este endpoint para obter uma lista de categorias filtradas conforme os parâmetros passados na requisição.

---

Requisição

Body da Requisição

O corpo da requisição deve ser um objeto JSON e é obrigatório. A seguir estão os parâmetros aceitos:

Parâmetro	Tipo	Descrição	Exemplo
access_token	string	Token de acesso (obrigatório).	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_token	string	Token da unidade (obrigatório).	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
type	string	Filtro de tipo de transação: "in" para categorias utilizadas em receitas, "out" para categorias utilizadas em despesas (obrigatório).	"in" ou "out"
search	string	Não	Filtro por nome de categoria ou discrição.

---

Requisição de exemplo

curl -s 'https://portal.fipli.pro/api/v1/get_categories' -d '{"access_token": "<access_token>", "unit_token": "<unit_token>", "type": "<type>"}' -H 'Content-Type: application/json'

{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "type": "<type>"
}

Respostas

200 OK

Em caso de sucesso, a resposta terá o seguinte formato:

{
  "success": true,
  "data": [
    {
      "module_type": "<module_type>", //tipo para despesa ou receita.
      "category": "<category>", //nome da categoria
      "note": "<note>", //descrição da categoria
      "token": "<token>" //token único da categoria
    }
  ]
}

4xx e 5xx Erros

Em caso de erro, success sera igual a false, seguido por uma menssagem de erro, por exemplo:

{ 
  "success": false, 
  "error": "Missing parameters"
}