Inserir receita

POST /insert_income

Resumo

Rota para inserção de novas receitas.

Descrição

Permite criar receitas com validação de dados, tratamento de valores financeiros e upload de anexos.

---

Requisição

Headers

• Content-Type: multipart/form-data

Body da Requisição

O JSON deve ser enviado dentro do campo metadata.

Parâmetro	Tipo	Descrição	Exemplo	Padrão
access_token	string	Token de acesso da API.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
unit_token	string	Token da unidade.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
category_id_token	string	Token da categoria de receita.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
prev_value	number	Valor base da receita.	30.5	-
due_date	string	Data de vencimento em YYYY-MM-DD. Obrigatória se date não for enviada.	2025-03-20	-
date	string	Alias de due_date.	2025-03-20	-
pay_day	string	Data de pagamento em YYYY-MM-DD.	2025-03-15	null
competence_date	string	Data de competência em YYYY-MM-DD.	2025-03-01	due_date ou date
competence	string	Alias de competence_date.	2025-03-01	-
description	string	Descrição da receita.	Descrição da receita	-
id_token_action	number	Status da receita. Veja Status.	1	1
id_token_bank_account	string	Conta bancária.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	Conta padrão da unidade, quando existir
id_token_project	string	Projeto.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	Projeto padrão da unidade, quando existir
id_token_contact	string	Contato.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
id_token_bank_account_out	string	Conta bancária de saída.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
discounts	number	Descontos.	10	-
interest	number	Juros.	4	-
data_bank	string	Dados bancários complementares.	Banco XPTO	-
id_token_product	string	Produto ou serviço vinculado.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
quantity_product	number	Quantidade do produto ou serviço.	10	-

Anexos

• other_files: arquivos adicionais

---

Exemplo de requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/insert_income' \
  -F 'metadata={
    "access_token":"<access_token>",
    "unit_token":"<unit_token>",
    "description":"<description>",
    "date":"<date>",
    "pay_day":"<pay_day>",
    "competence":"<competence>",
    "category_id_token":"<category_id_token>",
    "prev_value":30.5
  };type=application/json' \
  -F 'other_files=@./anexo.pdf'

Respostas

200 Sucesso

{
  "success": true,
  "message": "Income inserted successfully",
  "data": {
    "token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  }
}

Observações

• date pode ser usado no lugar de due_date
• competence pode ser usado no lugar de competence_date
• Se competence_date não for informado, a API usa due_date ou date
• pay_day é opcional