plaid2.model.transactions_get_request_options module
- class plaid2.model.transactions_get_request_options.TransactionsGetRequestOptions(*, include_personal_finance_category: Optional[bool] = None, account_ids: Optional[List[str]] = None, include_personal_finance_category_beta: Optional[bool] = None, offset: Optional[int] = None, include_original_description: Optional[bool] = None, count: Optional[int] = None)[source]
Bases:
BaseModel
- account_ids: Optional[List[str]]
A list of account_ids to retrieve for the Item
Note: An error will be returned if a provided account_id is not associated with the Item.
- count: Optional[int]
The number of transactions to fetch.
- dict(**kwargs: Any) Dict[str, Any] [source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- include_original_description: Optional[bool]
Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.
- include_personal_finance_category: Optional[bool]
//plaid.com/docs/api/products/transactions/#transactions-get-response-transactions-personal-finance-category) object in the response.
See the [taxonomy csv file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.
We’re introducing Category Rules - a new beta endpoint that will enable you to change the personal_finance_category for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.
- Type
Include the [personal_finance_category](https
- include_personal_finance_category_beta: Optional[bool]
//plaid.com/docs/api/products/transactions/#transactions-get-request-options-include-personal-finance-category) instead.
- Type
Please use [include_personal_finance_category](https
- json(**kwargs: Any) str [source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- offset: Optional[int]
The number of transactions to skip. The default value is 0.
- classmethod parse_obj(data: Any) TransactionsGetRequestOptions [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) TransactionsGetRequestOptions [source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw