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

A definition for the period you wish to close More...

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

Public Member Functions

 ClosePeriodDiaryEntryRequest (string diaryEntryCode=default(string), string name=default(string), DateTimeOffset? effectiveAt=default(DateTimeOffset?), DateTimeOffset? queryAsAt=default(DateTimeOffset?), string status=default(string), Dictionary< string, Property > properties=default(Dictionary< string, Property >), List< string > closingOptions=default(List< string >))
 Initializes a new instance of the ClosePeriodDiaryEntryRequest 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 (ClosePeriodDiaryEntryRequest input)
 Returns true if ClosePeriodDiaryEntryRequest instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Properties

string DiaryEntryCode [get, set]
 Unique code assigned to a period. When left blank a code will be created by the system in the format &#39;yyyyMMDD&#39;. More...
 
string Name [get, set]
 Identifiable Name assigned to the period. Where left blank, the system will generate a name in the format &#39;yyyyMMDD&#39;. More...
 
DateTimeOffset? EffectiveAt [get, set]
 The effective time of the diary entry. More...
 
DateTimeOffset? QueryAsAt [get, set]
 The query time of the diary entry. Defaults to latest. More...
 
string Status [get, set]
 The status of the diary entry. Defaults to &#39;Undefined&#39; for valuation points and &#39;Estimate&#39; for closing periods. More...
 
Dictionary< string, PropertyProperties [get, set]
 A set of properties for the diary entry. More...
 
List< string > ClosingOptions [get, set]
 The options which will be executed once a period is closed or locked. More...
 

Detailed Description

A definition for the period you wish to close

Constructor & Destructor Documentation

◆ ClosePeriodDiaryEntryRequest()

Lusid.Sdk.Model.ClosePeriodDiaryEntryRequest.ClosePeriodDiaryEntryRequest ( string  diaryEntryCode = default(string),
string  name = default(string),
DateTimeOffset?  effectiveAt = default(DateTimeOffset?),
DateTimeOffset?  queryAsAt = default(DateTimeOffset?),
string  status = default(string),
Dictionary< string, Property properties = default(Dictionary<string, Property>),
List< string >  closingOptions = default(List<string>) 
)
inline

Initializes a new instance of the ClosePeriodDiaryEntryRequest class.

Parameters
diaryEntryCodeUnique code assigned to a period. When left blank a code will be created by the system in the format &#39;yyyyMMDD&#39;..
nameIdentifiable Name assigned to the period. Where left blank, the system will generate a name in the format &#39;yyyyMMDD&#39;..
effectiveAtThe effective time of the diary entry..
queryAsAtThe query time of the diary entry. Defaults to latest..
statusThe status of the diary entry. Defaults to &#39;Undefined&#39; for valuation points and &#39;Estimate&#39; for closing periods..
propertiesA set of properties for the diary entry..
closingOptionsThe options which will be executed once a period is closed or locked..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if ClosePeriodDiaryEntryRequest instances are equal

Parameters
inputInstance of ClosePeriodDiaryEntryRequest to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ClosingOptions

List<string> Lusid.Sdk.Model.ClosePeriodDiaryEntryRequest.ClosingOptions
getset

The options which will be executed once a period is closed or locked.

The options which will be executed once a period is closed or locked.

◆ DiaryEntryCode

string Lusid.Sdk.Model.ClosePeriodDiaryEntryRequest.DiaryEntryCode
getset

Unique code assigned to a period. When left blank a code will be created by the system in the format &#39;yyyyMMDD&#39;.

Unique code assigned to a period. When left blank a code will be created by the system in the format &#39;yyyyMMDD&#39;.

◆ EffectiveAt

DateTimeOffset? Lusid.Sdk.Model.ClosePeriodDiaryEntryRequest.EffectiveAt
getset

The effective time of the diary entry.

The effective time of the diary entry.

◆ Name

string Lusid.Sdk.Model.ClosePeriodDiaryEntryRequest.Name
getset

Identifiable Name assigned to the period. Where left blank, the system will generate a name in the format &#39;yyyyMMDD&#39;.

Identifiable Name assigned to the period. Where left blank, the system will generate a name in the format &#39;yyyyMMDD&#39;.

◆ Properties

Dictionary<string, Property> Lusid.Sdk.Model.ClosePeriodDiaryEntryRequest.Properties
getset

A set of properties for the diary entry.

A set of properties for the diary entry.

◆ QueryAsAt

DateTimeOffset? Lusid.Sdk.Model.ClosePeriodDiaryEntryRequest.QueryAsAt
getset

The query time of the diary entry. Defaults to latest.

The query time of the diary entry. Defaults to latest.

◆ Status

string Lusid.Sdk.Model.ClosePeriodDiaryEntryRequest.Status
getset

The status of the diary entry. Defaults to &#39;Undefined&#39; for valuation points and &#39;Estimate&#39; for closing periods.

The status of the diary entry. Defaults to &#39;Undefined&#39; for valuation points and &#39;Estimate&#39; for closing periods.


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