Pular para o conteúdo principal

Atualizar despesa

POST /update_expense

Resumo

Rota para atualizar despesas com tratamento de arquivo principal.

Descrição

Permite atualização parcial ou completa dos dados de uma despesa.


Requisição

Headers

  • Content-Type: multipart/form-data

Body da Requisição

O JSON deve ser enviado dentro do campo metadata.

ParâmetroTipoDescriçãoExemploPadrão
access_tokenstringToken de acesso da API.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
unit_tokenstringToken da unidade.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
id_token_expensestringToken da despesa.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
due_datestringData de vencimento em YYYY-MM-DD.2025-03-20-
datestringAlias de due_date.2025-03-20-
pay_daystringData de pagamento em YYYY-MM-DD.2025-03-15-
competence_datestringData de competência em YYYY-MM-DD.2025-03-01due_date ou date ao alterar datas
competencestringAlias de competence_date.2025-03-01-
category_id_tokenstringCategoria de despesa.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
prev_valuenumberValor base.30.5-
descriptionstringDescrição.Descrição da despesa-
barcodestringCódigo de barras.00000000000000000000000000000000000000000000-
access_keystringChave de acesso.00000000000000000000000000000000000000000000-
id_token_actionnumberStatus da despesa.1-
id_token_bank_accountstringConta bancária.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
id_token_projectstringProjeto.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
id_token_contactstringContato.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
id_token_unitstringUnidade.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
id_token_bank_account_outstringConta bancária de saída.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee-
discountsnumberDescontos.10-
interestnumberJuros.4-
installmentstringParcela.002/010-
data_bankstringDados bancários complementares.Banco XPTO-

Anexos

  • file: arquivo principal, apenas 1 PDF ou imagem

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_token_expense":"<id_token_expense>",
"date":"<date>",
"pay_day":"<pay_day>",
"competence":"<competence>",
"category_id_token":"<category_id_token>"
};type=application/json' \
-F 'file=@./documento.pdf'

Respostas

200 Sucesso

{
"success": true,
"message": "Expense updated successfuly",
"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 ao atualizar datas, a API usa due_date ou date