Browse the API30

portfolio

get

/api/v1/portfolio/loans/{id}/schedule

The amortization schedule, as its own document, with the running balance.

Scope: portfolio:read
Rate limit: 200 requests / min
Idempotency: read-only

Authentication

Send your key as Authorization: Bearer …. It must carry the scope portfolio:read; a key without it receives 403 forbidden.

Path parameters

idstringrequired

Request body

This operation takes no request body.

Response

200application/jsonSerializedLoanSchedule

loan_idstringrequired

original_amountnumberrequired

Whole dollars: the original principal, i.e. the balance before installment 1.

term_monthsnumberrequired

The loan's CONTRACTUAL term.

installment_countnumberrequired

Installments the loan actually has — which is schedule.length unless the schedule was capped, and which is term_months for any schedule this platform generated in full.

scheduleSerializedAmortizationRow[]required

Oldest first, as findByLoan orders it (dueDate: asc).

Errors

The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

401unauthorized

403forbidden

404not_found

429rate_limit_exceeded

500internal_error

Request

curl -X GET "https://<your-host>/api/v1/portfolio/loans/<id>/schedule" \
  -H "Authorization: Bearer hlh_test_YOUR_API_KEY"

Response200application/json

{
  "loan_id": string,
  "original_amount": number,
  "term_months": number,
  "installment_count": number,
  "schedule": [
    {
      "id": string,
      "due_date": string | null,
      "paid_date": string | null,
      "amount": number,
      "principal": number,
      "interest": number,
      "late_fee": number,
      "paid_amount": number,
      "status": string,
      "days_overdue": number,
      "remaining_principal": number
    }
  ]
}

Shown as types, not sample values. A field typed number | null can be null; the response fields table gives the reason.