RestrictedCashBalanceSheet
RestrictedCashBalanceSheet()
RestrictedCashBalanceSheet(
time_provider: ITimeProvider,
security_identifier: SecurityIdentifier,
)
Bases: MultiPeriodField
The carrying amounts of cash and cash equivalent items, which are restricted as to withdrawal or usage. Restrictions may include legally restricted deposits held as compensating balances against short-term borrowing arrangements, contracts entered into with others, or entity statements of intention with regard to particular deposits; however, time deposits and short-term certificates of deposit are not generally included in legally restricted deposits. Excludes compensating balance arrangements that are not agreements, which legally restrict the use of cash amounts shown on the balance sheet. For a classified balance sheet, represents the current portion only (the non-current portion has a separate concept); for an unclassified balance sheet represents the entire amount. This item is usually not available for bank and insurance industries.
Signature descriptions:
-
Creates a new empty instance
-
Creates a new instance for the given time and security
default_period: str
The default period
This codeEntityType is protected.
one_month: float
Gets/sets the OneMonth period value for the field
two_months: float
Gets/sets the TwoMonths period value for the field
three_months: float
Gets/sets the ThreeMonths period value for the field
six_months: float
Gets/sets the SixMonths period value for the field
nine_months: float
Gets/sets the NineMonths period value for the field
twelve_months: float
Gets/sets the TwelveMonths period value for the field
has_value: bool
Returns true if the field contains a value for the default period
value: float
Returns the default value for the field
NO_VALUE: QuantConnect_Data_Fundamental_MultiPeriodField_T
No Value
time_provider: ITimeProvider
The time provider instance to use
This codeEntityType is protected.
security_identifier: SecurityIdentifier
The target security identifier
This codeEntityType is protected.
get_period_value(period: str) -> float
Gets the value of the field for the requested period
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
period
|
str
|
The requested period |
required |
Returns:
| Type | Description |
|---|---|
float
|
The value for the period. |
get_period_values() -> IReadOnlyDictionary[str, float]
Gets a dictionary of period names and values for the field
Returns:
| Type | Description |
|---|---|
IReadOnlyDictionary[str, float]
|
The dictionary of period names and values. |
convert_period(period: str) -> str
Returns a string that represents the current object.
This codeEntityType is protected.
get_period_names() -> Iterable[str]
Gets the list of available period names for the field
has_period_value(period: str) -> bool
Returns true if the field contains a value for the requested period
Returns:
| Type | Description |
|---|---|
bool
|
True if the field contains a value for the requested period. |
has_values() -> bool
Returns true if the field has at least one value for one period
to_string() -> str
Returns a string that represents the current object.