com.plaid.client.model

Class EarningsBreakdown

java.lang.Object

com.plaid.client.model.EarningsBreakdown

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class EarningsBreakdown
extends Object

An object representing the earnings line items for the pay period.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CANONICAL_DESCRIPTION
static String	SERIALIZED_NAME_CURRENT_AMOUNT
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_HOURS
static String	SERIALIZED_NAME_ISO_CURRENCY_CODE
static String	SERIALIZED_NAME_RATE
static String	SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE
static String	SERIALIZED_NAME_YTD_AMOUNT

Constructor Summary

Constructors

Constructor and Description
EarningsBreakdown()

Method Summary

Modifier and Type	Method and Description
EarningsBreakdown	canonicalDescription(EarningsBreakdownCanonicalDescription canonicalDescription)
EarningsBreakdown	currentAmount(Double currentAmount)
EarningsBreakdown	description(String description)
boolean	equals(Object o)
EarningsBreakdownCanonicalDescription	getCanonicalDescription() Get canonicalDescription
Double	getCurrentAmount() Raw amount of the earning line item.
String	getDescription() Description of the earning line item.
Double	getHours() Number of hours applicable for this earning.
String	getIsoCurrencyCode() The ISO-4217 currency code of the line item.
Double	getRate() Hourly rate applicable for this earning.
String	getUnofficialCurrencyCode() The unofficial currency code associated with the line item.
Double	getYtdAmount() The year-to-date amount of the deduction.
int	hashCode()
EarningsBreakdown	hours(Double hours)
EarningsBreakdown	isoCurrencyCode(String isoCurrencyCode)
EarningsBreakdown	rate(Double rate)
void	setCanonicalDescription(EarningsBreakdownCanonicalDescription canonicalDescription)
void	setCurrentAmount(Double currentAmount)
void	setDescription(String description)
void	setHours(Double hours)
void	setIsoCurrencyCode(String isoCurrencyCode)
void	setRate(Double rate)
void	setUnofficialCurrencyCode(String unofficialCurrencyCode)
void	setYtdAmount(Double ytdAmount)
String	toString()
EarningsBreakdown	unofficialCurrencyCode(String unofficialCurrencyCode)
EarningsBreakdown	ytdAmount(Double ytdAmount)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_CANONICAL_DESCRIPTION

public static final String SERIALIZED_NAME_CANONICAL_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENT_AMOUNT

public static final String SERIALIZED_NAME_CURRENT_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_HOURS

public static final String SERIALIZED_NAME_HOURS

See Also:

Constant Field Values

SERIALIZED_NAME_ISO_CURRENCY_CODE

public static final String SERIALIZED_NAME_ISO_CURRENCY_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_RATE

public static final String SERIALIZED_NAME_RATE

See Also:

Constant Field Values

SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

public static final String SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_YTD_AMOUNT

public static final String SERIALIZED_NAME_YTD_AMOUNT

See Also:

Constant Field Values

Constructor Detail

EarningsBreakdown

public EarningsBreakdown()

Method Detail

canonicalDescription

public EarningsBreakdown canonicalDescription(EarningsBreakdownCanonicalDescription canonicalDescription)

getCanonicalDescription

@Nullable
public EarningsBreakdownCanonicalDescription getCanonicalDescription()

Get canonicalDescription

Returns:

canonicalDescription

setCanonicalDescription

public void setCanonicalDescription(EarningsBreakdownCanonicalDescription canonicalDescription)

currentAmount

public EarningsBreakdown currentAmount(Double currentAmount)

getCurrentAmount

@Nullable
public Double getCurrentAmount()

Raw amount of the earning line item.

Returns:

currentAmount

setCurrentAmount

public void setCurrentAmount(Double currentAmount)

description

public EarningsBreakdown description(String description)

getDescription

@Nullable
public String getDescription()

Description of the earning line item.

Returns:

description

setDescription

public void setDescription(String description)

hours

public EarningsBreakdown hours(Double hours)

getHours

@Nullable
public Double getHours()

Number of hours applicable for this earning.

Returns:

hours

setHours

public void setHours(Double hours)

isoCurrencyCode

public EarningsBreakdown isoCurrencyCode(String isoCurrencyCode)

getIsoCurrencyCode

@Nullable
public String getIsoCurrencyCode()

The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.

Returns:

isoCurrencyCode

setIsoCurrencyCode

public void setIsoCurrencyCode(String isoCurrencyCode)

rate

public EarningsBreakdown rate(Double rate)

getRate

@Nullable
public Double getRate()

Hourly rate applicable for this earning.

Returns:

rate

setRate

public void setRate(Double rate)

unofficialCurrencyCode

public EarningsBreakdown unofficialCurrencyCode(String unofficialCurrencyCode)

getUnofficialCurrencyCode

@Nullable
public String getUnofficialCurrencyCode()

The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.

Returns:

unofficialCurrencyCode

setUnofficialCurrencyCode

public void setUnofficialCurrencyCode(String unofficialCurrencyCode)

ytdAmount

public EarningsBreakdown ytdAmount(Double ytdAmount)

getYtdAmount

@Nullable
public Double getYtdAmount()

The year-to-date amount of the deduction.

Returns:

ytdAmount

setYtdAmount

public void setYtdAmount(Double ytdAmount)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object