All Implemented Interfaces:
```
public final class Income

                    
```
The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Income.Builder`	A builder for Income.
`public final class`	`Income.Unit`	The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<Long>`	`amount()`	The income amount in cents.
`final Optional<String>`	`currency()`	The currency code.
`final Optional<LocalDate>`	`effectiveDate()`	The date the income amount went into effect.
`final Optional<Income.Unit>`	`unit()`	The income unit of payment.
`final JsonField<Long>`	`_amount()`	Returns the raw JSON value of amount.
`final JsonField<String>`	`_currency()`	Returns the raw JSON value of currency.
`final JsonField<LocalDate>`	`_effectiveDate()`	Returns the raw JSON value of effectiveDate.
`final JsonField<Income.Unit>`	`_unit()`	Returns the raw JSON value of unit.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final Income.Builder`	`toBuilder()`
`final Income`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static Income.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Income.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - amount
```
 final Optional<Long> amount()
```
    The income amount in cents.
  - currency
```
 final Optional<String> currency()
```
    The currency code.
  - effectiveDate
```
 final Optional<LocalDate> effectiveDate()
```
    The date the income amount went into effect.
  - unit
```
 final Optional<Income.Unit> unit()
```
    The income unit of payment. Options: yearly, quarterly, monthly, semi_monthly, bi_weekly, weekly, daily, hourly, and fixed.
  - _amount
```
 final JsonField<Long> _amount()
```
    Returns the raw JSON value of amount.
    Unlike amount, this method doesn't throw if the JSON field has an unexpected type.
  - _currency
```
 final JsonField<String> _currency()
```
    Returns the raw JSON value of currency.
    Unlike currency, this method doesn't throw if the JSON field has an unexpected type.
  - _effectiveDate
```
 final JsonField<LocalDate> _effectiveDate()
```
    Returns the raw JSON value of effectiveDate.
    Unlike effectiveDate, this method doesn't throw if the JSON field has an unexpected type.
  - _unit
```
 final JsonField<Income.Unit> _unit()
```
    Returns the raw JSON value of unit.
    Unlike unit, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final Income.Builder toBuilder()
```
  - validate
```
 final Income validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static Income.Builder builder()
```
    Returns a mutable builder for constructing an instance of Income.
    The following fields are required:
    .amount() .currency() .effectiveDate() .unit()

Class Income

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

amount

currency

effectiveDate

unit

_amount

_currency

_effectiveDate

_unit

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder