Documentação da API

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).	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
user_token	string	Filtro de despesa por coletor, retornará as movimentações inseridas por aquele coletor (opcional).	aaa4db48-a415-4996-b02d-3203c343ccbc	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": "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"
}

POST /insert_expense

Resumo

Rota para inserção de novas despesas no sistema com tratamento de arquivos anexados.

Descrição

Esta rota permite a criação de registros de despesas com validação de dados, tratamento de valores financeiros e upload de arquivos associados (PDFs, imagens e outros documentos).

---

Requisição

Headers

• Content-Type: multipart/form-data

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
category_id	string	ID da categoria de despesa (obrigatório)	3471754a-3419-4236-8104-8c73969c65a9	-
prev_value	number	Valor base da despesa (obrigatório)	30.5	-
due_date	string	Data de vencimento (AAAA-MM-DD) (obrigatório)	2025-03-20	-
description	string	Descrição da despesa (Máximo 255 caracteres) (opcional)	descrição da despesa	-
barcode	string	Código de barras (para boletos) (Máximo 50 caracteres) (opcional)	82650000001907700970910730452087432916773187	-
access_key	string	Chave de acesso (para cupons fiscais) (Máximo 50 caracteres) (opcional)	82650000001907700970910730452087432916773183	-
pay_day	string	Data de pagamento (AAAA-MM-DD) (opcional)	2025-03-15	-
id_action	number	ID do tipo de ação (Entre 1 e 8) (opcional)	1	1
id_bank_account	string	ID da conta bancária (opcional)	9cbbe31c-d2a8-4d62-9b9d-1e7fadeac8b4	-
id_bank_account_out	string	ID da conta bancária de saída (opcional)	9e27a1b2-7b47-48a2-9e34-cf7b6bbb8cb5	-
discounts	number	Valor de descontos (opcional)	10	-
interest	number	Valor de juros (opcional)	4	-
installment	string	Número de parcelas (opcional)	002/010	-
data_bank	text	Dados bancários (opcional)	3	-

Anexos de Arquivos:

• file: Arquivo principal (PDF ou imagem), apenas um permitido
• other_files: Arquivos adicionais, pode ter varios arquivos

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Expense inserted successfuly",
  "data": {
    "id": "<id_do_token_da_despesa>"
  }
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/insert_expense' \
    -F 'metadata={
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "description": "test",
            "barcode": "82650000001907700970910730452087432916773187",
            "due_date": "2025-05-08",
            "pay_day": "2025-05-08",
            "category_id": "3471754a-3419-4236-8104-8c73969c65a9",
            "id_action": "1",
            "id_bank_account": "9cbbe31c-d2a8-4d62-9b9d-1e7fadeac8b4",
            "id_bank_account_out": "9e27a1b2-7b47-48a2-9e34-cf7b6bbb8cb5",
            "id_contact": "7a1f34cd-0831-415d-bbca-bea7b7a7bd06",
            "id_project": "f6c60109-6186-47a6-9ac7-393037b7f9d7",
            "prev_value": 10,
            "discounts": 2,
            "interest": 4,
            "installment": "002/010",
            "data_bank": "test"
        };type=application/json' \
    -F 'file=@./arquivo1.pdf' \
    -F 'other_files=@./arquivo2.pdf' \
    -F 'other_files=@./arquivo3.pdf' \
    | jq

Observações Importantes

• Validação de intervalo máximo de 1 ano para datas

• Uploads simultâneos para armazenamento em nuvem

• Tipos de arquivo suportados: PDF, imagens (JPG, PNG) e outros documentos

• Permitido apenas um entre boleto(barcode) ou nota fiscal(access_key)

• Apenas categorias de despesas podem ser atreladas a despesa

• O conteúdo JSON deve ser enviado como parte do formulário (multipart/form-data), dentro de um campo específico chamado 'metadata', e não no corpo bruto da requisição.

POST /update_expense

Resumo

Rota para atualizar despesas no sistema com tratamento de arquivos anexados.

Descrição

Esta rota é responsável por atualizar registros de despesas existentes no sistema. Ela permite a modificação parcial ou completa dos dados de uma despesa, incluindo valores, datas, categorias e informações relacionadas.

