LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.ITransactionPortfoliosApiSync Interface Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.ITransactionPortfoliosApiSync:
Inheritance graph
[legend]

Public Member Functions

AdjustHolding AdjustHoldings (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string > reconciliationMethods=default(List< string >))
 Adjust holdings More...
 
ApiResponse< AdjustHoldingAdjustHoldingsWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string > reconciliationMethods=default(List< string >))
 Adjust holdings More...
 
VersionedResourceListOfOutputTransaction BuildTransactions (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), List< string > propertyKeys=default(List< string >), int? limit=default(int?), string page=default(string))
 Build transactions More...
 
ApiResponse< VersionedResourceListOfOutputTransactionBuildTransactionsWithHttpInfo (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), List< string > propertyKeys=default(List< string >), int? limit=default(int?), string page=default(string))
 Build transactions More...
 
DeletedEntityResponse CancelAdjustHoldings (string scope, string code, DateTimeOrCutLabel effectiveAt)
 Cancel adjust holdings More...
 
ApiResponse< DeletedEntityResponseCancelAdjustHoldingsWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt)
 Cancel adjust holdings More...
 
DeletedEntityResponse CancelTransactions (string scope, string code, List< string > transactionIds)
 Cancel transactions More...
 
ApiResponse< DeletedEntityResponseCancelTransactionsWithHttpInfo (string scope, string code, List< string > transactionIds)
 Cancel transactions More...
 
Portfolio CreatePortfolio (string scope, CreateTransactionPortfolioRequest createTransactionPortfolioRequest)
 Create portfolio More...
 
ApiResponse< PortfolioCreatePortfolioWithHttpInfo (string scope, CreateTransactionPortfolioRequest createTransactionPortfolioRequest)
 Create portfolio More...
 
DeletedEntityResponse DeletePropertiesFromTransaction (string scope, string code, string transactionId, List< string > propertyKeys)
 Delete properties from transaction More...
 
ApiResponse< DeletedEntityResponseDeletePropertiesFromTransactionWithHttpInfo (string scope, string code, string transactionId, List< string > propertyKeys)
 Delete properties from transaction More...
 
PortfolioDetails GetDetails (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
 Get details More...
 
ApiResponse< PortfolioDetailsGetDetailsWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
 Get details More...
 
VersionedResourceListOfPortfolioHolding GetHoldings (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), List< string > propertyKeys=default(List< string >), bool? byTaxlots=default(bool?))
 Get holdings More...
 
ApiResponse< VersionedResourceListOfPortfolioHoldingGetHoldingsWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), List< string > propertyKeys=default(List< string >), bool? byTaxlots=default(bool?))
 Get holdings More...
 
HoldingsAdjustment GetHoldingsAdjustment (string scope, string code, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?))
 Get holdings adjustment More...
 
ApiResponse< HoldingsAdjustmentGetHoldingsAdjustmentWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?))
 Get holdings adjustment More...
 
ResourceListOfPortfolioCashFlow GetPortfolioCashStatement (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), string recipeIdScope=default(string), string recipeIdCode=default(string))
 [EARLY ACCESS] Get portfolio cash statement More...
 
ApiResponse< ResourceListOfPortfolioCashFlowGetPortfolioCashStatementWithHttpInfo (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), string recipeIdScope=default(string), string recipeIdCode=default(string))
 [EARLY ACCESS] Get portfolio cash statement More...
 
VersionedResourceListOfTransaction GetTransactions (string scope, string code, DateTimeOrCutLabel fromTransactionDate=default(DateTimeOrCutLabel), DateTimeOrCutLabel toTransactionDate=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), List< string > propertyKeys=default(List< string >), string page=default(string), int? limit=default(int?))
 Get transactions More...
 
