java.lang.Object

com.plaid.client.model.EarningsTotal

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

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

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class EarningsTotal.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_AMOUNT`
`static java.lang.String`	`SERIALIZED_NAME_CURRENT_PAY`
`static java.lang.String`	`SERIALIZED_NAME_HOURS`
`static java.lang.String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static java.lang.String`	`SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE`
`static java.lang.String`	`SERIALIZED_NAME_YTD_AMOUNT`
`static java.lang.String`	`SERIALIZED_NAME_YTD_PAY`

Constructor Summary

Constructors

Constructor Description

EarningsTotal()

Method Summary

Modifier and Type	Method	Description
`EarningsTotal`	`canonicalDescription(EarningsTotal.CanonicalDescriptionEnum canonicalDescription)`
`EarningsTotal`	`currentAmount(java.lang.Double currentAmount)`
`EarningsTotal`	`currentPay(Pay currentPay)`
`boolean`	`equals(java.lang.Object o)`
`EarningsTotal.CanonicalDescriptionEnum`	`getCanonicalDescription()`	Commonly used term to describe the line item.
`java.lang.Double`	`getCurrentAmount()`	Total amount of the earnings for this pay period
`Pay`	`getCurrentPay()`	Get currentPay
`java.lang.Double`	`getHours()`	Total number of hours worked for this pay period
`java.lang.String`	`getIsoCurrencyCode()`	The ISO-4217 currency code of the line item.
`java.lang.String`	`getUnofficialCurrencyCode()`	The unofficial currency code associated with the security.
`java.lang.Double`	`getYtdAmount()`	The total year-to-date amount of the earnings
`Pay`	`getYtdPay()`	Get ytdPay
`int`	`hashCode()`
`EarningsTotal`	`hours(java.lang.Double hours)`
`EarningsTotal`	`isoCurrencyCode(java.lang.String isoCurrencyCode)`
`void`	`setCanonicalDescription(EarningsTotal.CanonicalDescriptionEnum canonicalDescription)`
`void`	`setCurrentAmount(java.lang.Double currentAmount)`
`void`	`setCurrentPay(Pay currentPay)`
`void`	`setHours(java.lang.Double hours)`
`void`	`setIsoCurrencyCode(java.lang.String isoCurrencyCode)`
`void`	`setUnofficialCurrencyCode(java.lang.String unofficialCurrencyCode)`
`void`	`setYtdAmount(java.lang.Double ytdAmount)`
`void`	`setYtdPay(Pay ytdPay)`
`java.lang.String`	`toString()`
`EarningsTotal`	`unofficialCurrencyCode(java.lang.String unofficialCurrencyCode)`
`EarningsTotal`	`ytdAmount(java.lang.Double ytdAmount)`
`EarningsTotal`	`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_CURRENT_AMOUNT
  
  public static final java.lang.String SERIALIZED_NAME_CURRENT_AMOUNT
  
  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
- SERIALIZED_NAME_HOURS
  
  public static final java.lang.String SERIALIZED_NAME_HOURS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_ISO_CURRENCY_CODE
  
  public static final java.lang.String SERIALIZED_NAME_ISO_CURRENCY_CODE
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE
  
  public static final java.lang.String SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_YTD_AMOUNT
  
  public static final java.lang.String SERIALIZED_NAME_YTD_AMOUNT
  
  See Also:
  
  Constant Field Values
Constructor Details
- EarningsTotal
  
  public EarningsTotal()
Method Details
- canonicalDescription
  
  public EarningsTotal canonicalDescription(EarningsTotal.CanonicalDescriptionEnum canonicalDescription)
- getCanonicalDescription
  
  @Nullable public EarningsTotal.CanonicalDescriptionEnum getCanonicalDescription()
  
  Commonly used term to describe the line item.
  
  Returns:
  
  canonicalDescription
- setCanonicalDescription
  
  public void setCanonicalDescription(EarningsTotal.CanonicalDescriptionEnum canonicalDescription)
- currentAmount
  
  public EarningsTotal currentAmount(java.lang.Double currentAmount)
- getCurrentAmount
  
  @Nullable public java.lang.Double getCurrentAmount()
  
  Total amount of the earnings for this pay period
  
  Returns:
  
  currentAmount
- setCurrentAmount
  
  public void setCurrentAmount(java.lang.Double currentAmount)
- currentPay
  
  public EarningsTotal currentPay(Pay currentPay)
- getCurrentPay
  
  @Nullable public Pay getCurrentPay()
  
  Get currentPay
  
  Returns:
  
  currentPay
- setCurrentPay
  
  public void setCurrentPay(Pay currentPay)
- ytdPay
  
  public EarningsTotal ytdPay(Pay ytdPay)
- getYtdPay
  
  @Nullable public Pay getYtdPay()
  
  Get ytdPay
  
  Returns:
  
  ytdPay
- setYtdPay
  
  public void setYtdPay(Pay ytdPay)
- hours
  
  public EarningsTotal hours(java.lang.Double hours)
- getHours
  
  @Nullable public java.lang.Double getHours()
  
  Total number of hours worked for this pay period
  
  Returns:
  
  hours
- setHours
  
  public void setHours(java.lang.Double hours)
- isoCurrencyCode
  
  public EarningsTotal isoCurrencyCode(java.lang.String isoCurrencyCode)
- getIsoCurrencyCode
  
  @Nullable public java.lang.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(java.lang.String isoCurrencyCode)
- unofficialCurrencyCode
  
  public EarningsTotal unofficialCurrencyCode(java.lang.String unofficialCurrencyCode)
- getUnofficialCurrencyCode
  
  @Nullable public java.lang.String getUnofficialCurrencyCode()
  
  The unofficial currency code associated with the security. 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(java.lang.String unofficialCurrencyCode)
- ytdAmount
  
  public EarningsTotal ytdAmount(java.lang.Double ytdAmount)
- getYtdAmount
  
  @Nullable public java.lang.Double getYtdAmount()
  
  The total year-to-date amount of the earnings
  
  Returns:
  
  ytdAmount
- setYtdAmount
  
  public void setYtdAmount(java.lang.Double ytdAmount)
- 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

Class EarningsTotal

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details