LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.AllocationRequest Class Reference

A request to create or update an Allocation. More...

Inheritance diagram for Lusid.Sdk.Model.AllocationRequest:
Inheritance graph
[legend]

Public Member Functions

 AllocationRequest (Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), decimal quantity=default(decimal), ResourceId portfolioId=default(ResourceId), ResourceId allocatedOrderId=default(ResourceId), ResourceId id=default(ResourceId), List< ResourceId > placementIds=default(List< ResourceId >), string state=default(string), string side=default(string), string type=default(string), DateTimeOffset? settlementDate=default(DateTimeOffset?), DateTimeOffset date=default(DateTimeOffset), CurrencyAndAmount price=default(CurrencyAndAmount), string settlementCurrency=default(string), decimal? settlementCurrencyFxRate=default(decimal?), string counterparty=default(string), List< ResourceId > executionIds=default(List< ResourceId >))
 Initializes a new instance of the AllocationRequest 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 (AllocationRequest input)
 Returns true if AllocationRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 AllocationRequest ()
 Initializes a new instance of the AllocationRequest class. More...
 

Properties

Dictionary< string, PerpetualPropertyProperties [get, set]
 Client-defined properties associated with this allocation. More...
 
Dictionary< string, string > InstrumentIdentifiers [get, set]
 The instrument allocated. More...
 
decimal Quantity [get, set]
 The quantity of given instrument allocated. More...
 
ResourceId PortfolioId [get, set]
 Gets or Sets PortfolioId More...
 
ResourceId AllocatedOrderId [get, set]
 Gets or Sets AllocatedOrderId More...
 
ResourceId Id [get, set]
 Gets or Sets Id More...
 
List< ResourceIdPlacementIds [get, set]
 A placement - also known as an order placed in the market - associated with this allocation. More...
 
string State [get, set]
 The state of this allocation. More...
 
string Side [get, set]
 The side of this allocation (examples: Buy, Sell, ...). More...
 
string Type [get, set]
 The type of order associated with this allocation (examples: Limit, Market, ...). More...
 
DateTimeOffset? SettlementDate [get, set]
 The settlement date for this allocation. More...
 
DateTimeOffset Date [get, set]
 The date of this allocation. More...
 
CurrencyAndAmount Price [get, set]
 Gets or Sets Price More...
 
string SettlementCurrency [get, set]
 The settlement currency of this allocation. More...
 
decimal? SettlementCurrencyFxRate [get, set]
 The settlement currency to allocation currency FX rate. More...
 
string Counterparty [get, set]
 The counterparty for this allocation. More...
 
List< ResourceIdExecutionIds [get, set]
 The executions associated with this allocation More...
 

Detailed Description

A request to create or update an Allocation.

Constructor & Destructor Documentation

◆ AllocationRequest() [1/2]

Lusid.Sdk.Model.AllocationRequest.AllocationRequest ( )
inlineprotected

Initializes a new instance of the AllocationRequest class.

◆ AllocationRequest() [2/2]

Lusid.Sdk.Model.AllocationRequest.AllocationRequest ( Dictionary< string, PerpetualProperty properties = default(Dictionary<string, PerpetualProperty>),
Dictionary< string, string >  instrumentIdentifiers = default(Dictionary<string, string>),
decimal  quantity = default(decimal),
ResourceId  portfolioId = default(ResourceId),
ResourceId  allocatedOrderId = default(ResourceId),
ResourceId  id = default(ResourceId),
List< ResourceId placementIds = default(List<ResourceId>),
string  state = default(string),
string  side = default(string),
string  type = default(string),
DateTimeOffset?  settlementDate = default(DateTimeOffset?),
DateTimeOffset  date = default(DateTimeOffset),
CurrencyAndAmount  price = default(CurrencyAndAmount),
string  settlementCurrency = default(string),
decimal?  settlementCurrencyFxRate = default(decimal?),
string  counterparty = default(string),
List< ResourceId executionIds = default(List<ResourceId>) 
)
inline

Initializes a new instance of the AllocationRequest class.

