com.plaid.client.model

Class PayPeriodDetails

java.lang.Object

com.plaid.client.model.PayPeriodDetails

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-05-31T23:42:52.209921Z[Etc/UTC]")
public class PayPeriodDetails
extends Object

Details about the pay period.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PayPeriodDetails.PayFrequencyEnum The frequency at which an individual is paid.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CHECK_AMOUNT
static String	SERIALIZED_NAME_DISTRIBUTION_BREAKDOWN
static String	SERIALIZED_NAME_END_DATE
static String	SERIALIZED_NAME_GROSS_EARNINGS
static String	SERIALIZED_NAME_PAY_DATE
static String	SERIALIZED_NAME_PAY_DAY
static String	SERIALIZED_NAME_PAY_FREQUENCY
static String	SERIALIZED_NAME_START_DATE

Constructor Summary

Constructors

Constructor and Description
PayPeriodDetails()

Method Summary

Modifier and Type	Method and Description
PayPeriodDetails	addDistributionBreakdownItem(DistributionBreakdown distributionBreakdownItem)
PayPeriodDetails	checkAmount(Double checkAmount)
PayPeriodDetails	distributionBreakdown(List<DistributionBreakdown> distributionBreakdown)
PayPeriodDetails	endDate(LocalDate endDate)
boolean	equals(Object o)
Double	getCheckAmount() The amount of the paycheck.
List<DistributionBreakdown>	getDistributionBreakdown() Get distributionBreakdown
LocalDate	getEndDate() The pay period end date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
Double	getGrossEarnings() Total earnings before tax/deductions.
LocalDate	getPayDate() The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").
LocalDate	getPayDay() The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").
PayPeriodDetails.PayFrequencyEnum	getPayFrequency() The frequency at which an individual is paid.
LocalDate	getStartDate() The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
PayPeriodDetails	grossEarnings(Double grossEarnings)
int	hashCode()
PayPeriodDetails	payDate(LocalDate payDate)
PayPeriodDetails	payDay(LocalDate payDay)
PayPeriodDetails	payFrequency(PayPeriodDetails.PayFrequencyEnum payFrequency)
void	setCheckAmount(Double checkAmount)
void	setDistributionBreakdown(List<DistributionBreakdown> distributionBreakdown)
void	setEndDate(LocalDate endDate)
void	setGrossEarnings(Double grossEarnings)
void	setPayDate(LocalDate payDate)
void	setPayDay(LocalDate payDay)
void	setPayFrequency(PayPeriodDetails.PayFrequencyEnum payFrequency)
void	setStartDate(LocalDate startDate)
PayPeriodDetails	startDate(LocalDate startDate)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_CHECK_AMOUNT

public static final String SERIALIZED_NAME_CHECK_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_DISTRIBUTION_BREAKDOWN

public static final String SERIALIZED_NAME_DISTRIBUTION_BREAKDOWN

See Also:

Constant Field Values

SERIALIZED_NAME_END_DATE

public static final String SERIALIZED_NAME_END_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_GROSS_EARNINGS

public static final String SERIALIZED_NAME_GROSS_EARNINGS

See Also:

Constant Field Values

SERIALIZED_NAME_PAY_DATE

public static final String SERIALIZED_NAME_PAY_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_PAY_FREQUENCY

public static final String SERIALIZED_NAME_PAY_FREQUENCY

See Also:

Constant Field Values

SERIALIZED_NAME_PAY_DAY

public static final String SERIALIZED_NAME_PAY_DAY

See Also:

Constant Field Values

SERIALIZED_NAME_START_DATE

public static final String SERIALIZED_NAME_START_DATE

See Also:

Constant Field Values

Constructor Detail

PayPeriodDetails

public PayPeriodDetails()

Method Detail

checkAmount

public PayPeriodDetails checkAmount(Double checkAmount)

getCheckAmount

@Nullable
public Double getCheckAmount()

The amount of the paycheck.

Returns:

checkAmount

setCheckAmount

public void setCheckAmount(Double checkAmount)

distributionBreakdown

public PayPeriodDetails distributionBreakdown(List<DistributionBreakdown> distributionBreakdown)

addDistributionBreakdownItem

public PayPeriodDetails addDistributionBreakdownItem(DistributionBreakdown distributionBreakdownItem)

getDistributionBreakdown

@Nullable
public List<DistributionBreakdown> getDistributionBreakdown()

Get distributionBreakdown

Returns:

distributionBreakdown

setDistributionBreakdown

public void setDistributionBreakdown(List<DistributionBreakdown> distributionBreakdown)

endDate

public PayPeriodDetails endDate(LocalDate endDate)

getEndDate

@Nullable
public LocalDate getEndDate()

The pay period end date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".

Returns:

endDate

setEndDate

public void setEndDate(LocalDate endDate)

grossEarnings

public PayPeriodDetails grossEarnings(Double grossEarnings)

getGrossEarnings

@Nullable
public Double getGrossEarnings()

Total earnings before tax/deductions.

Returns:

grossEarnings

setGrossEarnings

public void setGrossEarnings(Double grossEarnings)

payDate

public PayPeriodDetails payDate(LocalDate payDate)

getPayDate

@Nullable
public LocalDate getPayDate()

The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").

Returns:

payDate

setPayDate

public void setPayDate(LocalDate payDate)

payFrequency

public PayPeriodDetails payFrequency(PayPeriodDetails.PayFrequencyEnum payFrequency)

getPayFrequency

@Nullable
public PayPeriodDetails.PayFrequencyEnum getPayFrequency()

The frequency at which an individual is paid.

Returns:

payFrequency

setPayFrequency

public void setPayFrequency(PayPeriodDetails.PayFrequencyEnum payFrequency)

payDay

public PayPeriodDetails payDay(LocalDate payDay)

getPayDay

@Nullable
public LocalDate getPayDay()

The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").

Returns:

payDay

setPayDay

public void setPayDay(LocalDate payDay)

startDate

public PayPeriodDetails startDate(LocalDate startDate)

getStartDate

@Nullable
public LocalDate getStartDate()

The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".

Returns:

startDate

setStartDate

public void setStartDate(LocalDate startDate)

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