ApiResponse< VersionedResourceListOfTransactionGetTransactionsWithHttpInfo (string scope, string code, DateTimeOrCutLabel fromTransactionDate=default(DateTimeOrCutLabel), DateTimeOrCutLabel toTransactionDate=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?), string filter=default(string), List< string > propertyKeys=default(List< string >), string page=default(string), int? limit=default(int?))
 Get transactions More...
 
ResourceListOfHoldingsAdjustmentHeader ListHoldingsAdjustments (string scope, string code, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), DateTimeOrCutLabel toEffectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
 List holdings adjustments More...
 
ApiResponse< ResourceListOfHoldingsAdjustmentHeaderListHoldingsAdjustmentsWithHttpInfo (string scope, string code, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), DateTimeOrCutLabel toEffectiveAt=default(DateTimeOrCutLabel), DateTimeOffset? asAt=default(DateTimeOffset?))
 List holdings adjustments More...
 
UpsertPortfolioTransactionsResponse ResolveInstrument (string scope, string code, string instrumentIdentifierType, string instrumentIdentifierValue, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), Dictionary< string, string > requestBody=default(Dictionary< string, string >))
 [EARLY ACCESS] Resolve instrument More...
 
ApiResponse< UpsertPortfolioTransactionsResponseResolveInstrumentWithHttpInfo (string scope, string code, string instrumentIdentifierType, string instrumentIdentifierValue, DateTimeOrCutLabel fromEffectiveAt=default(DateTimeOrCutLabel), Dictionary< string, string > requestBody=default(Dictionary< string, string >))
 [EARLY ACCESS] Resolve instrument More...
 
AdjustHolding SetHoldings (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string > reconciliationMethods=default(List< string >))
 Set holdings More...
 
ApiResponse< AdjustHoldingSetHoldingsWithHttpInfo (string scope, string code, DateTimeOrCutLabel effectiveAt, List< AdjustHoldingRequest > adjustHoldingRequest, List< string > reconciliationMethods=default(List< string >))
 Set holdings More...
 
PortfolioDetails UpsertPortfolioDetails (string scope, string code, CreatePortfolioDetails createPortfolioDetails, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
 Upsert portfolio details More...
 
ApiResponse< PortfolioDetailsUpsertPortfolioDetailsWithHttpInfo (string scope, string code, CreatePortfolioDetails createPortfolioDetails, DateTimeOrCutLabel effectiveAt=default(DateTimeOrCutLabel))
 Upsert portfolio details More...
 
UpsertTransactionPropertiesResponse UpsertTransactionProperties (string scope, string code, string transactionId, Dictionary< string, PerpetualProperty > requestBody)
 Upsert transaction properties More...
 
ApiResponse< UpsertTransactionPropertiesResponseUpsertTransactionPropertiesWithHttpInfo (string scope, string code, string transactionId, Dictionary< string, PerpetualProperty > requestBody)
 Upsert transaction properties More...
 
UpsertPortfolioTransactionsResponse UpsertTransactions (string scope, string code, List< TransactionRequest > transactionRequest)
 Upsert transactions More...
 
ApiResponse< UpsertPortfolioTransactionsResponseUpsertTransactionsWithHttpInfo (string scope, string code, List< TransactionRequest > transactionRequest)
 Upsert transactions More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
String GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ AdjustHoldings()

AdjustHolding Lusid.Sdk.Api.ITransactionPortfoliosApiSync.AdjustHoldings ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
List< AdjustHoldingRequest adjustHoldingRequest,
List< string >  reconciliationMethods = default(List< string >) 
)

Adjust holdings

Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/how-do-i-adjust-my-holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequestThe selected set of holdings to adjust to the provided targets for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
Returns
AdjustHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ AdjustHoldingsWithHttpInfo()

ApiResponse<AdjustHolding> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.AdjustHoldingsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
List< AdjustHoldingRequest adjustHoldingRequest,
List< string >  reconciliationMethods = default(List< string >) 
)

Adjust holdings

