plaid2.model.pay_stub_pay_period_details module

class plaid2.model.pay_stub_pay_period_details.PayStubPayPeriodDetails(*, iso_currency_code: Optional[str] = None, distribution_breakdown: List[PayStubDistributionBreakdown], pay_date: Optional[str] = None, end_date: Optional[str] = None, pay_amount: Optional[float] = None, gross_earnings: Optional[float] = None, unofficial_currency_code: Optional[str] = None, pay_frequency: Optional[str] = None, start_date: Optional[str] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

distribution_breakdown: List[PayStubDistributionBreakdown]

end_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type: The date on which the pay period ended, in [ISO 8601](https

gross_earnings: Optional[float]: Total earnings before tax/deductions.

iso_currency_code: Optional[str]: The ISO-4217 currency code of the net pay. Always null if unofficial_currency_code is non-null.

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → PayStubPayPeriodDetails[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) → PayStubPayPeriodDetails[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

pay_amount: Optional[float]: The amount of the paycheck.

pay_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type: The date on which the pay stub was issued, in [ISO 8601](https

pay_frequency: Optional[str]: The frequency at which an individual is paid.

start_date: Optional[str]

//wikipedia.org/wiki/ISO_8601) format (“yyyy-mm-dd”).

Type: The date on which the pay period started, in [ISO 8601](https

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the net pay. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.

See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.