com.plaid.client.model

Class LinkTokenCreateRequestIncomeVerificationPayrollIncome

java.lang.Object

com.plaid.client.model.LinkTokenCreateRequestIncomeVerificationPayrollIncome

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

Specifies options for initializing Link for use with Payroll Income (including Document Income). Further customization options for Document Income, such as customizing which document types may be uploaded, are also available via the [Link Customization pane](https://dashboard.plaid.com/link) in the Dashboard. (Requires Production enablement.)

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_FLOW_TYPES
static String	SERIALIZED_NAME_IS_UPDATE_MODE
static String	SERIALIZED_NAME_ITEM_ID_TO_UPDATE
static String	SERIALIZED_NAME_PARSING_CONFIG

Constructor Summary

Constructors

Constructor and Description
LinkTokenCreateRequestIncomeVerificationPayrollIncome()

Method Summary

Modifier and Type	Method and Description
LinkTokenCreateRequestIncomeVerificationPayrollIncome	addFlowTypesItem(IncomeVerificationPayrollFlowType flowTypesItem)
LinkTokenCreateRequestIncomeVerificationPayrollIncome	addParsingConfigItem(IncomeVerificationDocParsingConfig parsingConfigItem)
boolean	equals(Object o)
LinkTokenCreateRequestIncomeVerificationPayrollIncome	flowTypes(List<IncomeVerificationPayrollFlowType> flowTypes)
List<IncomeVerificationPayrollFlowType>	getFlowTypes() The types of payroll income verification to enable for the Link session.
Boolean	getIsUpdateMode() An identifier to indicate whether the income verification Link token will be used for update mode.
String	getItemIdToUpdate() Uniquely identify a payroll income Item to update with.
List<IncomeVerificationDocParsingConfig>	getParsingConfig() The types of analysis to enable for document uploads.
int	hashCode()
LinkTokenCreateRequestIncomeVerificationPayrollIncome	isUpdateMode(Boolean isUpdateMode)
LinkTokenCreateRequestIncomeVerificationPayrollIncome	itemIdToUpdate(String itemIdToUpdate)
LinkTokenCreateRequestIncomeVerificationPayrollIncome	parsingConfig(List<IncomeVerificationDocParsingConfig> parsingConfig)
void	setFlowTypes(List<IncomeVerificationPayrollFlowType> flowTypes)
void	setIsUpdateMode(Boolean isUpdateMode)
void	setItemIdToUpdate(String itemIdToUpdate)
void	setParsingConfig(List<IncomeVerificationDocParsingConfig> parsingConfig)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_FLOW_TYPES

public static final String SERIALIZED_NAME_FLOW_TYPES

See Also:

Constant Field Values

SERIALIZED_NAME_IS_UPDATE_MODE

public static final String SERIALIZED_NAME_IS_UPDATE_MODE

See Also:

Constant Field Values

SERIALIZED_NAME_ITEM_ID_TO_UPDATE

public static final String SERIALIZED_NAME_ITEM_ID_TO_UPDATE

See Also:

Constant Field Values

SERIALIZED_NAME_PARSING_CONFIG

public static final String SERIALIZED_NAME_PARSING_CONFIG

See Also:

Constant Field Values

Constructor Detail

LinkTokenCreateRequestIncomeVerificationPayrollIncome

public LinkTokenCreateRequestIncomeVerificationPayrollIncome()

Method Detail

flowTypes

public LinkTokenCreateRequestIncomeVerificationPayrollIncome flowTypes(List<IncomeVerificationPayrollFlowType> flowTypes)

addFlowTypesItem

public LinkTokenCreateRequestIncomeVerificationPayrollIncome addFlowTypesItem(IncomeVerificationPayrollFlowType flowTypesItem)

getFlowTypes

@Nullable
public List<IncomeVerificationPayrollFlowType> getFlowTypes()

The types of payroll income verification to enable for the Link session. If none are specified, then users will see both document and digital payroll income.

Returns:

flowTypes

setFlowTypes

public void setFlowTypes(List<IncomeVerificationPayrollFlowType> flowTypes)

isUpdateMode

public LinkTokenCreateRequestIncomeVerificationPayrollIncome isUpdateMode(Boolean isUpdateMode)

getIsUpdateMode

@Nullable
public Boolean getIsUpdateMode()

An identifier to indicate whether the income verification Link token will be used for update mode. This field is only relevant for participants in the Payroll Income Refresh beta.

Returns:

isUpdateMode

setIsUpdateMode

public void setIsUpdateMode(Boolean isUpdateMode)

itemIdToUpdate

public LinkTokenCreateRequestIncomeVerificationPayrollIncome itemIdToUpdate(String itemIdToUpdate)

getItemIdToUpdate

@Nullable
public String getItemIdToUpdate()

Uniquely identify a payroll income Item to update with. This field is only relevant for participants in the Payroll Income Refresh beta.

Returns:

itemIdToUpdate

setItemIdToUpdate

public void setItemIdToUpdate(String itemIdToUpdate)

parsingConfig

public LinkTokenCreateRequestIncomeVerificationPayrollIncome parsingConfig(List<IncomeVerificationDocParsingConfig> parsingConfig)

addParsingConfigItem

public LinkTokenCreateRequestIncomeVerificationPayrollIncome addParsingConfigItem(IncomeVerificationDocParsingConfig parsingConfigItem)

getParsingConfig

@Nullable
public List<IncomeVerificationDocParsingConfig> getParsingConfig()

The types of analysis to enable for document uploads. If this field is not provided, then docs will undergo OCR parsing only.

Returns:

parsingConfig

setParsingConfig

public void setParsingConfig(List<IncomeVerificationDocParsingConfig> parsingConfig)

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