Inserir despesa

POST /insert_expense

Resumo

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

Descrição

Permite criar despesas com validação de dados, tratamento de valores financeiros e upload de arquivos associados.

---

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 despesa.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
prev_value	number	Valor base da despesa.	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 despesa. Máximo de 255 caracteres.	Descrição da despesa	-
barcode	string	Código de barras do boleto. Máximo de 50 caracteres.	00000000000000000000000000000000000000000000	-
access_key	string	Chave de acesso do documento fiscal. Máximo de 50 caracteres.	00000000000000000000000000000000000000000000	-
id_token_action	number	Status da despesa. 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	Beneficiário/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	-
installment	string	Parcela.	002/010	001/001
data_bank	string	Dados bancários complementares.	Banco XPTO	-

Anexos

• file: arquivo principal, apenas 1 PDF ou imagem
• other_files: arquivos adicionais

---

Exemplo de requisição

curl -s -X POST 'https://portal.fipli.pro/api/v1/insert_expense' \
  -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>",
    "id_token_action":1,
    "id_token_bank_account":"<id_token_bank_account>",
    "id_token_bank_account_out":"<id_token_bank_account_out>",
    "id_token_contact":"<id_token_contact>",
    "id_token_project":"<id_token_project>",
    "prev_value":30.5,
    "discounts":0,
    "interest":0,
    "installment":"001/001",
    "data_bank":"<data_bank>"
  };type=application/json' \
  -F 'file=@./documento.pdf' \
  -F 'other_files=@./anexo.png'

Respostas

200 Sucesso

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

400 / 403 / 500

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

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
• Apenas um entre barcode e access_key deve ser enviado