An Allocation of a certain quantity of a specific instrument against an originating Order. More...

Inheritance diagram for Lusid.Sdk.Model.Allocation:

Public Member Functions
	Allocation (ResourceId id=default(ResourceId), ResourceId allocatedOrderId=default(ResourceId), ResourceId portfolioId=default(ResourceId), decimal quantity=default(decimal), Dictionary< string, string > instrumentIdentifiers=default(Dictionary< string, string >), ModelVersion version=default(ModelVersion), Dictionary< string, PerpetualProperty > properties=default(Dictionary< string, PerpetualProperty >), string instrumentScope=default(string), string lusidInstrumentId=default(string), 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 >), List< Link > links=default(List< Link >))
	Initializes a new instance of the Allocation 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 (Allocation input)
	Returns true if Allocation instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

Protected Member Functions
	Allocation ()
	Initializes a new instance of the Allocation class. More...

Properties
ResourceId	Id `[get, set]`
	Gets or Sets Id More...

ResourceId	AllocatedOrderId `[get, set]`
	Gets or Sets AllocatedOrderId More...

ResourceId	PortfolioId `[get, set]`
	Gets or Sets PortfolioId More...

decimal	Quantity `[get, set]`
	The quantity of given instrument allocated. More...

Dictionary< string, string >	InstrumentIdentifiers `[get, set]`
	The instrument allocated. More...

ModelVersion	_Version `[get, set]`
	Gets or Sets _Version More...

Dictionary< string, PerpetualProperty >	Properties `[get, set]`
	Client-defined properties associated with this allocation. More...

string	InstrumentScope `[get, set]`
	The scope in which the instrument lies More...

string	LusidInstrumentId `[get, set]`
	The LUSID instrument id for the instrument allocated. More...

List< ResourceId >	PlacementIds `[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< ResourceId >	ExecutionIds `[get, set]`
	The executions associated with this allocation More...

List< Link >	Links `[get, set]`
	Gets or Sets Links More...

Detailed Description

An Allocation of a certain quantity of a specific instrument against an originating Order.

Constructor & Destructor Documentation

◆ Allocation() [1/2]

Lusid.Sdk.Model.Allocation.Allocation ( )

inlineprotected

Initializes a new instance of the Allocation class.

◆ Allocation() [2/2]

Lusid.Sdk.Model.Allocation.Allocation	(	ResourceId	id = `default(ResourceId)`,
		ResourceId	allocatedOrderId = `default(ResourceId)`,
		ResourceId	portfolioId = `default(ResourceId)`,
		decimal	quantity = `default(decimal)`,
		Dictionary< string, string >	instrumentIdentifiers = `default(Dictionary<string, string>)`,
		ModelVersion	version = `default(ModelVersion)`,
		Dictionary< string, PerpetualProperty >	properties = `default(Dictionary<string, PerpetualProperty>)`,
		string	instrumentScope = `default(string)`,
		string	lusidInstrumentId = `default(string)`,
		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>)`,
		List< Link >	links = `default(List<Link>)`
	)

inline

Initializes a new instance of the Allocation class.

Parameters

id	id (required).
allocatedOrderId	allocatedOrderId (required).
portfolioId	portfolioId (required).
quantity	The quantity of given instrument allocated. (required).
instrumentIdentifiers	The instrument allocated. (required).
version	version.
properties	Client-defined properties associated with this allocation..
instrumentScope	The scope in which the instrument lies.
lusidInstrumentId	The LUSID instrument id for the instrument allocated. (required).
placementIds	A placement - also known as an order placed in the market - associated with this allocation..
state	The state of this allocation..
side	The side of this allocation (examples: Buy, Sell, ...)..
type	The type of order associated with this allocation (examples: Limit, Market, ...)..
settlementDate	The settlement date for this allocation..
date	The date of this allocation..
price	price.
settlementCurrency	The settlement currency of this allocation..
settlementCurrencyFxRate	The settlement currency to allocation currency FX rate..
counterparty	The counterparty for this allocation..
executionIds	The executions associated with this allocation.
links	links.

