Skip to content

Fees API

Manage fee schedules and assess, view, and waive fees on loans.

Base permission: IsViewerOrAbove (read), IsLoanOfficerOrAbove (write)

Fee Schedules

Fee schedules define rules for when and how fees are assessed on loan products.

Method Path Description Permission
GET /fee-schedules List fee schedules IsViewerOrAbove
GET /fee-schedules/{id} Get fee schedule IsViewerOrAbove
POST /fee-schedules Create fee schedule IsAdminOrAbove
PUT /fee-schedules/{id} Update fee schedule IsAdminOrAbove
DELETE /fee-schedules/{id} Archive fee schedule IsAdminOrAbove

Create Fee Schedule

POST /api/v1/fee-schedules

{
  "product_id": "772a0622-a4bd-63f6-c938-668877662222",
  "name": "Late Payment Fee",
  "fee_type": "late_fee",
  "trigger": "delinquency",
  "calculation_method": "flat",
  "flat_amount": "25.00",
  "grace_period_days": 15,
  "max_occurrences": 1
}

Calculation Methods

Method Fields Example
flat flat_amount $25.00 flat fee
percentage percentage, percentage_base 5% of outstanding balance
tiered tiers (JSON array) $10 for first $1000, $25 above
flat_plus_percentage flat_amount, percentage, percentage_base $10 + 2% of balance
per_unit per_unit_amount, unit_type $5 per day

Fee Assessments

Method Path Description Permission
GET /fees List all assessed fees IsViewerOrAbove
GET /fees/{id} Get assessed fee IsViewerOrAbove
GET /loans/{id}/fees List fees on a loan IsViewerOrAbove
POST /fees/{id}/assess Manually assess a fee IsLoanOfficerOrAbove
POST /fees/{id}/waive Waive a fee IsLoanOfficerOrAbove

Assess Fee

Manually assess a fee on a loan outside of the automated schedule.

POST /api/v1/fees/{id}/assess

{
  "loan_id": "550e8400-e29b-41d4-a716-446655440000",
  "fee_schedule_id": "994c2844-c6df-85h8-e150-880099884444",
  "amount": "25.00",
  "description": "Manual late fee assessment"
}

Effects:

  • Creates a fee record on the loan
  • Posts GL journal entries (DR Fees Receivable, CR Fee Income)
  • Updates loan's outstanding fee balance

Waive Fee

POST /api/v1/fees/{id}/waive

{
  "reason": "Customer goodwill - first late payment"
}

Effects:

  • Marks fee as waived
  • Posts reversing GL entries (DR Fee Income, CR Fees Receivable)

Fee Types

Type Trigger
origination_fee Loan disbursement
late_fee Payment delinquency
nsf_fee Payment reversal (returned check/ACH)
modification_fee Loan modification applied
prepayment_penalty Early payoff
servicing_fee Recurring (monthly/annual)
draw_fee Line of credit draw

See Also