Package com.plaid.client.model
Class StudentLoan
java.lang.Object
com.plaid.client.model.StudentLoan
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2021-10-15T19:47:39.714Z[GMT]")
public class StudentLoan
extends java.lang.Object
Contains details about a student loan account
-
Field Summary
-
Constructor Summary
Constructors Constructor Description StudentLoan()
-
Method Summary
Modifier and Type Method Description StudentLoan
accountId(java.lang.String accountId)
StudentLoan
accountNumber(java.lang.String accountNumber)
StudentLoan
addDisbursementDatesItem(java.time.LocalDate disbursementDatesItem)
StudentLoan
disbursementDates(java.util.List<java.time.LocalDate> disbursementDates)
boolean
equals(java.lang.Object o)
StudentLoan
expectedPayoffDate(java.time.LocalDate expectedPayoffDate)
java.lang.String
getAccountId()
The ID of the account that this liability belongs to.java.lang.String
getAccountNumber()
The account number of the loan.java.util.List<java.time.LocalDate>
getDisbursementDates()
The dates on which loaned funds were disbursed or will be disbursed.java.time.LocalDate
getExpectedPayoffDate()
The date when the student loan is expected to be paid off.java.lang.String
getGuarantor()
The guarantor of the student loan.java.lang.Double
getInterestRatePercentage()
The interest rate on the loan as a percentage.java.lang.Boolean
getIsOverdue()
`true` if a payment is currently overdue.java.lang.Double
getLastPaymentAmount()
The amount of the last payment.java.time.LocalDate
getLastPaymentDate()
The date of the last payment.java.time.LocalDate
getLastStatementIssueDate()
The date of the last statement.java.lang.String
getLoanName()
The type of loan, e.g., \"Consolidation Loans\".StudentLoanStatus
getLoanStatus()
Get loanStatusjava.lang.Double
getMinimumPaymentAmount()
The minimum payment due for the next billing cycle.java.time.LocalDate
getNextPaymentDueDate()
The due date for the next payment.java.time.LocalDate
getOriginationDate()
The date on which the loan was initially lent.java.lang.Double
getOriginationPrincipalAmount()
The original principal balance of the loan.java.lang.Double
getOutstandingInterestAmount()
The total dollar amount of the accrued interest balance.java.lang.String
getPaymentReferenceNumber()
The relevant account number that should be used to reference this loan for payments.PSLFStatus
getPslfStatus()
Get pslfStatusStudentRepaymentPlan
getRepaymentPlan()
Get repaymentPlanjava.lang.String
getSequenceNumber()
The sequence number of the student loan.ServicerAddressData
getServicerAddress()
Get servicerAddressjava.lang.Double
getYtdInterestPaid()
The year to date (YTD) interest paid.java.lang.Double
getYtdPrincipalPaid()
The year to date (YTD) principal paid.StudentLoan
guarantor(java.lang.String guarantor)
int
hashCode()
StudentLoan
interestRatePercentage(java.lang.Double interestRatePercentage)
StudentLoan
isOverdue(java.lang.Boolean isOverdue)
StudentLoan
lastPaymentAmount(java.lang.Double lastPaymentAmount)
StudentLoan
lastPaymentDate(java.time.LocalDate lastPaymentDate)
StudentLoan
lastStatementIssueDate(java.time.LocalDate lastStatementIssueDate)
StudentLoan
loanName(java.lang.String loanName)
StudentLoan
loanStatus(StudentLoanStatus loanStatus)
StudentLoan
minimumPaymentAmount(java.lang.Double minimumPaymentAmount)
StudentLoan
nextPaymentDueDate(java.time.LocalDate nextPaymentDueDate)
StudentLoan
originationDate(java.time.LocalDate originationDate)
StudentLoan
originationPrincipalAmount(java.lang.Double originationPrincipalAmount)
StudentLoan
outstandingInterestAmount(java.lang.Double outstandingInterestAmount)
StudentLoan
paymentReferenceNumber(java.lang.String paymentReferenceNumber)
StudentLoan
pslfStatus(PSLFStatus pslfStatus)
StudentLoan
repaymentPlan(StudentRepaymentPlan repaymentPlan)
StudentLoan
sequenceNumber(java.lang.String sequenceNumber)
StudentLoan
servicerAddress(ServicerAddressData servicerAddress)
void
setAccountId(java.lang.String accountId)
void
setAccountNumber(java.lang.String accountNumber)
void
setDisbursementDates(java.util.List<java.time.LocalDate> disbursementDates)
void
setExpectedPayoffDate(java.time.LocalDate expectedPayoffDate)
void
setGuarantor(java.lang.String guarantor)
void
setInterestRatePercentage(java.lang.Double interestRatePercentage)
void
setIsOverdue(java.lang.Boolean isOverdue)
void
setLastPaymentAmount(java.lang.Double lastPaymentAmount)
void
setLastPaymentDate(java.time.LocalDate lastPaymentDate)
void
setLastStatementIssueDate(java.time.LocalDate lastStatementIssueDate)
void
setLoanName(java.lang.String loanName)
void
setLoanStatus(StudentLoanStatus loanStatus)
void
setMinimumPaymentAmount(java.lang.Double minimumPaymentAmount)
void
setNextPaymentDueDate(java.time.LocalDate nextPaymentDueDate)
void
setOriginationDate(java.time.LocalDate originationDate)
void
setOriginationPrincipalAmount(java.lang.Double originationPrincipalAmount)
void
setOutstandingInterestAmount(java.lang.Double outstandingInterestAmount)
void
setPaymentReferenceNumber(java.lang.String paymentReferenceNumber)
void
setPslfStatus(PSLFStatus pslfStatus)
void
setRepaymentPlan(StudentRepaymentPlan repaymentPlan)
void
setSequenceNumber(java.lang.String sequenceNumber)
void
setServicerAddress(ServicerAddressData servicerAddress)
void
setYtdInterestPaid(java.lang.Double ytdInterestPaid)
void
setYtdPrincipalPaid(java.lang.Double ytdPrincipalPaid)
java.lang.String
toString()
StudentLoan
ytdInterestPaid(java.lang.Double ytdInterestPaid)
StudentLoan
ytdPrincipalPaid(java.lang.Double ytdPrincipalPaid)
-
Field Details
-
SERIALIZED_NAME_ACCOUNT_ID
public static final java.lang.String SERIALIZED_NAME_ACCOUNT_ID- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ACCOUNT_NUMBER
public static final java.lang.String SERIALIZED_NAME_ACCOUNT_NUMBER- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DISBURSEMENT_DATES
public static final java.lang.String SERIALIZED_NAME_DISBURSEMENT_DATES- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EXPECTED_PAYOFF_DATE
public static final java.lang.String SERIALIZED_NAME_EXPECTED_PAYOFF_DATE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_GUARANTOR
public static final java.lang.String SERIALIZED_NAME_GUARANTOR- See Also:
- Constant Field Values
-
SERIALIZED_NAME_INTEREST_RATE_PERCENTAGE
public static final java.lang.String SERIALIZED_NAME_INTEREST_RATE_PERCENTAGE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_OVERDUE
public static final java.lang.String SERIALIZED_NAME_IS_OVERDUE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LAST_PAYMENT_AMOUNT
public static final java.lang.String SERIALIZED_NAME_LAST_PAYMENT_AMOUNT- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LAST_PAYMENT_DATE
public static final java.lang.String SERIALIZED_NAME_LAST_PAYMENT_DATE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LAST_STATEMENT_ISSUE_DATE
public static final java.lang.String SERIALIZED_NAME_LAST_STATEMENT_ISSUE_DATE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LOAN_NAME
public static final java.lang.String SERIALIZED_NAME_LOAN_NAME- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LOAN_STATUS
public static final java.lang.String SERIALIZED_NAME_LOAN_STATUS- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MINIMUM_PAYMENT_AMOUNT
public static final java.lang.String SERIALIZED_NAME_MINIMUM_PAYMENT_AMOUNT- See Also:
- Constant Field Values
-
SERIALIZED_NAME_NEXT_PAYMENT_DUE_DATE
public static final java.lang.String SERIALIZED_NAME_NEXT_PAYMENT_DUE_DATE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ORIGINATION_DATE
public static final java.lang.String SERIALIZED_NAME_ORIGINATION_DATE- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ORIGINATION_PRINCIPAL_AMOUNT
public static final java.lang.String SERIALIZED_NAME_ORIGINATION_PRINCIPAL_AMOUNT- See Also:
- Constant Field Values
-
SERIALIZED_NAME_OUTSTANDING_INTEREST_AMOUNT
public static final java.lang.String SERIALIZED_NAME_OUTSTANDING_INTEREST_AMOUNT- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PAYMENT_REFERENCE_NUMBER
public static final java.lang.String SERIALIZED_NAME_PAYMENT_REFERENCE_NUMBER- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PSLF_STATUS
public static final java.lang.String SERIALIZED_NAME_PSLF_STATUS- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REPAYMENT_PLAN
public static final java.lang.String SERIALIZED_NAME_REPAYMENT_PLAN- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SEQUENCE_NUMBER
public static final java.lang.String SERIALIZED_NAME_SEQUENCE_NUMBER- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SERVICER_ADDRESS
public static final java.lang.String SERIALIZED_NAME_SERVICER_ADDRESS- See Also:
- Constant Field Values
-
SERIALIZED_NAME_YTD_INTEREST_PAID
public static final java.lang.String SERIALIZED_NAME_YTD_INTEREST_PAID- See Also:
- Constant Field Values
-
SERIALIZED_NAME_YTD_PRINCIPAL_PAID
public static final java.lang.String SERIALIZED_NAME_YTD_PRINCIPAL_PAID- See Also:
- Constant Field Values
-
-
Constructor Details
-
StudentLoan
public StudentLoan()
-
-
Method Details
-
accountId
-
getAccountId
@Nullable public java.lang.String getAccountId()The ID of the account that this liability belongs to.- Returns:
- accountId
-
setAccountId
public void setAccountId(java.lang.String accountId) -
accountNumber
-
getAccountNumber
@Nullable public java.lang.String getAccountNumber()The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number).- Returns:
- accountNumber
-
setAccountNumber
public void setAccountNumber(java.lang.String accountNumber) -
disbursementDates
-
addDisbursementDatesItem
-
getDisbursementDates
@Nullable public java.util.List<java.time.LocalDate> getDisbursementDates()The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).- Returns:
- disbursementDates
-
setDisbursementDates
public void setDisbursementDates(java.util.List<java.time.LocalDate> disbursementDates) -
expectedPayoffDate
-
getExpectedPayoffDate
@Nullable public java.time.LocalDate getExpectedPayoffDate()The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).- Returns:
- expectedPayoffDate
-
setExpectedPayoffDate
public void setExpectedPayoffDate(java.time.LocalDate expectedPayoffDate) -
guarantor
-
getGuarantor
@Nullable public java.lang.String getGuarantor()The guarantor of the student loan.- Returns:
- guarantor
-
setGuarantor
public void setGuarantor(java.lang.String guarantor) -
interestRatePercentage
-
getInterestRatePercentage
public java.lang.Double getInterestRatePercentage()The interest rate on the loan as a percentage.- Returns:
- interestRatePercentage
-
setInterestRatePercentage
public void setInterestRatePercentage(java.lang.Double interestRatePercentage) -
isOverdue
-
getIsOverdue
@Nullable public java.lang.Boolean getIsOverdue()`true` if a payment is currently overdue. Availability for this field is limited.- Returns:
- isOverdue
-
setIsOverdue
public void setIsOverdue(java.lang.Boolean isOverdue) -
lastPaymentAmount
-
getLastPaymentAmount
@Nullable public java.lang.Double getLastPaymentAmount()The amount of the last payment.- Returns:
- lastPaymentAmount
-
setLastPaymentAmount
public void setLastPaymentAmount(java.lang.Double lastPaymentAmount) -
lastPaymentDate
-
getLastPaymentDate
@Nullable public java.time.LocalDate getLastPaymentDate()The date of the last payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).- Returns:
- lastPaymentDate
-
setLastPaymentDate
public void setLastPaymentDate(java.time.LocalDate lastPaymentDate) -
lastStatementIssueDate
-
getLastStatementIssueDate
@Nullable public java.time.LocalDate getLastStatementIssueDate()The date of the last statement. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).- Returns:
- lastStatementIssueDate
-
setLastStatementIssueDate
public void setLastStatementIssueDate(java.time.LocalDate lastStatementIssueDate) -
loanName
-
getLoanName
@Nullable public java.lang.String getLoanName()The type of loan, e.g., \"Consolidation Loans\".- Returns:
- loanName
-
setLoanName
public void setLoanName(java.lang.String loanName) -
loanStatus
-
getLoanStatus
Get loanStatus- Returns:
- loanStatus
-
setLoanStatus
-
minimumPaymentAmount
-
getMinimumPaymentAmount
@Nullable public java.lang.Double getMinimumPaymentAmount()The minimum payment due for the next billing cycle. There are some exceptions: Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( `ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan Authority (`ins_116945`). Firstmark (`ins_116295` ) will display as $0 if there is an autopay program in effect.- Returns:
- minimumPaymentAmount
-
setMinimumPaymentAmount
public void setMinimumPaymentAmount(java.lang.Double minimumPaymentAmount) -
nextPaymentDueDate
-
getNextPaymentDueDate
@Nullable public java.time.LocalDate getNextPaymentDueDate()The due date for the next payment. The due date is `null` if a payment is not expected. A payment is not expected if `loan_status.type` is `deferment`, `in_school`, `consolidated`, `paid in full`, or `transferred`. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).- Returns:
- nextPaymentDueDate
-
setNextPaymentDueDate
public void setNextPaymentDueDate(java.time.LocalDate nextPaymentDueDate) -
originationDate
-
getOriginationDate
@Nullable public java.time.LocalDate getOriginationDate()The date on which the loan was initially lent. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).- Returns:
- originationDate
-
setOriginationDate
public void setOriginationDate(java.time.LocalDate originationDate) -
originationPrincipalAmount
-
getOriginationPrincipalAmount
@Nullable public java.lang.Double getOriginationPrincipalAmount()The original principal balance of the loan.- Returns:
- originationPrincipalAmount
-
setOriginationPrincipalAmount
public void setOriginationPrincipalAmount(java.lang.Double originationPrincipalAmount) -
outstandingInterestAmount
-
getOutstandingInterestAmount
@Nullable public java.lang.Double getOutstandingInterestAmount()The total dollar amount of the accrued interest balance. For Sallie Mae ( `ins_116944`), this amount is included in the current balance of the loan, so this field will return as `null`.- Returns:
- outstandingInterestAmount
-
setOutstandingInterestAmount
public void setOutstandingInterestAmount(java.lang.Double outstandingInterestAmount) -
paymentReferenceNumber
-
getPaymentReferenceNumber
@Nullable public java.lang.String getPaymentReferenceNumber()The relevant account number that should be used to reference this loan for payments. In the majority of cases, `payment_reference_number` will match a`ccount_number,` but in some institutions, such as Great Lakes (`ins_116861`), it will be different.- Returns:
- paymentReferenceNumber
-
setPaymentReferenceNumber
public void setPaymentReferenceNumber(java.lang.String paymentReferenceNumber) -
pslfStatus
-
getPslfStatus
Get pslfStatus- Returns:
- pslfStatus
-
setPslfStatus
-
repaymentPlan
-
getRepaymentPlan
Get repaymentPlan- Returns:
- repaymentPlan
-
setRepaymentPlan
-
sequenceNumber
-
getSequenceNumber
@Nullable public java.lang.String getSequenceNumber()The sequence number of the student loan. Heartland ECSI (`ins_116948`) does not make this field available.- Returns:
- sequenceNumber
-
setSequenceNumber
public void setSequenceNumber(java.lang.String sequenceNumber) -
servicerAddress
-
getServicerAddress
Get servicerAddress- Returns:
- servicerAddress
-
setServicerAddress
-
ytdInterestPaid
-
getYtdInterestPaid
@Nullable public java.lang.Double getYtdInterestPaid()The year to date (YTD) interest paid. Availability for this field is limited.- Returns:
- ytdInterestPaid
-
setYtdInterestPaid
public void setYtdInterestPaid(java.lang.Double ytdInterestPaid) -
ytdPrincipalPaid
-
getYtdPrincipalPaid
@Nullable public java.lang.Double getYtdPrincipalPaid()The year to date (YTD) principal paid. Availability for this field is limited.- Returns:
- ytdPrincipalPaid
-
setYtdPrincipalPaid
public void setYtdPrincipalPaid(java.lang.Double ytdPrincipalPaid) -
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-