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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yodlee-api-model-beta Show documentation
Yodlee API Model Beta is the stage version
There is a newer version: 1.0.29.beta1
Show newest version
/**
 * 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 com.yodlee.api.model.account.enums.DataPointSource;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"isAsset", "date", "asOfDate", "dataSourceType", "balance"})
public class HistoricalBalance extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "Indicates whether the balance is an asset or liability."//
							  + "

"//
							  + "Aggregated / Manual: Both 
"//
							  + "Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts/historicalBalances"//
							  + "")
	@JsonProperty("isAsset")
	private Boolean isAsset;

	@ApiModelProperty(readOnly = true,
					  value = "Date for which the account balance was provided.  This balance could be a carryforward, calculated or a scraped balance."//
							  + "
Additional Details:"//
							  + "
Scraped: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user account updates."//
							  + "
CarryForward: Balance carried forward from the scraped balance to the days for which the balance was not available in the system. Balance may not be available for all the days in the system due to MFA information required, error in the site, credential changes, etc."//
							  + "
calculated: Balances that gets calculated for the days that are prior to the account added date.  "//
							  + "

"//
							  + "Aggregated / Manual: Both 
"//
							  + "Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts/historicalBalances"//
							  + "GET derived/networth"//
							  + "")
	@JsonProperty("date")
	private String date;

	@ApiModelProperty(readOnly = true,
					  value = "Date as of when the balance is last updated due to the auto account updates or user triggered updates. This balance will be carry forward for the days where there is no balance available in the system. "//
							  + "

"//
							  + "Aggregated / Manual: Both 
"//
							  + "Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts/historicalBalances"//
							  + "")
	@JsonProperty("asOfDate")
	private String asOfDate;

	@ApiModelProperty(readOnly = true,
					  value = "The source of balance information."//
							  + "

"//
							  + "Aggregated / Manual: Both 
"//
							  + "Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts/historicalBalances"//
							  + ""//
							  + "Applicable Values
"//
	)
	@JsonProperty("dataSourceType")
	private DataPointSource dataSourceType;

	@ApiModelProperty(readOnly = true,
					  value = "Balance amount of the account."//
							  + "

"//
							  + "Aggregated / Manual: Both 
"//
							  + "Applicable containers: bank, creditCard, investment, insurance, realEstate, loan
"//
							  + "Endpoints:"//
							  + ""//
							  + "GET accounts/historicalBalances"//
							  + "")
	@JsonProperty("balance")
	private Money balance;

	/**
	 * Balance amount of the account. 

	 * 

	 * Aggregated / Manual: Both 

	 * Applicable containers: bank, creditCard, investment, insurance, realEstate, loan

	 * Endpoints:
	 * 
	 * GET accounts/historicalBalances
	 * 
	 * 
	 * @return balance
	 */
	public Money getBalance() {
		return balance;
	}

	/**
	 * Date as of when the balance is last updated due to the auto account updates or user triggered updates. This
	 * balance will be carry forward for the days where there is no balance available in the system. 

	 * 

	 * Aggregated / Manual: Both 

	 * Applicable containers: bank, creditCard, investment, insurance, realEstate, loan

	 * Endpoints:
	 * 
	 * GET accounts/historicalBalances
	 * 
	 * 
	 * @return asOfDate
	 */
	public String getAsOfDate() {
		return asOfDate;
	}

	/**
	 * Indicates whether the balance is an asset or liability. 

	 * 

	 * Aggregated / Manual: Both 

	 * Applicable containers: bank, creditCard, investment, insurance, realEstate, loan

	 * Endpoints:
	 * 
	 * GET accounts/historicalBalances
	 * 
	 * 
	 * @return isAsset
	 */
	public Boolean getIsAsset() {
		return isAsset;
	}

	/**
	 * Date for which the account balance was provided. This balance could be a carryforward, calculated or a scraped
	 * balance. 

	 * Additional Details: 

	 * Scraped: Balance shown in the provider site. This balance gets stored in Yodlee system during system/user
	 * account updates. 

	 * CarryForward: Balance carried forward from the scraped balance to the days for which the balance was not
	 * available in the system. Balance may not be available for all the days in the system due to MFA information
	 * required, error in the site, credential changes, etc. 

	 * calculated: Balances that gets calculated for the days that are prior to the account added date. 

	 * 

	 * Aggregated / Manual: Both 

	 * Applicable containers: bank, creditCard, investment, insurance, realEstate, loan

	 * Endpoints:
	 * 
	 * GET accounts/historicalBalances
	 * GET derived/networth
	 * 
	 * 
	 * @return date
	 */
	public String getDate() {
		return date;
	}

	/**
	 * The source of balance information. 

	 * 

	 * Aggregated / Manual: Both 

	 * Applicable containers: bank, creditCard, investment, insurance, realEstate, loan

	 * Endpoints:
	 * 
	 * GET accounts/historicalBalances
	 * 
	 * Applicable Values

	 * 
	 * @return dataSourceType
	 */
	public DataPointSource getDataSourceType() {
		return dataSourceType;
	}

	@Override
	public String toString() {
		return "HistoricalBalance [isAsset=" + isAsset + ", date=" + date + ", asOfDate=" + asOfDate
				+ ", dataSourceType=" + dataSourceType + ", balance=" + balance + "]";
	}
}