com.plaid.client.model

Class IncomeSummary

java.lang.Object

com.plaid.client.model.IncomeSummary

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class IncomeSummary
extends Object

The verified fields from a paystub verification. All fields are provided as reported on the paystub.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_EMPLOYEE_NAME
static String	SERIALIZED_NAME_EMPLOYER_NAME
static String	SERIALIZED_NAME_PAY_FREQUENCY
static String	SERIALIZED_NAME_PROJECTED_WAGE
static String	SERIALIZED_NAME_VERIFIED_TRANSACTION
static String	SERIALIZED_NAME_YTD_GROSS_INCOME
static String	SERIALIZED_NAME_YTD_NET_INCOME

Constructor Summary

Constructors

Constructor and Description
IncomeSummary()

Method Summary

Modifier and Type	Method and Description
IncomeSummary	employeeName(EmployeeIncomeSummaryFieldString employeeName)
IncomeSummary	employerName(EmployerIncomeSummaryFieldString employerName)
boolean	equals(Object o)
EmployeeIncomeSummaryFieldString	getEmployeeName() Get employeeName
EmployerIncomeSummaryFieldString	getEmployerName() Get employerName
PayFrequency	getPayFrequency() Get payFrequency
ProjectedIncomeSummaryFieldNumber	getProjectedWage() Get projectedWage
TransactionData	getVerifiedTransaction() Get verifiedTransaction
YTDGrossIncomeSummaryFieldNumber	getYtdGrossIncome() Get ytdGrossIncome
YTDNetIncomeSummaryFieldNumber	getYtdNetIncome() Get ytdNetIncome
int	hashCode()
IncomeSummary	payFrequency(PayFrequency payFrequency)
IncomeSummary	projectedWage(ProjectedIncomeSummaryFieldNumber projectedWage)
void	setEmployeeName(EmployeeIncomeSummaryFieldString employeeName)
void	setEmployerName(EmployerIncomeSummaryFieldString employerName)
void	setPayFrequency(PayFrequency payFrequency)
void	setProjectedWage(ProjectedIncomeSummaryFieldNumber projectedWage)
void	setVerifiedTransaction(TransactionData verifiedTransaction)
void	setYtdGrossIncome(YTDGrossIncomeSummaryFieldNumber ytdGrossIncome)
void	setYtdNetIncome(YTDNetIncomeSummaryFieldNumber ytdNetIncome)
String	toString()
IncomeSummary	verifiedTransaction(TransactionData verifiedTransaction)
IncomeSummary	ytdGrossIncome(YTDGrossIncomeSummaryFieldNumber ytdGrossIncome)
IncomeSummary	ytdNetIncome(YTDNetIncomeSummaryFieldNumber ytdNetIncome)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_EMPLOYER_NAME

public static final String SERIALIZED_NAME_EMPLOYER_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_EMPLOYEE_NAME

public static final String SERIALIZED_NAME_EMPLOYEE_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_YTD_GROSS_INCOME

public static final String SERIALIZED_NAME_YTD_GROSS_INCOME

See Also:

Constant Field Values

SERIALIZED_NAME_YTD_NET_INCOME

public static final String SERIALIZED_NAME_YTD_NET_INCOME

See Also:

Constant Field Values

SERIALIZED_NAME_PAY_FREQUENCY

public static final String SERIALIZED_NAME_PAY_FREQUENCY

See Also:

Constant Field Values

SERIALIZED_NAME_PROJECTED_WAGE

public static final String SERIALIZED_NAME_PROJECTED_WAGE

See Also:

Constant Field Values

SERIALIZED_NAME_VERIFIED_TRANSACTION

public static final String SERIALIZED_NAME_VERIFIED_TRANSACTION

See Also:

Constant Field Values

Constructor Detail

IncomeSummary

public IncomeSummary()

Method Detail

employerName

public IncomeSummary employerName(EmployerIncomeSummaryFieldString employerName)

getEmployerName

public EmployerIncomeSummaryFieldString getEmployerName()

Get employerName

Returns:

employerName

setEmployerName

public void setEmployerName(EmployerIncomeSummaryFieldString employerName)

employeeName

public IncomeSummary employeeName(EmployeeIncomeSummaryFieldString employeeName)

getEmployeeName

public EmployeeIncomeSummaryFieldString getEmployeeName()

Get employeeName

Returns:

employeeName

setEmployeeName

public void setEmployeeName(EmployeeIncomeSummaryFieldString employeeName)

ytdGrossIncome

public IncomeSummary ytdGrossIncome(YTDGrossIncomeSummaryFieldNumber ytdGrossIncome)

getYtdGrossIncome

public YTDGrossIncomeSummaryFieldNumber getYtdGrossIncome()

Get ytdGrossIncome

Returns:

ytdGrossIncome

setYtdGrossIncome

public void setYtdGrossIncome(YTDGrossIncomeSummaryFieldNumber ytdGrossIncome)

ytdNetIncome

public IncomeSummary ytdNetIncome(YTDNetIncomeSummaryFieldNumber ytdNetIncome)

getYtdNetIncome

public YTDNetIncomeSummaryFieldNumber getYtdNetIncome()

Get ytdNetIncome

Returns:

ytdNetIncome

setYtdNetIncome

public void setYtdNetIncome(YTDNetIncomeSummaryFieldNumber ytdNetIncome)

payFrequency

public IncomeSummary payFrequency(PayFrequency payFrequency)

getPayFrequency

@Nullable
public PayFrequency getPayFrequency()

Get payFrequency

Returns:

payFrequency

setPayFrequency

public void setPayFrequency(PayFrequency payFrequency)

projectedWage

public IncomeSummary projectedWage(ProjectedIncomeSummaryFieldNumber projectedWage)

getProjectedWage

public ProjectedIncomeSummaryFieldNumber getProjectedWage()

Get projectedWage

Returns:

projectedWage

setProjectedWage

public void setProjectedWage(ProjectedIncomeSummaryFieldNumber projectedWage)

verifiedTransaction

public IncomeSummary verifiedTransaction(TransactionData verifiedTransaction)

getVerifiedTransaction

@Nullable
public TransactionData getVerifiedTransaction()

Get verifiedTransaction

Returns:

verifiedTransaction

setVerifiedTransaction

public void setVerifiedTransaction(TransactionData verifiedTransaction)

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