Atualizar despesa

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)	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
unit_token	string	Token de identificação da unidade (obrigatório)	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
id_expense	string	ID da despesa (obrigatório)	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
category_id	string	ID da categoria de despesa (obrigatório)	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
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)	00000000000000000000000000000000000000000000	-
access_key	string	Chave de acesso (para cupons fiscais) (Máximo 50 caracteres) (opcional)	00000000000000000000000000000000000000000000	-
pay_day	string	Data de pagamento (AAAA-MM-DD) (opcional)	2025-03-15	-
id_action	number	ID do tipo de ação, pode ser achado aqui: Status (Entre 1 e 8) (opcional)	1	1
id_bank_account	string	ID da conta bancária (opcional)	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
id_bank_account_out	string	ID da conta bancária de saída (opcional)	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee	-
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	string	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": "<access_token>",
            "unit_token": "<unit_token>",
            "id_expense": "<id_expense>",
            "description": "<description>",
            "barcode": "<barcode>",
            "due_date": "<due_date>",
            "pay_day": "<pay_day>",
            "category_id": "<category_id>",
            "id_action": <id_action>,
            "id_bank_account": "<id_bank_account>",
            "id_bank_account_out": "<id_bank_account_out>",
            "id_contact": "<id_contact>",
            "id_project": "<id_project>",
            "prev_value": <prev_value>,
            "discounts": <discounts>,
            "interest": <interest>,
            "installment": "<installment>",
            "data_bank": "<data_bank>"
        };type=application/json' \
    -F 'file=@./<filename>' \
    | 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.