Adjust one or more holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the holdings which have been adjusted are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/how-do-i-adjust-my-holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequestThe selected set of holdings to adjust to the provided targets for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
Returns
ApiResponse of AdjustHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BuildTransactions()

VersionedResourceListOfOutputTransaction Lusid.Sdk.Api.ITransactionPortfoliosApiSync.BuildTransactions ( string  scope,
string  code,
TransactionQueryParameters  transactionQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  filter = default(string),
List< string >  propertyKeys = default(List< string >),
int?  limit = default(int?),
string  page = default(string) 
)

Build transactions

Builds and returns all transactions that affect the holdings of a portfolio over a given interval of effective time into a set of output transactions. This includes transactions automatically generated by LUSID such as holding adjustments.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionQueryParametersThe query queryParameters which control how the output transactions are built.
asAtThe asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; or &quot;Transaction&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Transaction/strategy/quantsignal&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
Returns
VersionedResourceListOfOutputTransaction

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ BuildTransactionsWithHttpInfo()

ApiResponse<VersionedResourceListOfOutputTransaction> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.BuildTransactionsWithHttpInfo ( string  scope,
string  code,
TransactionQueryParameters  transactionQueryParameters,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  filter = default(string),
List< string >  propertyKeys = default(List< string >),
int?  limit = default(int?),
string  page = default(string) 
)

Build transactions

Builds and returns all transactions that affect the holdings of a portfolio over a given interval of effective time into a set of output transactions. This includes transactions automatically generated by LUSID such as holding adjustments.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionQueryParametersThe query queryParameters which control how the output transactions are built.
asAtThe asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; or &quot;Transaction&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Transaction/strategy/quantsignal&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
Returns
ApiResponse of VersionedResourceListOfOutputTransaction

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CancelAdjustHoldings()

DeletedEntityResponse Lusid.Sdk.Api.ITransactionPortfoliosApiSync.CancelAdjustHoldings ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt 
)

Cancel adjust holdings

Cancel all previous holding adjustments made on the specified transaction portfolio for a specified effective datetime. This should be used to undo holding adjustments made via set holdings or adjust holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holding adjustments should be undone.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CancelAdjustHoldingsWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.CancelAdjustHoldingsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt 
)

Cancel adjust holdings

Cancel all previous holding adjustments made on the specified transaction portfolio for a specified effective datetime. This should be used to undo holding adjustments made via set holdings or adjust holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holding adjustments should be undone.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CancelTransactions()

DeletedEntityResponse Lusid.Sdk.Api.ITransactionPortfoliosApiSync.CancelTransactions ( string  scope,
string  code,
List< string >  transactionIds 
)

Cancel transactions

Cancel one or more transactions from the transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdsThe IDs of the transactions to cancel.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CancelTransactionsWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.CancelTransactionsWithHttpInfo ( string  scope,
string  code,
List< string >  transactionIds 
)

Cancel transactions

Cancel one or more transactions from the transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdsThe IDs of the transactions to cancel.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CreatePortfolio()

Portfolio Lusid.Sdk.Api.ITransactionPortfoliosApiSync.CreatePortfolio ( string  scope,
CreateTransactionPortfolioRequest  createTransactionPortfolioRequest 
)

Create portfolio

Create a transaction portfolio in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create the transaction portfolio.
createTransactionPortfolioRequestThe definition of the transaction portfolio.
Returns
Portfolio

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ CreatePortfolioWithHttpInfo()

ApiResponse<Portfolio> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.CreatePortfolioWithHttpInfo ( string  scope,
CreateTransactionPortfolioRequest  createTransactionPortfolioRequest 
)

Create portfolio

Create a transaction portfolio in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create the transaction portfolio.
createTransactionPortfolioRequestThe definition of the transaction portfolio.
Returns
ApiResponse of Portfolio

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ DeletePropertiesFromTransaction()

DeletedEntityResponse Lusid.Sdk.Api.ITransactionPortfoliosApiSync.DeletePropertiesFromTransaction ( string  scope,
string  code,
string  transactionId,
List< string >  propertyKeys 
)

