plaid2.model.income_summary module

class plaid2.model.income_summary.IncomeSummary(*, projected_wage: IncomeSummaryFieldNumber, employer_name: IncomeSummaryFieldString, verified_transaction: Optional[TransactionData] = None, pay_frequency: Optional[PayFrequency] = None, employee_name: IncomeSummaryFieldString, ytd_gross_income: IncomeSummaryFieldNumber, ytd_net_income: IncomeSummaryFieldNumber)

Bases: BaseModel

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

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

employee_name: IncomeSummaryFieldString

The name of the employee, as reported on the paystub.

employer_name: IncomeSummaryFieldString

The name of the employer, as reported on the paystub.

json(**kwargs: Any) → str

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

classmethod parse_obj(data: Any) → IncomeSummary

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

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → IncomeSummary

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

pay_frequency: Optional[PayFrequency]

The frequency of the pay period.

projected_wage: IncomeSummaryFieldNumber

The employee’s estimated annual salary, as derived from information reported on the paystub.

verified_transaction: Optional[TransactionData]

Information about the matched direct deposit transaction used to verify a user’s payroll information.

ytd_gross_income: IncomeSummaryFieldNumber

Year-to-date pre-tax earnings, as reported on the paystub.

ytd_net_income: IncomeSummaryFieldNumber

Year-to-date earnings after any tax withholdings, benefit payments or deductions, as reported on the paystub.