Member Function Documentation

◆ Equals() [1/2]

bool Lusid.Sdk.Model.Allocation.Equals ( Allocation input )

inline

Returns true if Allocation instances are equal

Parameters

input Instance of Allocation to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.Allocation.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.Allocation.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.Allocation.ToJson ( )

inlinevirtual

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string Lusid.Sdk.Model.Allocation.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ _Version

ModelVersion Lusid.Sdk.Model.Allocation._Version

getset

Gets or Sets _Version

◆ AllocatedOrderId

ResourceId Lusid.Sdk.Model.Allocation.AllocatedOrderId

getset

Gets or Sets AllocatedOrderId

◆ Counterparty

string Lusid.Sdk.Model.Allocation.Counterparty

getset

The counterparty for this allocation.

◆ Date

DateTimeOffset Lusid.Sdk.Model.Allocation.Date

getset

The date of this allocation.

◆ ExecutionIds

List<ResourceId> Lusid.Sdk.Model.Allocation.ExecutionIds

getset

The executions associated with this allocation

◆ Id

ResourceId Lusid.Sdk.Model.Allocation.Id

getset

Gets or Sets Id

◆ InstrumentIdentifiers

Dictionary<string, string> Lusid.Sdk.Model.Allocation.InstrumentIdentifiers

getset

The instrument allocated.

◆ InstrumentScope

string Lusid.Sdk.Model.Allocation.InstrumentScope

getset

The scope in which the instrument lies

◆ Links

List<Link> Lusid.Sdk.Model.Allocation.Links

getset

Gets or Sets Links

◆ LusidInstrumentId

string Lusid.Sdk.Model.Allocation.LusidInstrumentId

getset

The LUSID instrument id for the instrument allocated.

◆ PlacementIds

List<ResourceId> Lusid.Sdk.Model.Allocation.PlacementIds

getset

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

◆ PortfolioId

ResourceId Lusid.Sdk.Model.Allocation.PortfolioId

getset

Gets or Sets PortfolioId

◆ Price

CurrencyAndAmount Lusid.Sdk.Model.Allocation.Price

getset

Gets or Sets Price

◆ Properties

Dictionary<string, PerpetualProperty> Lusid.Sdk.Model.Allocation.Properties

getset

Client-defined properties associated with this allocation.

◆ Quantity

decimal Lusid.Sdk.Model.Allocation.Quantity

getset

The quantity of given instrument allocated.

◆ SettlementCurrency

string Lusid.Sdk.Model.Allocation.SettlementCurrency

getset

The settlement currency of this allocation.

◆ SettlementCurrencyFxRate

decimal? Lusid.Sdk.Model.Allocation.SettlementCurrencyFxRate

getset

The settlement currency to allocation currency FX rate.

◆ SettlementDate

DateTimeOffset? Lusid.Sdk.Model.Allocation.SettlementDate

getset

The settlement date for this allocation.

◆ Side

string Lusid.Sdk.Model.Allocation.Side

getset

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

◆ State

string Lusid.Sdk.Model.Allocation.State

getset

The state of this allocation.

◆ Type

string Lusid.Sdk.Model.Allocation.Type

getset

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

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/Allocation.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Allocation() [1/2]

◆ Allocation() [2/2]

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ _Version

◆ AllocatedOrderId

◆ Counterparty

◆ Date

◆ ExecutionIds

◆ Id

◆ InstrumentIdentifiers

◆ InstrumentScope

◆ Links

◆ LusidInstrumentId

◆ PlacementIds

◆ PortfolioId

◆ Price

◆ Properties

◆ Quantity

◆ SettlementCurrency

◆ SettlementCurrencyFxRate

◆ SettlementDate

◆ Side

◆ State

◆ Type