Delete properties from transaction

Delete one or more properties from a single transaction in a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction from which to delete properties.
propertyKeysThe property keys of the properties to delete. These must be from the &quot;Transaction&quot; domain and have the format {domain}/{scope}/{code}, for example &quot;Transaction/strategy/quantsignal&quot;.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ DeletePropertiesFromTransactionWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.DeletePropertiesFromTransactionWithHttpInfo ( string  scope,
string  code,
string  transactionId,
List< string >  propertyKeys 
)

Delete properties from transaction

Delete one or more properties from a single transaction in a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction from which to delete properties.
propertyKeysThe property keys of the properties to delete. These must be from the &quot;Transaction&quot; domain and have the format {domain}/{scope}/{code}, for example &quot;Transaction/strategy/quantsignal&quot;.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetDetails()

PortfolioDetails Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetDetails ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt = default(DateTimeOrCutLabel),
DateTimeOffset?  asAt = default(DateTimeOffset?) 
)

Get details

Get certain details associated with a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the details of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the details of the transaction portfolio. Defaults to returning the latest version of the details if not specified. (optional)
Returns
PortfolioDetails

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetDetailsWithHttpInfo()

ApiResponse<PortfolioDetails> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetDetailsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt = default(DateTimeOrCutLabel),
DateTimeOffset?  asAt = default(DateTimeOffset?) 
)

Get details

Get certain details associated with a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the details of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the details of the transaction portfolio. Defaults to returning the latest version of the details if not specified. (optional)
Returns
ApiResponse of PortfolioDetails

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldings()

VersionedResourceListOfPortfolioHolding Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetHoldings ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt = default(DateTimeOrCutLabel),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  filter = default(string),
List< string >  propertyKeys = default(List< string >),
bool?  byTaxlots = default(bool?) 
)

Get holdings

Calculate holdings for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Holding Type, use &quot;holdingType eq &#39;p&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; or &quot;Holding&quot; domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example &quot;Instrument/system/Name&quot; or &quot;Holding/system/Cost&quot;. (optional)
byTaxlotsWhether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
Returns
VersionedResourceListOfPortfolioHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsAdjustment()

HoldingsAdjustment Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetHoldingsAdjustment ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?) 
)

Get holdings adjustment

Get a holdings adjustment made to a transaction portfolio at a specific effective datetime. Note that a holdings adjustment will only be returned if one exists for the specified effective datetime.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label of the holdings adjustment.
asAtThe asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified. (optional)
Returns
HoldingsAdjustment

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsAdjustmentWithHttpInfo()

ApiResponse<HoldingsAdjustment> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetHoldingsAdjustmentWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?) 
)

Get holdings adjustment

Get a holdings adjustment made to a transaction portfolio at a specific effective datetime. Note that a holdings adjustment will only be returned if one exists for the specified effective datetime.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label of the holdings adjustment.
asAtThe asAt datetime at which to retrieve the holdings adjustment. Defaults to the return the latest version of the holdings adjustment if not specified. (optional)
Returns
ApiResponse of HoldingsAdjustment

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetHoldingsWithHttpInfo()

ApiResponse<VersionedResourceListOfPortfolioHolding> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetHoldingsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt = default(DateTimeOrCutLabel),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  filter = default(string),
List< string >  propertyKeys = default(List< string >),
bool?  byTaxlots = default(bool?) 
)

Get holdings

Calculate holdings for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the holdings of the transaction portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings of the transaction portfolio. Defaults to return the latest version if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Holding Type, use &quot;holdingType eq &#39;p&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; or &quot;Holding&quot; domain to decorate onto holdings. These must have the format {domain}/{scope}/{code}, for example &quot;Instrument/system/Name&quot; or &quot;Holding/system/Cost&quot;. (optional)
byTaxlotsWhether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
Returns
ApiResponse of VersionedResourceListOfPortfolioHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetPortfolioCashStatement()

