com.yodlee.api.model.derived.DerivedCategorySummary 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({"categoryId", "categoryName", "debitTotal", "creditTotal", "details", "links"})
public class DerivedCategorySummary extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "Id of the category. This information is provided by transactions/categories service."//
							  + "

"//
							  + "Applicable containers: creditCard, bank, investment
"//
	)
	@JsonProperty("categoryId")
	private Long categoryId;

	@ApiModelProperty(readOnly = true,
					  value = "The name of the category."//
							  + "

"//
							  + "Applicable containers: creditCard, bank, investment
"//
	)
	@JsonProperty("categoryName")
	private String categoryName;

	@ApiModelProperty(readOnly = true,
					  value = "The total of debit transactions for the category."//
							  + "

"//
							  + "Applicable containers: creditCard, bank, investment
"//
	)
	@JsonProperty("debitTotal")
	private Money debitTotal;

	@ApiModelProperty(readOnly = true,
					  value = "The total of credit transactions for the category."//
							  + "

"//
							  + "Applicable containers: creditCard, bank, investment
"//
	)
	@JsonProperty("creditTotal")
	private Money creditTotal;

	@ApiModelProperty(readOnly = true,
					  value = "Credit and debit summary per date."//
							  + "

"//
							  + "Applicable containers: creditCard, bank, investment
"//
	)
	@JsonProperty("details")
	private List categorySummarydetails;

	@ApiModelProperty(readOnly = true,
					  value = "Link of the API services that corresponds to the value derivation."//
							  + "

"//
							  + "Applicable containers: creditCard, bank, investment
"//
	)
	@JsonProperty("links")
	private DerivedTransactionsLinks links;

	/**
	 * The total of credit transactions for the category. 

	 * 

	 * Applicable containers: creditCard, bank, investment

	 * 
	 * @return creditTotal
	 */
	@JsonProperty("creditTotal")
	public Money getCreditTotal() {
		return creditTotal;
	}

	/**
	 * Credit and debit summary per date. 

	 * 

	 * Applicable containers: creditCard, bank, investment

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

	/**
	 * The total of debit transactions for the category. 

	 * 

	 * Applicable containers: creditCard, bank, investment

	 * 
	 * @return debitTotal
	 */
	public Money getDebitTotal() {
		return debitTotal;
	}

	/**
	 * Link of the API services that corresponds to the value derivation. 

	 * 

	 * Applicable containers: creditCard, bank, investment

	 * 
	 * @return links
	 */
	public DerivedTransactionsLinks getLinks() {
		return links;
	}

	/**
	 * The name of the category. 

	 * 

	 * Applicable containers: creditCard, bank, investment

	 * 
	 * @return categoryName
	 */
	public String getCategoryName() {
		return categoryName;
	}

	/**
	 * Id of the category. This information is provided by transactions/categories service. 

	 * 

	 * Applicable containers: creditCard, bank, investment

	 * 
	 * @return categoryId
	 */
	public Long getCategoryId() {
		return categoryId;
	}

	@Override
	public String toString() {
		return "CategorySummary [creditTotal=" + creditTotal + ", categoryName=" + categoryName + ", categoryId="
				+ categoryId + ", details=" + categorySummarydetails + ", debitTotal=" + debitTotal + ", links=" + links
				+ "]";
	}
}