plaid2.model.earnings_breakdown module
- class plaid2.model.earnings_breakdown.EarningsBreakdown(*, iso_currency_code: Optional[str] = None, current_amount: Optional[float] = None, hours: Optional[float] = None, rate: Optional[float] = None, ytd_amount: Optional[float] = None, description: Optional[str] = None, canonical_description: Optional[str] = None, unofficial_currency_code: Optional[str] = None)[source]
Bases:
BaseModel- canonical_description: Optional[str]
Commonly used term to describe the earning line item.
- current_amount: Optional[float]
Raw amount of the earning line item.
- description: Optional[str]
Description of the earning line item.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- hours: Optional[float]
Number of hours applicable for this earning.
- iso_currency_code: Optional[str]
The ISO-4217 currency code of the line item. 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) EarningsBreakdown[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) EarningsBreakdown[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- rate: Optional[float]
Hourly rate applicable for this earning.
- unofficial_currency_code: Optional[str]
The unofficial currency code associated with the line item. 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.
- ytd_amount: Optional[float]
The year-to-date amount of the deduction.