Parameters
propertiesClient-defined properties associated with this allocation..
instrumentIdentifiersThe instrument allocated. (required).
quantityThe quantity of given instrument allocated. (required).
portfolioIdportfolioId (required).
allocatedOrderIdallocatedOrderId (required).
idid (required).
placementIdsA placement - also known as an order placed in the market - associated with this allocation..
stateThe state of this allocation..
sideThe side of this allocation (examples: Buy, Sell, ...)..
typeThe type of order associated with this allocation (examples: Limit, Market, ...)..
settlementDateThe settlement date for this allocation..
dateThe date of this allocation..
priceprice.
settlementCurrencyThe settlement currency of this allocation..
settlementCurrencyFxRateThe settlement currency to allocation currency FX rate..
counterpartyThe counterparty for this allocation..
executionIdsThe executions associated with this allocation.

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.AllocationRequest.Equals ( AllocationRequest  input)
inline

Returns true if AllocationRequest instances are equal

Parameters
inputInstance of AllocationRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.AllocationRequest.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.AllocationRequest.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.AllocationRequest.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.AllocationRequest.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AllocatedOrderId

ResourceId Lusid.Sdk.Model.AllocationRequest.AllocatedOrderId
getset

Gets or Sets AllocatedOrderId

◆ Counterparty

string Lusid.Sdk.Model.AllocationRequest.Counterparty
getset

The counterparty for this allocation.

The counterparty for this allocation.

◆ Date

DateTimeOffset Lusid.Sdk.Model.AllocationRequest.Date
getset

The date of this allocation.

The date of this allocation.

◆ ExecutionIds

List<ResourceId> Lusid.Sdk.Model.AllocationRequest.ExecutionIds
getset

The executions associated with this allocation

The executions associated with this allocation

◆ Id

ResourceId Lusid.Sdk.Model.AllocationRequest.Id
getset

Gets or Sets Id

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.AllocationRequest.InstrumentIdentifiers
getset

The instrument allocated.

The instrument allocated.

◆ PlacementIds

List<ResourceId> Lusid.Sdk.Model.AllocationRequest.PlacementIds
getset

A placement - also known as an order placed in the market - associated with this allocation.

A placement - also known as an order placed in the market - associated with this allocation.

◆ PortfolioId

ResourceId Lusid.Sdk.Model.AllocationRequest.PortfolioId
getset

Gets or Sets PortfolioId

◆ Price

CurrencyAndAmount Lusid.Sdk.Model.AllocationRequest.Price
getset

Gets or Sets Price

◆ Properties

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.AllocationRequest.Properties
getset

Client-defined properties associated with this allocation.

Client-defined properties associated with this allocation.

◆ Quantity

decimal Lusid.Sdk.Model.AllocationRequest.Quantity
getset

The quantity of given instrument allocated.

The quantity of given instrument allocated.

◆ SettlementCurrency

string Lusid.Sdk.Model.AllocationRequest.SettlementCurrency
getset

The settlement currency of this allocation.

The settlement currency of this allocation.

◆ SettlementCurrencyFxRate

decimal? Lusid.Sdk.Model.AllocationRequest.SettlementCurrencyFxRate
getset

The settlement currency to allocation currency FX rate.

The settlement currency to allocation currency FX rate.

◆ SettlementDate

DateTimeOffset? Lusid.Sdk.Model.AllocationRequest.SettlementDate
getset

The settlement date for this allocation.

The settlement date for this allocation.

◆ Side

string Lusid.Sdk.Model.AllocationRequest.Side
getset

The side of this allocation (examples: Buy, Sell, ...).

The side of this allocation (examples: Buy, Sell, ...).

◆ State

string Lusid.Sdk.Model.AllocationRequest.State
getset

The state of this allocation.

The state of this allocation.

◆ Type

string Lusid.Sdk.Model.AllocationRequest.Type
getset

The type of order associated with this allocation (examples: Limit, Market, ...).

The type of order associated with this allocation (examples: Limit, Market, ...).


The documentation for this class was generated from the following file: