plaid2.model.credit_employment_verification module

class plaid2.model.credit_employment_verification.CreditEmploymentVerification(*, status: Optional[str] = None, employer: str, last_paystub_date: Optional[str] = None, end_date: Optional[str] = None, start_date: Optional[str] = None, title: Optional[str] = None, platform_ids: CreditPlatformIds, account_id: Optional[str] = None, employee_type: Optional[str] = None)[source]

Bases: BaseModel

account_id: Optional[str]

ID of the payroll provider account.

dict(**kwargs: Any) Dict[str, Any][source]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

employee_type: Optional[str]

The type of employment for the individual. “FULL_TIME”: A full-time employee. “PART_TIME”: A part-time employee. “CONTRACTOR”: An employee typically hired externally through a contracting group. “TEMPORARY”: A temporary employee. “OTHER”: The employee type is not one of the above defined types.

employer: str

An object containing employer data.

end_date: Optional[str]

End of employment, if applicable. Provided in ISO 8601 format (YYY-MM-DD).

json(**kwargs: Any) str[source]

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

last_paystub_date: Optional[str]

The date of the employee’s most recent paystub in ISO 8601 format (YYYY-MM-DD).

classmethod parse_obj(data: Any) CreditEmploymentVerification[source]

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) CreditEmploymentVerification[source]

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

platform_ids: CreditPlatformIds

The object containing a set of ids related to an employee.

start_date: Optional[str]

Start of employment in ISO 8601 format (YYYY-MM-DD).

status: Optional[str]

Current employment status.

title: Optional[str]

Current title of employee.