---

Requisição

Headers

• Content-Type: multipart/form-data

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
id_expense	string	ID da despesa (obrigatório)	77d5bc16-780f-438c-8665-s8cb7ccdbe66	-
category_id	string	ID da categoria de despesa (obrigatório)	3471754a-3419-4236-8104-8c73969c65a9	-
prev_value	number	Valor base da despesa (obrigatório)	30.5	-
due_date	string	Data de vencimento (AAAA-MM-DD) (obrigatório)	2025-03-20	-
description	string	Descrição da despesa (Máximo 255 caracteres) (opcional)	descrição da despesa	-
barcode	string	Código de barras (para boletos) (Máximo 50 caracteres) (opcional)	82650000001907700970910730452087432916773187	-
access_key	string	Chave de acesso (para cupons fiscais) (Máximo 50 caracteres) (opcional)	82650000001907700970910730452087432916773183	-
pay_day	string	Data de pagamento (AAAA-MM-DD) (opcional)	2025-03-15	-
id_action	number	ID do tipo de ação (Entre 1 e 8) (opcional)	1	1
id_bank_account	string	ID da conta bancária (opcional)	9cbbe31c-d2a8-4d62-9b9d-1e7fadeac8b4	-
id_bank_account_out	string	ID da conta bancária de saída (opcional)	9e27a1b2-7b47-48a2-9e34-cf7b6bbb8cb5	-
discounts	number	Valor de descontos (opcional)	10	-
interest	number	Valor de juros (opcional)	4	-
installment	string	Número de parcelas (opcional)	002/010	-
data_bank	text	Dados bancários (opcional)	3	-

Anexos de Arquivos:

• file: Arquivo principal (PDF ou imagem), apenas um permitido

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Expense updated successfuly",
  "data": null
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/update_expense' \
    -F 'metadata={
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "id_expense": "956a487e-7ea4-433e-bc91-ad7fc5bb0303",
            "description": "Descrição da despesa",
            "barcode": "82650000001907700970910730452087432916773187",
            "due_date": "2025-05-08",
            "pay_day": "2025-05-08",
            "category_id": "3471754a-3419-4236-8104-8c73969c65a9",
            "id_action": "1",
            "id_bank_account": "9cbbe31c-d2a8-4d62-9b9d-1e7fadeac8b4",
            "id_bank_account_out": "9e27a1b2-7b47-48a2-9e34-cf7b6bbb8cb5",
            "id_contact": "7a1f34cd-0831-415d-bbca-bea7b7a7bd06",
            "id_project": "f6c60109-6186-47a6-9ac7-393037b7f9d7",
            "prev_value": 10,
            "discounts": 2,
            "interest": 4,
            "installment": "002/010",
            "data_bank": "Dados bancários"
        };type=application/json' \
    -F 'file=@./arquivo.pdf' \
    | jq

Observações Importantes

• Validação de intervalo máximo de 1 ano para datas

• Uploads simultâneos para armazenamento em nuvem

• Tipos de arquivo suportados: PDF, imagens (JPG, PNG) e outros documentos

• Permitido apenas um entre boleto(barcode) ou nota fiscal(access_key)

• Apenas categorias de despesas podem ser atreladas a despesa

• O conteúdo JSON deve ser enviado como parte do formulário (multipart/form-data), dentro de um campo específico chamado 'metadata', e não no corpo bruto da requisição.

POST /list_expense_files

Resumo

Rota para listar arquivos em despesas do sistema.

Descrição

Esta rota é responsável por listar arquivos associados as despesas existentes no sistema.

---

Requisição

Headers