ResourceListOfPortfolioCashFlow Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetPortfolioCashStatement ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  filter = default(string),
string  recipeIdScope = default(string),
string  recipeIdCode = default(string) 
)

[EARLY ACCESS] Get portfolio cash statement

Get a cash statement for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
Returns
ResourceListOfPortfolioCashFlow

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetPortfolioCashStatementWithHttpInfo()

ApiResponse<ResourceListOfPortfolioCashFlow> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetPortfolioCashStatementWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  filter = default(string),
string  recipeIdScope = default(string),
string  recipeIdCode = default(string) 
)

[EARLY ACCESS] Get portfolio cash statement

Get a cash statement for a transaction portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeID (optional)
Returns
ApiResponse of ResourceListOfPortfolioCashFlow

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetTransactions()

VersionedResourceListOfTransaction Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetTransactions ( string  scope,
string  code,
DateTimeOrCutLabel  fromTransactionDate = default(DateTimeOrCutLabel),
DateTimeOrCutLabel  toTransactionDate = default(DateTimeOrCutLabel),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  filter = default(string),
List< string >  propertyKeys = default(List< string >),
string  page = default(string),
int?  limit = default(int?) 
)

Get transactions

Retrieve all the transactions that occurred during a particular time interval. If the portfolio is a derived transaction portfolio, the transactions returned are the union set of all transactions of the parent (and any grandparents, etc.) as well as those of the derived transaction portfolio itself.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromTransactionDateThe lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified. (optional)
toTransactionDateThe upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression with which to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot; For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &#39;Instrument&#39; or &#39;Transaction&#39; domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example &#39;Instrument/system/Name&#39; or &#39;Transaction/strategy/quantsignal&#39;. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
Returns
VersionedResourceListOfTransaction

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ GetTransactionsWithHttpInfo()

ApiResponse<VersionedResourceListOfTransaction> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.GetTransactionsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  fromTransactionDate = default(DateTimeOrCutLabel),
DateTimeOrCutLabel  toTransactionDate = default(DateTimeOrCutLabel),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string  filter = default(string),
List< string >  propertyKeys = default(List< string >),
string  page = default(string),
int?  limit = default(int?) 
)

Get transactions

Retrieve all the transactions that occurred during a particular time interval. If the portfolio is a derived transaction portfolio, the transactions returned are the union set of all transactions of the parent (and any grandparents, etc.) as well as those of the derived transaction portfolio itself.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromTransactionDateThe lower bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no lower bound if this is not specified. (optional)
toTransactionDateThe upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve transactions. Defaults to returning the latest version of each transaction if not specified. (optional)
filterExpression with which to filter the result set. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot; For more information about filtering LUSID results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
propertyKeysA list of property keys from the &#39;Instrument&#39; or &#39;Transaction&#39; domain to decorate onto transactions. These must have the format {domain}/{scope}/{code}, for example &#39;Instrument/system/Name&#39; or &#39;Transaction/strategy/quantsignal&#39;. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
Returns
ApiResponse of VersionedResourceListOfTransaction

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ListHoldingsAdjustments()

ResourceListOfHoldingsAdjustmentHeader Lusid.Sdk.Api.ITransactionPortfoliosApiSync.ListHoldingsAdjustments ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt = default(DateTimeOrCutLabel),
DateTimeOrCutLabel  toEffectiveAt = default(DateTimeOrCutLabel),
DateTimeOffset?  asAt = default(DateTimeOffset?) 
)

List holdings adjustments

List the holdings adjustments made to the specified transaction portfolio over a specified interval of effective time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified. (optional)
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified. (optional)
Returns
ResourceListOfHoldingsAdjustmentHeader

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ListHoldingsAdjustmentsWithHttpInfo()

ApiResponse<ResourceListOfHoldingsAdjustmentHeader> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.ListHoldingsAdjustmentsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  fromEffectiveAt = default(DateTimeOrCutLabel),
DateTimeOrCutLabel  toEffectiveAt = default(DateTimeOrCutLabel),
DateTimeOffset?  asAt = default(DateTimeOffset?) 
)

List holdings adjustments

List the holdings adjustments made to the specified transaction portfolio over a specified interval of effective time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no lower bound if this is not specified. (optional)
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the holdings adjustments. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve the holdings adjustments. Defaults to return the latest version of each holding adjustment if not specified. (optional)
Returns
ApiResponse of ResourceListOfHoldingsAdjustmentHeader

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ResolveInstrument()

UpsertPortfolioTransactionsResponse Lusid.Sdk.Api.ITransactionPortfoliosApiSync.ResolveInstrument ( string  scope,
string  code,
string  instrumentIdentifierType,
string  instrumentIdentifierValue,
DateTimeOrCutLabel  fromEffectiveAt = default(DateTimeOrCutLabel),
Dictionary< string, string >  requestBody = default(Dictionary< string, string >) 
)

[EARLY ACCESS] Resolve instrument

Try to resolve the instrument for transaction and holdings for a given instrument identifier and a specified period of time. Also update the instrument identifiers with the given instrument identifiers collection.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
instrumentIdentifierTypeThe instrument identifier type.
instrumentIdentifierValueThe value for the given instrument identifier.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (optional)
requestBodyThe dictionary with the instrument identifiers to be updated on the transaction and holdings. (optional)
Returns
UpsertPortfolioTransactionsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ ResolveInstrumentWithHttpInfo()

ApiResponse<UpsertPortfolioTransactionsResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.ResolveInstrumentWithHttpInfo ( string  scope,
string  code,
string  instrumentIdentifierType,
string  instrumentIdentifierValue,
DateTimeOrCutLabel  fromEffectiveAt = default(DateTimeOrCutLabel),
Dictionary< string, string >  requestBody = default(Dictionary< string, string >) 
)

[EARLY ACCESS] Resolve instrument

Try to resolve the instrument for transaction and holdings for a given instrument identifier and a specified period of time. Also update the instrument identifiers with the given instrument identifiers collection.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
instrumentIdentifierTypeThe instrument identifier type.
instrumentIdentifierValueThe value for the given instrument identifier.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. (optional)
requestBodyThe dictionary with the instrument identifiers to be updated on the transaction and holdings. (optional)
Returns
ApiResponse of UpsertPortfolioTransactionsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ SetHoldings()

AdjustHolding Lusid.Sdk.Api.ITransactionPortfoliosApiSync.SetHoldings ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
List< AdjustHoldingRequest adjustHoldingRequest,
List< string >  reconciliationMethods = default(List< string >) 
)

Set holdings

Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the entire set of holdings for the transaction portfolio are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/how-do-i-adjust-my-holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequestThe complete set of target holdings for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
Returns
AdjustHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ SetHoldingsWithHttpInfo()

ApiResponse<AdjustHolding> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.SetHoldingsWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel  effectiveAt,
List< AdjustHoldingRequest adjustHoldingRequest,
List< string >  reconciliationMethods = default(List< string >) 
)

Set holdings

Set the holdings of the specified transaction portfolio to the provided targets. LUSID will automatically construct adjustment transactions to ensure that the entire set of holdings for the transaction portfolio are always set to the provided targets for the specified effective datetime. Read more about the difference between adjusting and setting holdings here https://support.lusid.com/how-do-i-adjust-my-holdings.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
effectiveAtThe effective datetime or cut label at which the holdings should be set to the provided targets.
adjustHoldingRequestThe complete set of target holdings for the transaction portfolio.
reconciliationMethodsOptional parameter for specifying a reconciliation method: e.g. FxForward. (optional)
Returns
ApiResponse of AdjustHolding

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertPortfolioDetails()

PortfolioDetails Lusid.Sdk.Api.ITransactionPortfoliosApiSync.UpsertPortfolioDetails ( string  scope,
string  code,
CreatePortfolioDetails  createPortfolioDetails,
DateTimeOrCutLabel  effectiveAt = default(DateTimeOrCutLabel) 
)

Upsert portfolio details

Create or update certain details for a particular transaction portfolio. The details are updated if they already exist, and inserted if they do not. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
createPortfolioDetailsThe details to create or update for the specified transaction portfolio.
effectiveAtThe effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. (optional)
Returns
PortfolioDetails

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertPortfolioDetailsWithHttpInfo()

ApiResponse<PortfolioDetails> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.UpsertPortfolioDetailsWithHttpInfo ( string  scope,
string  code,
CreatePortfolioDetails  createPortfolioDetails,
DateTimeOrCutLabel  effectiveAt = default(DateTimeOrCutLabel) 
)

Upsert portfolio details

Create or update certain details for a particular transaction portfolio. The details are updated if they already exist, and inserted if they do not. Note that not all elements of a transaction portfolio definition are modifiable once it has been created due to the potential implications for data already stored.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
createPortfolioDetailsThe details to create or update for the specified transaction portfolio.
effectiveAtThe effective datetime or cut label at which the updated or inserted details should become valid. Defaults to the current LUSID system datetime if not specified. (optional)
Returns
ApiResponse of PortfolioDetails

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertTransactionProperties()

UpsertTransactionPropertiesResponse Lusid.Sdk.Api.ITransactionPortfoliosApiSync.UpsertTransactionProperties ( string  scope,
string  code,
string  transactionId,
Dictionary< string, PerpetualProperty requestBody 
)

Upsert transaction properties

Create or update one or more transaction properties for a single transaction in the transaction portfolio. Each property will be updated if it already exists and created if it does not. Both transaction and portfolio must exist at the time when properties are created or updated.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction to create or update properties for.
requestBodyThe properties and their associated values to create or update.
Returns
UpsertTransactionPropertiesResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertTransactionPropertiesWithHttpInfo()

ApiResponse<UpsertTransactionPropertiesResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.UpsertTransactionPropertiesWithHttpInfo ( string  scope,
string  code,
string  transactionId,
Dictionary< string, PerpetualProperty requestBody 
)

Upsert transaction properties

Create or update one or more transaction properties for a single transaction in the transaction portfolio. Each property will be updated if it already exists and created if it does not. Both transaction and portfolio must exist at the time when properties are created or updated.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionIdThe unique ID of the transaction to create or update properties for.
requestBodyThe properties and their associated values to create or update.
Returns
ApiResponse of UpsertTransactionPropertiesResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertTransactions()

UpsertPortfolioTransactionsResponse Lusid.Sdk.Api.ITransactionPortfoliosApiSync.UpsertTransactions ( string  scope,
string  code,
List< TransactionRequest transactionRequest 
)

Upsert transactions

Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. The maximum number of transactions that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionRequestA list of transactions to be created or updated.
Returns
UpsertPortfolioTransactionsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.

◆ UpsertTransactionsWithHttpInfo()

ApiResponse<UpsertPortfolioTransactionsResponse> Lusid.Sdk.Api.ITransactionPortfoliosApiSync.UpsertTransactionsWithHttpInfo ( string  scope,
string  code,
List< TransactionRequest transactionRequest 
)

Upsert transactions

Create or update transactions in the transaction portfolio. A transaction will be updated if it already exists and created if it does not. The maximum number of transactions that this method can upsert per request is 10,000.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the transaction portfolio.
codeThe code of the transaction portfolio. Together with the scope this uniquely identifies the transaction portfolio.
transactionRequestA list of transactions to be created or updated.
Returns
ApiResponse of UpsertPortfolioTransactionsResponse

Implemented in Lusid.Sdk.Api.TransactionPortfoliosApi.


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