Pular para o conteúdo principal

Atualizar receita

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âmetroTipoDescriçãoExemploPadrão
access_tokenstringToken de acesso do usuário (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
unit_tokenstringToken de identificação da unidade (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
id_incomestringID da receita (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
category_idstringID da categoria de despesa (obrigatório)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
prev_valuenumberValor base da receita (obrigatório)30.5-
due_datestringData de vencimento (AAAA-MM-DD) (obrigatório)2025-03-20-
descriptionstringDescrição da receita (Máximo 255 caracteres) (opcional)Descrição da receita-
pay_daystringData de pagamento (AAAA-MM-DD) (opcional)2025-03-15-
id_actionnumberID do tipo de ação, pode ser achado aqui: Status (Entre 1 e 8) (opcional)11
id_bank_accountstringID da conta bancária (opcional)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
id_bank_account_outstringID da conta bancária de saída (opcional)aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
discountsnumberValor de descontos (opcional)10-
interestnumberValor de juros (opcional)4-
data_bankstringDados 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": "<access_token>",
"unit_token": "<unit_token>",
"id_income": "<id_income>",
"description": "<description>",
"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>,
"data_bank": "<data_bank>"
}' \
-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