com.plaid.client.model

Class LiabilityOverride

java.lang.Object

com.plaid.client.model.LiabilityOverride

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class LiabilityOverride
extends Object

Used to configure Sandbox test data for the Liabilities product

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_BALANCE_TRANSFER_APR
static String	SERIALIZED_NAME_CASH_APR
static String	SERIALIZED_NAME_EXPECTED_PAYOFF_DATE
static String	SERIALIZED_NAME_GUARANTOR
static String	SERIALIZED_NAME_INTEREST_CAPITALIZATION_GRACE_PERIOD_MONTHS
static String	SERIALIZED_NAME_IS_FEDERAL
static String	SERIALIZED_NAME_IS_OVERDUE
static String	SERIALIZED_NAME_LAST_PAYMENT_AMOUNT
static String	SERIALIZED_NAME_LOAN_NAME
static String	SERIALIZED_NAME_LOAN_STATUS
static String	SERIALIZED_NAME_MINIMUM_PAYMENT_AMOUNT
static String	SERIALIZED_NAME_NOMINAL_APR
static String	SERIALIZED_NAME_ORIGINATION_DATE
static String	SERIALIZED_NAME_PAYMENT_REFERENCE_NUMBER
static String	SERIALIZED_NAME_PRINCIPAL
static String	SERIALIZED_NAME_PSLF_STATUS
static String	SERIALIZED_NAME_PURCHASE_APR
static String	SERIALIZED_NAME_REPAYMENT_MODEL
static String	SERIALIZED_NAME_REPAYMENT_PLAN_DESCRIPTION
static String	SERIALIZED_NAME_REPAYMENT_PLAN_TYPE
static String	SERIALIZED_NAME_SEQUENCE_NUMBER
static String	SERIALIZED_NAME_SERVICER_ADDRESS
static String	SERIALIZED_NAME_SPECIAL_APR
static String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor and Description
LiabilityOverride()

Method Summary

