SYsynci
Loans

Update loan terms

Changed on

Everything on the loan object except the rate, which has its own endpoint. Changing the fee or the day count applies to payments from now on. Setting a paying account turns schedule mode off.

put/finance/accounts/{accountId}/loan

Request

  • Base URL
    https://api.synci.io/api/v1
  • Auth
    • OAuth 2
      Authorization code: https://api.synci.io/oauth/authorize
      Token URL: https://api.synci.io/oauth/token
    • or HTTP bearer

Path parameters

accountIdinteger required

The financial account ID

Request body

kind'MORTGAGE' | 'STUDENT' | 'AUTO' | 'PERSONAL' | 'OTHER'

What kind of debt a manual loan account is. Drives the default account type when the loan is created in a destination.

repayment_type'ANNUITY' | 'SERIAL' | 'INTEREST_ONLY'

How the loan is paid down. Only the months-remaining estimate depends on it; the interest, fee and payment split never does.

fee_per_paymentnumber

Applies to payments from now on.

day_count'ACT_365' | 'ACT_360' | 'THIRTY_360'

How days between two dates are counted when accruing interest, and the denominator that goes with them.

original_amountnumber nullable
start_datestring date-time nullable
term_monthsinteger nullable
paying_financial_account_idinteger nullable

A bank account of the loan's owner that pays the loan; null switches to schedule mode (set schedule).

Response

message'Loan terms updated.' required

Changes