Skip to content

Latest commit

 

History

History
36 lines (31 loc) · 4.24 KB

LiabilityOverride.md

File metadata and controls

36 lines (31 loc) · 4.24 KB

LiabilityOverride

Used to configure Sandbox test data for the Liabilities product

Properties

Name Type Description Notes
type str The type of the liability object, either `credit` or `student`. Mortgages are not currently supported in the custom Sandbox.
purchase_apr float The purchase APR percentage value. For simplicity, this is the only interest rate used to calculate interest charges. Can only be set if `type` is `credit`.
cash_apr float The cash APR percentage value. Can only be set if `type` is `credit`.
balance_transfer_apr float The balance transfer APR percentage value. Can only be set if `type` is `credit`.
special_apr float The special APR percentage value. Can only be set if `type` is `credit`.
last_payment_amount float Override the `last_payment_amount` field. Can only be set if `type` is `credit`.
minimum_payment_amount float Override the `minimum_payment_amount` field. Can only be set if `type` is `credit` or `student`.
is_overdue bool Override the `is_overdue` field
origination_date date The date on which the loan was initially lent, in ISO 8601 (YYYY-MM-DD) format. Can only be set if `type` is `student`.
principal float The original loan principal. Can only be set if `type` is `student`.
nominal_apr float The interest rate on the loan as a percentage. Can only be set if `type` is `student`.
interest_capitalization_grace_period_months float If set, interest capitalization begins at the given number of months after loan origination. By default interest is never capitalized. Can only be set if `type` is `student`.
repayment_model StudentLoanRepaymentModel
expected_payoff_date date Override the `expected_payoff_date` field. Can only be set if `type` is `student`.
guarantor str Override the `guarantor` field. Can only be set if `type` is `student`.
is_federal bool Override the `is_federal` field. Can only be set if `type` is `student`.
loan_name str Override the `loan_name` field. Can only be set if `type` is `student`.
loan_status StudentLoanStatus
payment_reference_number str Override the `payment_reference_number` field. Can only be set if `type` is `student`.
pslf_status PSLFStatus
repayment_plan_description str Override the `repayment_plan.description` field. Can only be set if `type` is `student`.
repayment_plan_type str Override the `repayment_plan.type` field. Can only be set if `type` is `student`. Possible values are: `"extended graduated"`, `"extended standard"`, `"graduated"`, `"income-contingent repayment"`, `"income-based repayment"`, `"interest only"`, `"other"`, `"pay as you earn"`, `"revised pay as you earn"`, or `"standard"`.
sequence_number str Override the `sequence_number` field. Can only be set if `type` is `student`.
servicer_address Address
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]