Documentação da API

POST /

Resumo

Este endpoint retorna despesas e receitas com base nos parâmetros fornecidos pelo usuário.

Descrição

Utilize este endpoint para obter uma lista de dados financeiros (despesas e receitas) filtrados 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	Padrão
access_token	string	Token de acesso (obrigatório).	b31643fc-a45f-448c-99ee-736a547f6989	-
unit_token	string	Token da unidade (obrigatório).	e6988e9e-b0c1-410c-ae08-aed7c64ac71f	-
from_date	string	Data inicial do filtro no formato YYYY-MM-DD (opcional).	"2024-07-01"	"Começo do mês atual. Exemplo: 2024-10-01"
to_date	string	Data final do filtro no formato YYYY-MM-DD (opcional).	"2024-10-01"	"Hoje"
type	string	Filtro de tipo de transação: "in" para receitas, "out" para despesas (opcional).	"in" ou "out"	Ambos os tipos serão retornados

Observação: O intervalo máximo permitido entre from_date e to_date é de um ano. Se o intervalo for superior a um ano, a requisição será rejeitada.

---

Requisição de exemplo

curl -s 'https://portal.fipli.pro/api/v1/' -d '{"access_token": "b31643fc-a45f-448c-99ee-736a547f6989", "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f", "from_date": "2024-07-01", "to_date": "2024-10-01", "type": "out"}' -H 'Content-Type: application/json' -H 'userlogged: <jwt>'

{
  "access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
  "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
  "from_date": "2024-07-01",
  "to_date": "2024-10-01",
  "type": "out"
}

Respostas

200 OK

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

{
  "success": true,
  "data": [
    {
      "id": "1277",
      "access_key": null,
      "user_name": "Marcos",
      "company_name": "Teste Unidade",
      "entity_name": "Nome da Entidade",
      "created_date": "02/09/2024 12:07",
      "description": "Descrição da Despesa ou Receita",
      "barcode": null,
      "due_date": "02/09/2024",
      "pay_day": "10/09/2024",
      "value": -12.07,
      "type": "out",
      "category": "Categoria Despesa",
      "note": "Categoria Despesa",
      "active": true,
      "data_bank": null,
      "private": true,
      "id_token_unit": "e2308ef3-c10a-4f61-887e-eec5876057a7",
      "action_status": "4",
      "nick_name_bank": "Saldo",
      "wallet": "Banco",
      "name_project": "Nome do Projeto",
      "active_remittances": null,
      "id_ofx": "bsfbfsbfbs",
      "conciliation_date": "17/09/2024",
      "contact_name": "11.111.111 RUTE MARIA DOS SANTOS",
      "key_method_credor": "TED"
    }
  ]
}

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"
}