Modifier and Type	Method and Description
LiabilityOverride	balanceTransferApr(Double balanceTransferApr)
LiabilityOverride	cashApr(Double cashApr)
boolean	equals(Object o)
LiabilityOverride	expectedPayoffDate(LocalDate expectedPayoffDate)
Double	getBalanceTransferApr() The balance transfer APR percentage value.
Double	getCashApr() The cash APR percentage value.
LocalDate	getExpectedPayoffDate() Override the `expected_payoff_date` field.
String	getGuarantor() Override the `guarantor` field.
Double	getInterestCapitalizationGracePeriodMonths() If set, interest capitalization begins at the given number of months after loan origination.
Boolean	getIsFederal() Override the `is_federal` field.
Boolean	getIsOverdue() Override the `is_overdue` field
Double	getLastPaymentAmount() Override the `last_payment_amount` field.
String	getLoanName() Override the `loan_name` field.
StudentLoanStatus	getLoanStatus() Get loanStatus
Double	getMinimumPaymentAmount() Override the `minimum_payment_amount` field.
Double	getNominalApr() The interest rate on the loan as a percentage.
LocalDate	getOriginationDate() The date on which the loan was initially lent, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format.
String	getPaymentReferenceNumber() Override the `payment_reference_number` field.
Double	getPrincipal() The original loan principal.
PSLFStatus	getPslfStatus() Get pslfStatus
Double	getPurchaseApr() The purchase APR percentage value.
StudentLoanRepaymentModel	getRepaymentModel() Get repaymentModel
String	getRepaymentPlanDescription() Override the `repayment_plan.description` field.
String	getRepaymentPlanType() Override the `repayment_plan.type` field.
String	getSequenceNumber() Override the `sequence_number` field.
Address	getServicerAddress() Get servicerAddress
Double	getSpecialApr() The special APR percentage value.
String	getType() The type of the liability object, either `credit` or `student`.
LiabilityOverride	guarantor(String guarantor)
int	hashCode()
LiabilityOverride	interestCapitalizationGracePeriodMonths(Double interestCapitalizationGracePeriodMonths)
LiabilityOverride	isFederal(Boolean isFederal)
LiabilityOverride	isOverdue(Boolean isOverdue)
LiabilityOverride	lastPaymentAmount(Double lastPaymentAmount)
LiabilityOverride	loanName(String loanName)
LiabilityOverride	loanStatus(StudentLoanStatus loanStatus)
LiabilityOverride	minimumPaymentAmount(Double minimumPaymentAmount)
LiabilityOverride	nominalApr(Double nominalApr)
LiabilityOverride	originationDate(LocalDate originationDate)
LiabilityOverride	paymentReferenceNumber(String paymentReferenceNumber)
LiabilityOverride	principal(Double principal)
LiabilityOverride	pslfStatus(PSLFStatus pslfStatus)
LiabilityOverride	purchaseApr(Double purchaseApr)
LiabilityOverride	repaymentModel(StudentLoanRepaymentModel repaymentModel)
LiabilityOverride	repaymentPlanDescription(String repaymentPlanDescription)
LiabilityOverride	repaymentPlanType(String repaymentPlanType)
LiabilityOverride	sequenceNumber(String sequenceNumber)
LiabilityOverride	servicerAddress(Address servicerAddress)
void	setBalanceTransferApr(Double balanceTransferApr)
void	setCashApr(Double cashApr)
void	setExpectedPayoffDate(LocalDate expectedPayoffDate)
void	setGuarantor(String guarantor)
void	setInterestCapitalizationGracePeriodMonths(Double interestCapitalizationGracePeriodMonths)
void	setIsFederal(Boolean isFederal)
void	setIsOverdue(Boolean isOverdue)
void	setLastPaymentAmount(Double lastPaymentAmount)
void	setLoanName(String loanName)
void	setLoanStatus(StudentLoanStatus loanStatus)
void	setMinimumPaymentAmount(Double minimumPaymentAmount)
void	setNominalApr(Double nominalApr)
void	setOriginationDate(LocalDate originationDate)
void	setPaymentReferenceNumber(String paymentReferenceNumber)
void	setPrincipal(Double principal)
void	setPslfStatus(PSLFStatus pslfStatus)
void	setPurchaseApr(Double purchaseApr)
void	setRepaymentModel(StudentLoanRepaymentModel repaymentModel)
void	setRepaymentPlanDescription(String repaymentPlanDescription)
void	setRepaymentPlanType(String repaymentPlanType)
void	setSequenceNumber(String sequenceNumber)
void	setServicerAddress(Address servicerAddress)
void	setSpecialApr(Double specialApr)
void	setType(String type)
LiabilityOverride	specialApr(Double specialApr)
String	toString()
LiabilityOverride	type(String type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_PURCHASE_APR

public static final String SERIALIZED_NAME_PURCHASE_APR

See Also:

Constant Field Values

SERIALIZED_NAME_CASH_APR

public static final String SERIALIZED_NAME_CASH_APR

See Also:

Constant Field Values

SERIALIZED_NAME_BALANCE_TRANSFER_APR

public static final String SERIALIZED_NAME_BALANCE_TRANSFER_APR

See Also:

Constant Field Values

SERIALIZED_NAME_SPECIAL_APR

public static final String SERIALIZED_NAME_SPECIAL_APR

See Also:

Constant Field Values

SERIALIZED_NAME_LAST_PAYMENT_AMOUNT

public static final String SERIALIZED_NAME_LAST_PAYMENT_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_MINIMUM_PAYMENT_AMOUNT

public static final String SERIALIZED_NAME_MINIMUM_PAYMENT_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_IS_OVERDUE

public static final String SERIALIZED_NAME_IS_OVERDUE

See Also:

Constant Field Values

SERIALIZED_NAME_ORIGINATION_DATE

public static final String SERIALIZED_NAME_ORIGINATION_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_PRINCIPAL

public static final String SERIALIZED_NAME_PRINCIPAL

See Also:

Constant Field Values

SERIALIZED_NAME_NOMINAL_APR

public static final String SERIALIZED_NAME_NOMINAL_APR

See Also:

Constant Field Values

SERIALIZED_NAME_INTEREST_CAPITALIZATION_GRACE_PERIOD_MONTHS

public static final String SERIALIZED_NAME_INTEREST_CAPITALIZATION_GRACE_PERIOD_MONTHS

See Also:

Constant Field Values

SERIALIZED_NAME_REPAYMENT_MODEL

public static final String SERIALIZED_NAME_REPAYMENT_MODEL

See Also:

Constant Field Values

SERIALIZED_NAME_EXPECTED_PAYOFF_DATE

public static final String SERIALIZED_NAME_EXPECTED_PAYOFF_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_GUARANTOR

public static final String SERIALIZED_NAME_GUARANTOR

See Also:

Constant Field Values

SERIALIZED_NAME_IS_FEDERAL

public static final String SERIALIZED_NAME_IS_FEDERAL

See Also:

Constant Field Values

SERIALIZED_NAME_LOAN_NAME

public static final String SERIALIZED_NAME_LOAN_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_LOAN_STATUS

public static final String SERIALIZED_NAME_LOAN_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENT_REFERENCE_NUMBER

public static final String SERIALIZED_NAME_PAYMENT_REFERENCE_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_PSLF_STATUS

public static final String SERIALIZED_NAME_PSLF_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_REPAYMENT_PLAN_DESCRIPTION

public static final String SERIALIZED_NAME_REPAYMENT_PLAN_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_REPAYMENT_PLAN_TYPE

public static final String SERIALIZED_NAME_REPAYMENT_PLAN_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_SEQUENCE_NUMBER

public static final String SERIALIZED_NAME_SEQUENCE_NUMBER

See Also:

Constant Field Values

SERIALIZED_NAME_SERVICER_ADDRESS

public static final String SERIALIZED_NAME_SERVICER_ADDRESS

See Also:

Constant Field Values

Constructor Detail

LiabilityOverride

public LiabilityOverride()

Method Detail

type

public LiabilityOverride type(String type)

getType

public String getType()

The type of the liability object, either `credit` or `student`. Mortgages are not currently supported in the custom Sandbox.

Returns:

type

setType

public void setType(String type)

purchaseApr

public LiabilityOverride purchaseApr(Double purchaseApr)

getPurchaseApr

public Double getPurchaseApr()

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`.

Returns:

purchaseApr

setPurchaseApr

public void setPurchaseApr(Double purchaseApr)

cashApr

public LiabilityOverride cashApr(Double cashApr)

getCashApr

public Double getCashApr()

The cash APR percentage value. Can only be set if `type` is `credit`.

Returns:

cashApr

setCashApr

public void setCashApr(Double cashApr)

balanceTransferApr

public LiabilityOverride balanceTransferApr(Double balanceTransferApr)

getBalanceTransferApr

public Double getBalanceTransferApr()

The balance transfer APR percentage value. Can only be set if `type` is `credit`.

Returns:

balanceTransferApr

setBalanceTransferApr

public void setBalanceTransferApr(Double balanceTransferApr)

specialApr

public LiabilityOverride specialApr(Double specialApr)

getSpecialApr

public Double getSpecialApr()

The special APR percentage value. Can only be set if `type` is `credit`.

Returns:

specialApr

setSpecialApr

public void setSpecialApr(Double specialApr)

lastPaymentAmount

public LiabilityOverride lastPaymentAmount(Double lastPaymentAmount)

getLastPaymentAmount

public Double getLastPaymentAmount()

Override the `last_payment_amount` field. Can only be set if `type` is `credit`.

Returns:

lastPaymentAmount

setLastPaymentAmount

public void setLastPaymentAmount(Double lastPaymentAmount)

minimumPaymentAmount

public LiabilityOverride minimumPaymentAmount(Double minimumPaymentAmount)

getMinimumPaymentAmount

public Double getMinimumPaymentAmount()

Override the `minimum_payment_amount` field. Can only be set if `type` is `credit` or `student`.

Returns:

minimumPaymentAmount

setMinimumPaymentAmount

public void setMinimumPaymentAmount(Double minimumPaymentAmount)

isOverdue

public LiabilityOverride isOverdue(Boolean isOverdue)

getIsOverdue

public Boolean getIsOverdue()

Override the `is_overdue` field

Returns:

isOverdue

setIsOverdue

public void setIsOverdue(Boolean isOverdue)

originationDate

public LiabilityOverride originationDate(LocalDate originationDate)

getOriginationDate

public LocalDate getOriginationDate()

The date on which the loan was initially lent, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Can only be set if `type` is `student`.

Returns:

originationDate

setOriginationDate

public void setOriginationDate(LocalDate originationDate)

principal

public LiabilityOverride principal(Double principal)

getPrincipal

public Double getPrincipal()

The original loan principal. Can only be set if `type` is `student`.

Returns:

principal

setPrincipal

public void setPrincipal(Double principal)

nominalApr

public LiabilityOverride nominalApr(Double nominalApr)

getNominalApr

public Double getNominalApr()

The interest rate on the loan as a percentage. Can only be set if `type` is `student`.

Returns:

nominalApr

setNominalApr

public void setNominalApr(Double nominalApr)

interestCapitalizationGracePeriodMonths

public LiabilityOverride interestCapitalizationGracePeriodMonths(Double interestCapitalizationGracePeriodMonths)

getInterestCapitalizationGracePeriodMonths

public Double getInterestCapitalizationGracePeriodMonths()

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`.

Returns:

interestCapitalizationGracePeriodMonths

setInterestCapitalizationGracePeriodMonths

public void setInterestCapitalizationGracePeriodMonths(Double interestCapitalizationGracePeriodMonths)

repaymentModel

public LiabilityOverride repaymentModel(StudentLoanRepaymentModel repaymentModel)

getRepaymentModel

public StudentLoanRepaymentModel getRepaymentModel()

Get repaymentModel

Returns:

repaymentModel

setRepaymentModel

public void setRepaymentModel(StudentLoanRepaymentModel repaymentModel)

expectedPayoffDate

public LiabilityOverride expectedPayoffDate(LocalDate expectedPayoffDate)

getExpectedPayoffDate

public LocalDate getExpectedPayoffDate()

Override the `expected_payoff_date` field. Can only be set if `type` is `student`.

Returns:

expectedPayoffDate

setExpectedPayoffDate

public void setExpectedPayoffDate(LocalDate expectedPayoffDate)

guarantor

public LiabilityOverride guarantor(String guarantor)

getGuarantor

public String getGuarantor()

Override the `guarantor` field. Can only be set if `type` is `student`.

Returns:

guarantor

setGuarantor

public void setGuarantor(String guarantor)

isFederal

public LiabilityOverride isFederal(Boolean isFederal)

getIsFederal

public Boolean getIsFederal()

Override the `is_federal` field. Can only be set if `type` is `student`.

Returns:

isFederal

setIsFederal

public void setIsFederal(Boolean isFederal)

loanName

public LiabilityOverride loanName(String loanName)

getLoanName

public String getLoanName()

Override the `loan_name` field. Can only be set if `type` is `student`.

Returns:

loanName

setLoanName

public void setLoanName(String loanName)

loanStatus

public LiabilityOverride loanStatus(StudentLoanStatus loanStatus)

getLoanStatus

public StudentLoanStatus getLoanStatus()

Get loanStatus

Returns:

loanStatus

setLoanStatus

public void setLoanStatus(StudentLoanStatus loanStatus)

paymentReferenceNumber

public LiabilityOverride paymentReferenceNumber(String paymentReferenceNumber)

getPaymentReferenceNumber

public String getPaymentReferenceNumber()

Override the `payment_reference_number` field. Can only be set if `type` is `student`.

Returns:

paymentReferenceNumber

setPaymentReferenceNumber

public void setPaymentReferenceNumber(String paymentReferenceNumber)

pslfStatus

public LiabilityOverride pslfStatus(PSLFStatus pslfStatus)

getPslfStatus

public PSLFStatus getPslfStatus()

Get pslfStatus

Returns:

pslfStatus

setPslfStatus

public void setPslfStatus(PSLFStatus pslfStatus)

repaymentPlanDescription

public LiabilityOverride repaymentPlanDescription(String repaymentPlanDescription)

getRepaymentPlanDescription

public String getRepaymentPlanDescription()

Override the `repayment_plan.description` field. Can only be set if `type` is `student`.

Returns:

repaymentPlanDescription

setRepaymentPlanDescription

public void setRepaymentPlanDescription(String repaymentPlanDescription)

repaymentPlanType

public LiabilityOverride repaymentPlanType(String repaymentPlanType)

getRepaymentPlanType

public String getRepaymentPlanType()

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\"`, `\"income-sensitive repayment\"`, `\"interest only\"`, `\"other\"`, `\"pay as you earn\"`, `\"revised pay as you earn\"`, `\"standard\"`, or `\"saving on a valuable education\"`.

Returns:

repaymentPlanType

setRepaymentPlanType

public void setRepaymentPlanType(String repaymentPlanType)

sequenceNumber

public LiabilityOverride sequenceNumber(String sequenceNumber)

getSequenceNumber

public String getSequenceNumber()

Override the `sequence_number` field. Can only be set if `type` is `student`.

Returns:

sequenceNumber

setSequenceNumber

public void setSequenceNumber(String sequenceNumber)

servicerAddress

public LiabilityOverride servicerAddress(Address servicerAddress)

getServicerAddress

public Address getServicerAddress()

Get servicerAddress

Returns:

servicerAddress

setServicerAddress

public void setServicerAddress(Address servicerAddress)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object