com.yodlee.api.model.account.LoanPayoffDetails Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2019 Yodlee, Inc. All Rights Reserved.
 *
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
package com.yodlee.api.model.account;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.yodlee.api.model.AbstractModelComponent;
import com.yodlee.api.model.Money;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"payByDate", "payoffAmount", "outstandingBalance"})
public class LoanPayoffDetails extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "The date by which the payoff amount should be paid."//
							  + "

"//
							  + "Account Type: Aggregated
"//
							  + "Applicable containers: loan
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts"//
							  + "GET accounts/{accountId}"//
							  + "")
	@JsonProperty("payByDate")
	private String payByDate;

	@ApiModelProperty(readOnly = true,
					  value = "The loan payoff amount."//
							  + "

"//
							  + "Account Type: Aggregated
"//
							  + "Applicable containers: loan
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts"//
							  + "GET accounts/{accountId}"//
							  + "")
	@JsonProperty("payoffAmount")
	private Money payoffAmount;

	@ApiModelProperty(readOnly = true,
					  value = "The outstanding balance on the loan account. "//
							  + "The outstanding balance amount may differ from the payoff amount. "//
							  + "It is usually the sum of outstanding principal, unpaid interest, and fees, if any."//
							  + "

"//
							  + "Account Type: Aggregated
"//
							  + "Applicable containers: loan
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts"//
							  + "GET accounts/{accountId}"//
							  + "")
	@JsonProperty("outstandingBalance")
	private Money outstandingBalance;

	/**
	 * The date by which the payoff amount should be paid. 

	 * 

	 * Account Type: Aggregated

	 * Applicable containers: loan

	 * Endpoints:
	 * 
	 * GET accounts
	 * GET accounts/{accountId}
	 * 
	 * 
	 * @return payByDate
	 */
	public String getPayByDate() {
		return payByDate;
	}

	/**
	 * The loan payoff amount. 

	 * 

	 * Account Type: Aggregated

	 * Applicable containers: loan

	 * Endpoints:
	 * 
	 * GET accounts
	 * GET accounts/{accountId}
	 * 
	 * 
	 * @return payoffAmount
	 */
	public Money getPayoffAmount() {
		return payoffAmount;
	}

	/**
	 * The outstanding balance on the loan account. The outstanding balance amount may differ from the payoff amount. It
	 * is usually the sum of outstanding principal, unpaid interest, and fees, if any. 

	 * 

	 * Account Type: Aggregated

	 * Applicable containers: loan

	 * Endpoints:
	 * 
	 * GET accounts
	 * GET accounts/{accountId}
	 * 
	 * 
	 * @return outstandingBalance
	 */
	public Money getOutstandingBalance() {
		return outstandingBalance;
	}

	public void setOutstandingBalance(Money outstandingBalance) {
		this.outstandingBalance = outstandingBalance;
	}

	@Override
	public String toString() {
		return "LoanPayoffDetails [payByDate=" + payByDate + ", payoffAmount=" + payoffAmount + ", outstandingBalance="
				+ outstandingBalance + "]";
	}
}