Listar despesas e receitas

POST /

Resumo

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

Descrição

Utilize esta rota para obter uma lista de dados financeiros (despesas e receitas) filtrados conforme os parâmetros passados na requisição.

---

Requisição

Headers

• Content-Type: application/json

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).	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
unit_token	string	Token da unidade (obrigatório).	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
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
user_token	string	Filtro de despesa por coletor, retornará as movimentações inseridas por aquele coletor (opcional).	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	Retorno de todas movimentações da unidade.

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": "<access_token>", "unit_token": "<unit_token>", "from_date": "2024-07-01", "to_date": "2024-10-01", "type": "out"}' -H 'Content-Type: application/json'

{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "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_user": "<id_user>",
      "access_key": "<access_token>",
      "user_name": "<user_name>",
      "company_name": "<company_name>",
      "entity_name": "<entity_name>",
      "created_date": "<created_date>",
      "description": "<description>",
      "barcode": "<barcode>",
      "due_date": "<due_date>",
      "pay_day": "<pay_day>",
      "value": "<value>",
      "type": "<type>",
      "category": "<category>",
      "note": "<note>",
      "active": "<active>",
      "data_bank": "<data_bank>",
      "private": "<private>",
      "id_token_unit": "<id_token_unit>",
      "action_status": "<action_status>",
      "status": "<status>",
      "nick_name_bank": "<nick_name_bank>",
      "wallet": "<wallet>",
      "active_remittances": "<active_remittances>",
      "id_ofx": "<id_ofx>",
      "conciliation_date": "<conciliation_date>",
      "contact_name": "<contact_name>",
      "key_method_credor": "<key_method_credor>"
    }
  ]
}

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