Perform Action on Business Loan

Once a business loan is created and booked you service it through the /business-loans/<id> sub-resources. The credit-decision steps (approve / deny / move) and revolving-credit withdrawals are covered in Create & Book Business Loan; this page covers the ongoing servicing actions.

Example - add an interest charge:

curl -X POST "https://$HOST/business-loans/$BL_ID/financial-events" \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "type_code": "BUSINESS_LOAN_INTEREST", "amount": 125.00, "description": "Manual interest" }'

Common actions

Action	Endpoint	Right	What it does
Add fee	`POST /business-loans/<id>/financial-events`	`CreateCollectionBatchFinancialEvent`	Book a `BUSINESS_LOAN_FEE` event.
Add interest	`POST /business-loans/<id>/financial-events`	`CreateCollectionBatchFinancialEvent`	Book a `BUSINESS_LOAN_INTEREST` event.
Write off fee	`POST /business-loans/<id>/financial-events`	`CreateCollectionBatchFinancialEvent`	Book a `BUSINESS_LOAN_FEE_WRITE_OFF` event.
Write off interest	`POST /business-loans/<id>/financial-events`	`CreateCollectionBatchFinancialEvent`	Book a `BUSINESS_LOAN_INTEREST_WRITE_OFF` event.
Withdraw (revolving)	`PUT /business-loans/<id>/withdraw`	`CreateBusinessLoanWithdrawal`	Request a withdrawal on a revolving-credit loan (dual approval). See the create page.
Update loan	`PUT /business-loans/<id>`	`UpdateBusinessLoan`	Update editable loan fields.
Update profile	`PUT /business-loans/<id>/profile`	`UpdateBusinessLoan`	Update the attached loan profile.
Installment summary	`PUT /business-loans/<id>/installment/summary`	`InstallmentSummaryBusinessLoans`	Recalculate the installment schedule/summary.
Archive	`PUT /business-loans/<id>/archive/add`	`AddToArchiveBusinessLoans`	Archive a loan (only before booking).
Unarchive	`PUT /business-loans/<id>/archive/remove`	`RemoveFromArchiveBusinessLoans`	Restore an archived loan.

The type_code on a financial event must be one of BUSINESS_LOAN_FEE, BUSINESS_LOAN_INTEREST, BUSINESS_LOAN_FEE_WRITE_OFF, or BUSINESS_LOAN_INTEREST_WRITE_OFF, and the amount must be non-zero. Inspect history with GET /business-loans/<id>/financial-events, and the read-only /fees, /guarantors, and /profile sub-resources.