• Content-Type: application/json

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
id_expense	string	ID da despesa (obrigatório)	77d5bc16-780f-438c-8665-s8cb7ccdbe66	-

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Expense files listed successfuly",
  "data": [
    {
      "file": "abd3de9f4cb0bdf13f599025abc693fd.pdf",
      "type": "application/pdf",
      "file_name": "arquivo1.pdf",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    },
    {
      "file": "5042e8fd4736e8249f5aa0d8ab002cad.pdf",
      "type": "application/pdf",
      "file_name": "arquivo2.pdf",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    },
    {
      "file": "2fce237c1ec5b477c55c0ca382706d8d.pdf",
      "type": "application/pdf",
      "file_name": "arquivo3.pdf",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    }
  ]
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/list_expense_files' \
    -d '{
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "id_expense": "956a487e-7ea4-433e-bc91-ad7fc5bb0303"
        }' \
    -H 'Content-Type: application/json' \
    | jq

POST /insert_expense_files

Resumo

Rota para inserir arquivos em despesas do sistema.

Descrição

Esta rota é responsável por inserir arquivos em despesas existentes no sistema. Esses arquivos não são a despesa em si, mas arquivos associados a ela.

---

Requisição

Headers

• Content-Type: multipart/form-data

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
id_expense	string	ID da despesa (obrigatório)	77d5bc16-780f-438c-8665-s8cb7ccdbe66	-

Anexos de Arquivos:

• other_files: Arquivos adicionais, pode ter varios arquivos (obrigatório)

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Expense files inserted successfuly",
  "data": null
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/insert_expense_files' \
    -d '{
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "id_expense": "956a487e-7ea4-433e-bc91-ad7fc5bb0303"
        }' \
    | jq

POST /delete_expense_files

Resumo

Rota para excluir arquivos específicos em despesas do sistema.

Descrição

Esta rota é responsável por deletar arquivos específicos associados as despesas existentes no sistema.

---

Requisição

Headers

• Content-Type: application/json

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
id_expense	string	ID da despesa (obrigatório)	77d5bc16-780f-438c-8665-s8cb7ccdbe66	-
filenames	array	Lista de nome dos arquivos para deletar. Podem ser achados na rota /list_expense_files, sendo o file que aparece na resposta. (obrigatório)	["34790e0336e9304294f3fcac0b31005b.pdf"]	-

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Expense files deleted successfuly",
  "data": null
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/delete_expense_files' \
    -d '{
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "id_expense": "956a487e-7ea4-433e-bc91-ad7fc5bb0303",
            "filenames": ["34790e0336e9304294f3fcac0b31005b.pdf"]
        }' \
    -H 'Content-Type: application/json' \
    | jq

POST /insert_income

Resumo

Esta rota é responsável por inserir um novo registro de receita no sistema.

Descrição

Esta rota permite a criação de registros de receitas com validação de dados, tratamento de valores financeiros e upload de arquivos associados (PDFs, imagens e outros documentos).

---

Requisição

Headers

• Content-Type: multipart/form-data

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
category_id	string	ID da categoria de receita (obrigatório)	3471754a-3419-4236-8104-8c73969c65a9	-
prev_value	number	Valor base da receita (obrigatório)	30.5	-
due_date	string	Data de vencimento (AAAA-MM-DD) (obrigatório)	2025-03-20	-
description	string	Descrição da receita (Máximo 255 caracteres) (opcional)	descrição da receita	-
pay_day	string	Data de pagamento (AAAA-MM-DD) (opcional)	2025-03-15	-
id_action	number	ID do tipo de ação (Entre 1 e 8) (opcional)	1	1
id_bank_account	string	ID da conta bancária (opcional)	9cbbe31c-d2a8-4d62-9b9d-1e7fadeac8b4	-
id_bank_account_out	string	ID da conta bancária de saída (opcional)	9e27a1b2-7b47-48a2-9e34-cf7b6bbb8cb5	-
discounts	number	Valor de descontos (opcional)	10	-
interest	number	Valor de juros (opcional)	4	-
data_bank	text	Dados bancários (opcional)	3	-
id_product	text	Produto ou serviço (opcional)
367e1e20-375a-45ee-9dc7-4f1ae38902c9
quantity_product	number	Quantidade de produto ou serviço (opcional)
10

Anexos de Arquivos:

• other_files: Arquivos adicionais, pode ter varios arquivos

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Income inserted successfuly",
  "data": {
    "id": "<id_do_token_da_despesa>"
  }
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/insert_income' \
    -F 'metadata={
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "description": "test",
            "due_date": "2025-05-08",
            "pay_day": "2025-05-08",
            "category_id": "3471754a-3419-4236-8104-8c73969c65a9",
            "id_action": "1",
            "id_bank_account": "9cbbe31c-d2a8-4d62-9b9d-1e7fadeac8b4",
            "id_bank_account_out": "9e27a1b2-7b47-48a2-9e34-cf7b6bbb8cb5",
            "id_contact": "7a1f34cd-0831-415d-bbca-bea7b7a7bd06",
            "id_project": "f6c60109-6186-47a6-9ac7-393037b7f9d7",
            "prev_value": 10,
            "discounts": 2,
            "interest": 4,
            "data_bank": "test"
        };type=application/json' \
    -F 'other_files=@./arquivo1.pdf' \
    -F 'other_files=@./arquivo2.pdf' \
    | jq

Observações Importantes

• Validação de intervalo máximo de 1 ano para datas

• Uploads simultâneos para armazenamento em nuvem

• Tipos de arquivo suportados: PDF, imagens (JPG, PNG) e outros documentos

• O conteúdo JSON deve ser enviado como parte do formulário (multipart/form-data), dentro de um campo específico chamado 'metadata', e não no corpo bruto da requisição.

POST /update_income

Resumo

Rota para atualizar receitas no sistema.

Descrição

Esta rota é responsável por atualizar registros de receitas existentes no sistema. Ela permite a modificação parcial ou completa dos dados de uma receita, incluindo valores, datas, categorias e informações relacionadas.

---

Requisição

Headers

• Content-Type: application/json

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
id_income	string	ID da receita (obrigatório)	77d5bc16-780f-438c-8665-s8cb7ccdbe66	-
category_id	string	ID da categoria de despesa (obrigatório)	3471754a-3419-4236-8104-8c73969c65a9	-
prev_value	number	Valor base da receita (obrigatório)	30.5	-
due_date	string	Data de vencimento (AAAA-MM-DD) (obrigatório)	2025-03-20	-
description	string	Descrição da receita (Máximo 255 caracteres) (opcional)	descrição da receita	-
barcode	string	Código de barras (para boletos) (Máximo 50 caracteres) (opcional)	82650000001907700970910730452087432916773187	-
access_key	string	Chave de acesso (para cupons fiscais) (Máximo 50 caracteres) (opcional)	82650000001907700970910730452087432916773183	-
pay_day	string	Data de pagamento (AAAA-MM-DD) (opcional)	2025-03-15	-
id_action	number	ID do tipo de ação (Entre 1 e 8) (opcional)	1	1
id_bank_account	string	ID da conta bancária (opcional)	9cbbe31c-d2a8-4d62-9b9d-1e7fadeac8b4	-
id_bank_account_out	string	ID da conta bancária de saída (opcional)	9e27a1b2-7b47-48a2-9e34-cf7b6bbb8cb5	-
discounts	number	Valor de descontos (opcional)	10	-
interest	number	Valor de juros (opcional)	4	-
installment	number	Número de parcelas (opcional)	002/010	-
data_bank	text	Dados bancários (opcional)	3	-

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Income updated successfuly",
  "data": null
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/update_income' \
    -d '{
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "id_income": "956a487e-7ea4-433e-bc91-ad7fc5bb0303",
            "description": "Descrição da receita",
            "barcode": "82650000001907700970910730452087432916773187",
            "due_date": "2025-05-08",
            "pay_day": "2025-05-08",
            "category_id": "3471754a-3419-4236-8104-8c73969c65a9",
            "id_action": "1",
            "id_bank_account": "9cbbe31c-d2a8-4d62-9b9d-1e7fadeac8b4",
            "id_bank_account_out": "9e27a1b2-7b47-48a2-9e34-cf7b6bbb8cb5",
            "id_contact": "7a1f34cd-0831-415d-bbca-bea7b7a7bd06",
            "id_project": "f6c60109-6186-47a6-9ac7-393037b7f9d7",
            "prev_value": 10,
            "discounts": 2,
            "interest": 4,
            "installment": "002/010",
            "data_bank": "Dados bancários"
        }' \
    -H 'Content-Type: application/json' \
    | jq

