woob.capabilities.bank.wealth

class woob.capabilities.bank.wealth.CapBankWealth

Bases: woob.capabilities.bank.base.CapBank

Capability of bank websites to see investments and pockets.

iter_investment(account)

Iter investment of a market account

Parameters

account (Account) – account to get investments

Return type

iter[Investment]

Raises

AccountNotFound

iter_market_orders(account)

Iter market orders

Parameters

account (Account) – account to get market orders

Return type

iter[MarketOrder]

Raises

AccountNotFound

iter_pocket(account)

Iter pocket

Parameters

account (Account) – account to get pockets

Return type

iter[Pocket]

Raises

AccountNotFound

class woob.capabilities.bank.wealth.Investment(id='', url=NotLoaded, backend=None)

Bases: woob.capabilities.base.BaseObject

Investment in a financial market.

Variables
  • label – (str) Label of stocks

  • code – (str) Identifier of the stock

  • code_type – (str) Type of stock code (ISIN or AMF)

  • description – (str) Short description of the stock

  • quantity – (Decimal) Quantity of stocks

  • unitprice – (Decimal) Buy price of one stock

  • unitvalue – (Decimal) Current value of one stock

  • valuation – (Decimal) Total current valuation of the Investment

  • vdate – (date, datetime) Value date of the valuation amount

  • diff – (Decimal) Difference between the buy cost and the current valuation

  • diff_ratio – (Decimal) Difference in ratio (1 meaning 100%) between the buy cost and the current valuation

  • portfolio_share – (Decimal) Ratio (1 meaning 100%) of the current amount relative to the total

  • performance_history – (dict) History of the performances of the stock (key=years, value=diff_ratio)

  • srri – (int, int) Synthetic Risk and Reward Indicator of the stock (from 1 to 7)

  • asset_category – (str) Category of the stock

  • recommended_period – (str) Recommended investment period of the stock

  • original_currency – (str) Currency of the original amount

  • original_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_AMF = 'AMF'
CODE_TYPE_ISIN = 'ISIN'
property diff_percent
class woob.capabilities.bank.wealth.MarketOrder(id='', url=NotLoaded, backend=None)

Bases: woob.capabilities.base.BaseObject

Market order

Variables
  • label – (str) Label of the market order

  • unitprice – (Decimal) Value of the stock at the moment of the market order

  • unitvalue – (Decimal) Current value of the stock associated with the market order

  • ordervalue – (Decimal) Limit value or trigger value, only relevant if the order type is LIMIT or TRIGGER

  • currency – (str) Currency of the market order - not always the same as account currency

  • quantity – (Decimal) Quantity of stocks in the market order

  • amount – (Decimal) Total amount that has been bought or sold

  • order_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 order

  • validity_date – (date, datetime) Validity date of the market order

  • execution_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 order

  • stock_market – (str) Stock market on which the order was executed

class woob.capabilities.bank.wealth.MarketOrderDirection(*args, **kwargs)

Bases: woob.capabilities.base.Enum

BUY = 1
SALE = 2
UNKNOWN = 0
class woob.capabilities.bank.wealth.MarketOrderPayment(*args, **kwargs)

Bases: woob.capabilities.base.Enum

CASH = 1
DEFERRED = 2
UNKNOWN = 0
class woob.capabilities.bank.wealth.MarketOrderType(*args, **kwargs)

Bases: woob.capabilities.base.Enum

LIMIT = 2

Order executed with a maximum or minimum price limit

MARKET = 1

Order executed at the current market price

TRIGGER = 3

Order executed when the price reaches a specific value

UNKNOWN = 0
class woob.capabilities.bank.wealth.Per(id='0', url=None)

Bases: woob.capabilities.bank.base.Account

Account type dedicated to PER retirement savings plans.

Variables
  • version – (str) Version of PER

  • provider_type – (str) Type of account provider

class woob.capabilities.bank.wealth.PerProviderType(*args, **kwargs)

Bases: woob.capabilities.base.Enum

BANK = 'bank'
INSURER = 'insurer'
class woob.capabilities.bank.wealth.PerVersion(*args, **kwargs)

Bases: woob.capabilities.base.Enum

PERCAT = 'percat'
PERCOL = 'percol'
PERIN = 'perin'
class woob.capabilities.bank.wealth.Pocket(id='', url=NotLoaded, backend=None)

Bases: woob.capabilities.base.BaseObject

Pocket

Variables
  • label – (str) Label of pocket

  • amount – (Decimal) Amount of the pocket

  • quantity – (Decimal) Quantity of stocks

  • availability_date – (date, datetime) Availability date of the pocket

  • condition – (int) Withdrawal condition of the pocket (default: 0)

  • investment – (Investment) Reference to the investment of the pocket

CONDITION_AVAILABLE = 2
CONDITION_BREACH_EMPLOYMENT_CONTRACT = 10
CONDITION_BUSINESS_CREATION = 9
CONDITION_DATE = 1
CONDITION_DEATH = 5
CONDITION_DISABILITY = 8
CONDITION_DIVORCE = 7
CONDITION_EXPIRATION_UNEMPLOYMENT = 13
CONDITION_INDEBTEDNESS = 6
CONDITION_PURCHASE_APARTMENT = 14
CONDITION_RETIREMENT = 3
CONDITION_THIRD_CHILD = 12
CONDITION_UNKNOWN = 0
CONDITION_UNLOCKING_EXCEPTIONAL = 11
CONDITION_WEDDING = 4