Package com.plaid.client.model

Class Total

java.lang.Object

com.plaid.client.model.Total

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class Total
extends java.lang.Object

An object representing both the current pay period and year to date amount for a category.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Total.CanonicalDescriptionEnum	Commonly used term to describe the line item.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SERIALIZED_NAME_CANONICAL_DESCRIPTION
static java.lang.String	SERIALIZED_NAME_CURRENT_PAY
static java.lang.String	SERIALIZED_NAME_DESCRIPTION
static java.lang.String	SERIALIZED_NAME_YTD_PAY

Constructor Summary

Constructors

Constructor	Description
Total()

Method Summary

Modifier and Type	Method	Description
Total	canonicalDescription(Total.CanonicalDescriptionEnum canonicalDescription)
Total	currentPay(Pay currentPay)
Total	description(java.lang.String description)
boolean	equals(java.lang.Object o)
Total.CanonicalDescriptionEnum	getCanonicalDescription()	Commonly used term to describe the line item.
Pay	getCurrentPay()	Get currentPay
java.lang.String	getDescription()	Text of the line item as printed on the paystub.
Pay	getYtdPay()	Get ytdPay
int	hashCode()
void	setCanonicalDescription(Total.CanonicalDescriptionEnum canonicalDescription)
void	setCurrentPay(Pay currentPay)
void	setDescription(java.lang.String description)
void	setYtdPay(Pay ytdPay)
java.lang.String	toString()
Total	ytdPay(Pay ytdPay)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_CANONICAL_DESCRIPTION

public static final java.lang.String SERIALIZED_NAME_CANONICAL_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final java.lang.String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENT_PAY

public static final java.lang.String SERIALIZED_NAME_CURRENT_PAY

See Also:

Constant Field Values

SERIALIZED_NAME_YTD_PAY

public static final java.lang.String SERIALIZED_NAME_YTD_PAY

See Also:

Constant Field Values

Constructor Details

Total

public Total()

Method Details

canonicalDescription

public Total canonicalDescription(Total.CanonicalDescriptionEnum canonicalDescription)

getCanonicalDescription

@Nullable public Total.CanonicalDescriptionEnum getCanonicalDescription()

Commonly used term to describe the line item.

Returns:

canonicalDescription

setCanonicalDescription

public void setCanonicalDescription(Total.CanonicalDescriptionEnum canonicalDescription)

description

public Total description(java.lang.String description)

getDescription

@Nullable public java.lang.String getDescription()

Text of the line item as printed on the paystub.

Returns:

description

setDescription

public void setDescription(java.lang.String description)

currentPay

public Total currentPay(Pay currentPay)

getCurrentPay

@Nullable public Pay getCurrentPay()

Get currentPay

Returns:

currentPay

setCurrentPay

public void setCurrentPay(Pay currentPay)

ytdPay

public Total ytdPay(Pay ytdPay)

getYtdPay

@Nullable public Pay getYtdPay()

Get ytdPay

Returns:

ytdPay

setYtdPay

public void setYtdPay(Pay ytdPay)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object