plaid2.model.historical_balance module

class plaid2.model.historical_balance.HistoricalBalance(*, current: float, iso_currency_code: Optional[str] = None, unofficial_currency_code: Optional[str] = None, date: str)

Bases: BaseModel

current: float

The total amount of funds in the account, calculated from the current balance in the balance object by subtracting inflows and adding back outflows according to the posted date of each transaction.

If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting.

date: str

//wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD)

Type

The date of the calculated historical balance, in an [ISO 8601](https

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

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

iso_currency_code: Optional[str]

The ISO-4217 currency code of the balance. Always null if unofficial_currency_code is non-null.

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) → HistoricalBalance

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

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

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

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the balance. Always null if iso_currency_code is non-null.

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