com.yodlee.api.model.derived.DerivedNetworth 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.derived;

import java.util.Collections;
import java.util.List;
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({"date", "asset", "liability", "networth", "historicalBalances"})
public class DerivedNetworth extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "The date as of when the networth information is provided."//
							  + "

"//
							  + "Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
"//
	)
	@JsonProperty("date")
	private String date;

	@ApiModelProperty(readOnly = true,
					  value = "The asset value that the user owns."//
							  + "

"//
							  + "Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
"//
	)
	@JsonProperty("asset")
	private Money asset;

	@ApiModelProperty(readOnly = true,
					  value = "The liability amount that the user owes."//
							  + "

"//
							  + "Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
"//
	)
	@JsonProperty("liability")
	private Money liability;

	@ApiModelProperty(readOnly = true,
					  value = "Networth of the user."//
							  + "

"//
							  + "Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
"//
	)
	@JsonProperty("networth")
	private Money networth;

	@ApiModelProperty(readOnly = true,
					  value = "Balances of the accounts over the period of time."//
							  + "

"//
							  + "Applicable containers: bank, creditcard, investment, insurance, realEstate, loan
"//
	)
	@JsonProperty("historicalBalances")
	private List historicalBalances;

	/**
	 * The date as of when the networth information is provided. 

	 * 

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

	 * 
	 * @return date
	 */
	public String getDate() {
		return date;
	}

	/**
	 * The asset value that the user owns. 

	 * 

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

	 * 
	 * @return asset
	 */
	public Money getAsset() {
		return asset;
	}

	/**
	 * The liability amount that the user owes. 

	 * 

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

	 * 
	 * @return liability
	 */
	public Money getLiability() {
		return liability;
	}

	/**
	 * Networth of the user. 

	 * 

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

	 * 
	 * @return networth
	 */
	public Money getNetworth() {
		return networth;
	}

	/**
	 * Balances of the accounts over the period of time. 

	 * 

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

	 * 
	 * @return historicalBalances
	 */
	@JsonProperty("historicalBalances")
	public List getHistoricalBalances() {
		return historicalBalances == null ? null : Collections.unmodifiableList(historicalBalances);
	}

	@Override
	public String toString() {
		return "DerivedNetworth [date=" + date + ", asset=" + asset + ", liability=" + liability + ", networth="
				+ networth + ", historicalBalances=" + historicalBalances + "]";
	}
}