Observações Importantes

• Validação de intervalo máximo de 1 ano para datas

• Apenas categorias de receitas podem ser atreladas a receita

POST /list_income_files

Resumo

Rota para listar arquivos em receitas do sistema.

Descrição

Esta rota é responsável por listar arquivos associados as receitas existentes no sistema.

---

Requisição

Headers

• Content-Type: application/json

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
id_income	string	ID da receita (obrigatório)	77d5bc16-780f-438c-8665-s8cb7ccdbe66	-

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Income files listed successfuly",
  "data": [
    {
      "file": "abd3de9f4cb0bdf13f599025abc693fd.pdf",
      "type": "application/pdf",
      "file_name": "arquivo1.pdf",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    },
    {
      "file": "5042e8fd4736e8249f5aa0d8ab002cad.pdf",
      "type": "application/pdf",
      "file_name": "arquivo2.pdf",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    },
    {
      "file": "2fce237c1ec5b477c55c0ca382706d8d.pdf",
      "type": "application/pdf",
      "file_name": "arquivo3.pdf",
      "type_selected": "Outros",
      "year_inserted": 2025,
      "month_inserted": "05"
    }
  ]
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/list_income_files' \
    -d '{
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "id_income": "956a487e-7ea4-433e-bc91-ad7fc5bb0303"
        }' \
    -H 'Content-Type: application/json' \
    | jq

POST /insert_income_files

Resumo

Rota para inserir arquivos em receitas do sistema.

Descrição

Esta rota é responsável por inserir arquivos em receitas existentes no sistema. Esses arquivos não são a receita em si, mas arquivos associados a ela.

---

Requisição

Headers

• Content-Type: multipart/form-data

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
id_income	string	ID da receita (obrigatório)	77d5bc16-780f-438c-8665-s8cb7ccdbe66	-

Anexos de Arquivos:

• other_files: Arquivos adicionais, pode ter varios arquivos (obrigatório)

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Income files inserted successfuly",
  "data": null
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/insert_income_files' \
    -d '{
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "id_income": "956a487e-7ea4-433e-bc91-ad7fc5bb0303"
        }' \
    | jq

POST /delete_income_files

Resumo

Rota para excluir arquivos específicos em receitas do sistema.

Descrição

Esta rota é responsável por deletar arquivos específicos associados as receitas existentes no sistema.

---

Requisição

Headers

• Content-Type: application/json

Body da Requisição

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso do usuário (obrigatório)	4b194dff-eb83-4af7-ac6f-951fe7931e43	-
unit_token	string	Token de identificação da unidade (obrigatório)	5bd5bc16-780f-438c-8665-c8cb7cccbe45	-
id_income	string	ID da receita (obrigatório)	77d5bc16-780f-438c-8665-s8cb7ccdbe66	-
filenames	array	Lista de nome dos arquivos para deletar. Podem ser achados na rota /list_income_files, sendo o file que aparece na resposta. (obrigatório)	["34790e0336e9304294f3fcac0b31005b.pdf"]	-

---

Respostas

Abaixo estão algumas respostas que podem ser retornadas dependendo dos parâmetros:

200 Sucesso

{
  "success": true,
  "message": "Income files deleted successfuly",
  "data": null
}

400 Requisição Inválida

{
  "success": false,
  "message": "Missing parameters",
  "data": null
}

403 Acesso Negado

{
  "success": false,
  "message": "Invalid data",
  "data": null
}

500 Erro no Servidor

{
  "success": false,
  "error": "Internal server error",
  "data": null
}

Exemplo de Requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/delete_income_files' \
    -d '{
            "access_token": "4b194dff-eb83-4af7-ac6f-951fe7931e43",
            "unit_token": "5bd5bc16-780f-438c-8665-c8cb7cccbe45",
            "id_income": "956a487e-7ea4-433e-bc91-ad7fc5bb0303",
            "filenames": ["34790e0336e9304294f3fcac0b31005b.pdf"]
        }' \
    -H 'Content-Type: application/json' \
    | jq