|
| BucketedCashFlowRequest (string roundingMethod=default(string), List< DateTimeOffset > bucketingDates=default(List< DateTimeOffset >), List< string > bucketTenors=default(List< string >), string effectiveAt=default(string), string windowStart=default(string), string windowEnd=default(string), ResourceId recipeId=default(ResourceId), string reportCurrency=default(string), List< string > groupBy=default(List< string >), List< string > addresses=default(List< string >), bool equipWithSubtotals=default(bool), DateTimeOffset? asAt=default(DateTimeOffset?), bool excludeUnsettledTrades=default(bool), string cashFlowType=default(string), BucketingSchedule bucketingSchedule=default(BucketingSchedule), string filter=default(string)) |
| Initializes a new instance of the BucketedCashFlowRequest class. More...
|
|
override string | ToString () |
| Returns the string presentation of the object More...
|
|
virtual string | ToJson () |
| Returns the JSON string presentation of the object More...
|
|
override bool | Equals (object input) |
| Returns true if objects are equal More...
|
|
bool | Equals (BucketedCashFlowRequest input) |
| Returns true if BucketedCashFlowRequest instances are equal More...
|
|
override int | GetHashCode () |
| Gets the hash code More...
|
|
|
string | RoundingMethod [get, set] |
| When bucketing, there is not a unique way to allocate the bucket points. RoundingMethod Supported string (enumeration) values are: [RoundDown, RoundUp]. More...
|
|
List< DateTimeOffset > | BucketingDates [get, set] |
| A list of dates to perform cashflow bucketing upon. If this is provided, the list of tenors for bucketing should be empty. More...
|
|
List< string > | BucketTenors [get, set] |
| A list of tenors to perform cashflow bucketing upon. If this is provided, the list of dates for bucketing should be empty. More...
|
|
string | EffectiveAt [get, set] |
| The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today. More...
|
|
string | WindowStart [get, set] |
| The lower bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. There is no lower bound if this is not specified. More...
|
|
string | WindowEnd [get, set] |
| The upper bound effective datetime or cut label (inclusive) from which to retrieve the cashflows. The upper bound defaults to 'today' if it is not specified More...
|
|
ResourceId | RecipeId [get, set] |
| Gets or Sets RecipeId More...
|
|
string | ReportCurrency [get, set] |
| Three letter ISO currency string indicating what currency to report in for ReportCurrency denominated queries. More...
|
|
List< string > | GroupBy [get, set] |
| The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out. More...
|
|
List< string > | Addresses [get, set] |
| The set of items that the user wishes to see in the results. If empty, will be defaulted to standard ones. More...
|
|
bool | EquipWithSubtotals [get, set] |
| Flag directing the Valuation call to populate the results with subtotals of aggregates. More...
|
|
DateTimeOffset? | AsAt [get, set] |
| The time of the system at which to query for bucketed cashflows. More...
|
|
bool | ExcludeUnsettledTrades [get, set] |
| Flag directing the Valuation call to exclude cashflows from unsettled trades. If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set. More...
|
|
string | CashFlowType [get, set] |
| Indicate the requested cash flow representation InstrumentCashFlows or PortfolioCashFlows (GetCashLadder uses this) Options: [InstrumentCashFlow, PortfolioCashFlow] More...
|
|
BucketingSchedule | BucketingSchedule [get, set] |
| Gets or Sets BucketingSchedule More...
|
|
string | Filter [get, set] |
| Gets or Sets Filter More...
|
|
Specification class consisting of parameters for BucketedCashFlow endpoint.
string Lusid.Sdk.Model.BucketedCashFlowRequest.EffectiveAt |
|
getset |
The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.
The valuation (pricing) effective datetime or cut label (inclusive) at which to evaluate the cashflows. This determines whether cashflows are evaluated in a historic or forward looking context and will, for certain models, affect where data is looked up. For example, on a swap if the effectiveAt is in the middle of the window, cashflows before it will be historic and resets assumed to exist where if the effectiveAt is before the start of the range they are forward looking and will be expectations assuming the model supports that. There is evidently a presumption here about availability of data and that the effectiveAt is realistically on or before the real-world today.
bool Lusid.Sdk.Model.BucketedCashFlowRequest.ExcludeUnsettledTrades |
|
getset |
Flag directing the Valuation call to exclude cashflows from unsettled trades. If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.
Flag directing the Valuation call to exclude cashflows from unsettled trades. If absent or set to false, cashflows will returned based on trade date - more specifically, cashflows from any unsettled trades will be included in the results. If set to true, unsettled trades will be excluded from the result set.
List<string> Lusid.Sdk.Model.BucketedCashFlowRequest.GroupBy |
|
getset |
The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.
The set of items by which to perform grouping. This primarily matters when one or more of the metric operators is a mapping that reduces set size, e.g. sum or proportion. The group-by statement determines the set of keys by which to break the results out.
string Lusid.Sdk.Model.BucketedCashFlowRequest.RoundingMethod |
|
getset |
When bucketing, there is not a unique way to allocate the bucket points. RoundingMethod Supported string (enumeration) values are: [RoundDown, RoundUp].
When bucketing, there is not a unique way to allocate the bucket points. RoundingMethod Supported string (enumeration) values are: [RoundDown, RoundUp].