woob.capabilities.bank.wealth
¶
- class PerVersion(*args, **kwargs)[source]¶
Bases:
Enum
- PERIN = 'perin'¶
- PERCOL = 'percol'¶
- PERCAT = 'percat'¶
- class Per(id='0', url=NotLoaded)[source]¶
Bases:
Account
Account type dedicated to PER retirement savings plans.
- Variables:
url – (
str
) urllabel – (
str
) Pretty labelcurrency – (
str
) Currency (default: None)bank_name – (
str
) Bank Nametype – (
int
) Type of account (default: 0)owner_type – (
str
) Usage of accountbalance – (
Decimal
) Balance on this bank accountcoming – (
Decimal
) Sum of coming movementsiban – (
str
) International Bank Account Numberownership – (
str
) Relationship between the credentials owner (PSU) and the accountpaydate – (
date
,datetime
) For credit cards. When next payment is due.paymin – (
Decimal
) For credit cards. Minimal payment due.cardlimit – (
Decimal
) For credit cards. Credit limit.number – (
str
) Shown by the bank to identify your account ie XXXXX7489valuation_diff – (
Decimal
) +/- values totalvaluation_diff_ratio – (
Decimal
) +/- values ratiomanagement_type – (
str
) Management type of account (default: None)company_name – (
str
) Name of the company of the stock - only for employee savingsparent – (
BaseAccount
) Parent accountopening_date – (
date
,datetime
) Date when the account contract was created on the bankall_balances – (
list
) List of balances (default: [])party – (
AccountParty
) Party associated to the account (default: None)version – (
str
) Version of PERprovider_type – (
str
) Type of account provider
- class Investment(id='', url=NotLoaded, backend=None)[source]¶
Bases:
BaseObject
Investment in a financial market.
- Variables:
url – (
str
) urllabel – (
str
) Label of stockscode – (
str
) Identifier of the stockcode_type – (
str
) Type of stock code (ISIN or AMF)stock_symbol – (
str
) Alternative identifier of the stock (different from ISIN)stock_market – (
str
) Stock market related to the stockdescription – (
str
) Short description of the stockquantity – (
Decimal
) Quantity of stocksunitprice – (
Decimal
) Buy price of one stockunitvalue – (
Decimal
) Current value of one stockvaluation – (
Decimal
) Total current valuation of the Investmentvdate – (
date
,datetime
) Value date of the valuation amountdiff – (
Decimal
) Difference between the buy cost and the current valuationdiff_ratio – (
Decimal
) Difference in ratio (1 meaning 100%) between the buy cost and the current valuationportfolio_share – (
Decimal
) Ratio (1 meaning 100%) of the current amount relative to the totalperformance_history – (
dict
) History of the performances of the stock (key=years, value=diff_ratio)srri – (
int
) Synthetic Risk and Reward Indicator of the stock (from 1 to 7)asset_category – (
str
) Category of the stockrecommended_period – (
str
) Recommended investment period of the stockoriginal_currency – (
str
) Currency of the original amountoriginal_valuation – (
Decimal
) Original valuation (in another currency)original_unitvalue – (
Decimal
) Original unitvalue (in another currency)original_unitprice – (
Decimal
) Original unitprice (in another currency)original_diff – (
Decimal
) Original diff (in another currency)
- CODE_TYPE_ISIN = 'ISIN'¶
- CODE_TYPE_AMF = 'AMF'¶
- property diff_percent¶
- class Pocket(id='', url=NotLoaded, backend=None)[source]¶
Bases:
BaseObject
Pocket
- Variables:
url – (
str
) urllabel – (
str
) Label of pocketamount – (
Decimal
) Amount of the pocketquantity – (
Decimal
) Quantity of stocksavailability_date – (
date
,datetime
) Availability date of the pocketcondition – (
int
) Withdrawal condition of the pocket (default: 0)investment – (
Investment
) Reference to the investment of the pocket
- CONDITION_UNKNOWN = 0¶
- CONDITION_DATE = 1¶
- CONDITION_DATE_WHEN_ACQUIRED = 4¶
- CONDITION_DATE_WHEN_TRANSFERABLE = 5¶
- CONDITION_AVAILABLE = 2¶
- CONDITION_RETIREMENT = 3¶
- CONDITION_WEDDING = 6¶
- CONDITION_DEATH = 7¶
- CONDITION_INDEBTEDNESS = 8¶
- CONDITION_DIVORCE = 9¶
- CONDITION_DISABILITY = 10¶
- CONDITION_BUSINESS_CREATION = 11¶
- CONDITION_BREACH_EMPLOYMENT_CONTRACT = 12¶
- CONDITION_UNLOCKING_EXCEPTIONAL = 13¶
- CONDITION_THIRD_CHILD = 14¶
- CONDITION_EXPIRATION_UNEMPLOYMENT = 15¶
- CONDITION_PURCHASE_APARTMENT = 16¶
- class MarketOrderType(*args, **kwargs)[source]¶
Bases:
Enum
- UNKNOWN = 0¶
- MARKET = 1¶
Order executed at the current market price
- LIMIT = 2¶
Order executed with a maximum or minimum price limit
- TRIGGER = 3¶
Order executed when the price reaches a specific value
- class MarketOrder(id='', url=NotLoaded, backend=None)[source]¶
Bases:
BaseObject
Market order
- Variables:
url – (
str
) urllabel – (
str
) Label of the market orderunitprice – (
Decimal
) Value of the stock at the moment of the market orderunitvalue – (
Decimal
) Current value of the stock associated with the market orderordervalue – (
Decimal
) Limit value or trigger value, only relevant if the order type is LIMIT or TRIGGERcurrency – (
str
) Currency of the market order - not always the same as account currencyquantity – (
Decimal
) Quantity of stocks in the market orderamount – (
Decimal
) Total amount that has been bought or soldorder_type – (
int
) Type of market order (default: 0)direction – (
int
) Direction of the market order (buy or sale) (default: 0)payment_method – (
int
) Payment method of the market order (default: 0)date – (
date
,datetime
) Creation date of the market ordervalidity_date – (
date
,datetime
) Validity date of the market orderexecution_date – (
date
,datetime
) Execution date of the market order (only for market orders that are completed)state – (
str
) Current state of the market order (e.g. executed)code – (
str
) Identifier of the stock related to the orderstock_symbol – (
str
) Alternative identifier of the stock related to the order (different from ISIN)stock_market – (
str
) Stock market on which the order was executed
- class CapBankWealth[source]¶
Bases:
CapBank
Capability of bank websites to see investments and pockets.
- iter_investment(account)[source]¶
Iter investment of a market account
- Parameters:
account (
Account
) – account to get investments- Return type:
iter[
Investment
]- Raises:
AccountNotFound
- iter_pocket(account)[source]¶
Iter pocket
- Parameters:
account (
Account
) – account to get pockets- Return type:
iter[
Pocket
]- Raises:
AccountNotFound
- iter_market_orders(account)[source]¶
Iter market orders
- Parameters:
account (
Account
) – account to get market orders- Return type:
iter[
MarketOrder
]- Raises:
AccountNotFound