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

Inheritance diagram for Lusid.Sdk.Api.TaxRuleSetsApi:

[legend]

Public Member Functions
	TaxRuleSetsApi ()
	Initializes a new instance of the TaxRuleSetsApi class. More...

	TaxRuleSetsApi (string basePath)
	Initializes a new instance of the TaxRuleSetsApi class. More...

	TaxRuleSetsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the TaxRuleSetsApi class using Configuration object More...

	TaxRuleSetsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the TaxRuleSetsApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

TaxRuleSet	CreateTaxRuleSet (CreateTaxRuleSetRequest createTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. More...

Lusid.Sdk.Client.ApiResponse< TaxRuleSet >	CreateTaxRuleSetWithHttpInfo (CreateTaxRuleSetRequest createTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. More...

async System.Threading.Tasks.Task< TaxRuleSet >	CreateTaxRuleSetAsync (CreateTaxRuleSetRequest createTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TaxRuleSet > >	CreateTaxRuleSetWithHttpInfoAsync (CreateTaxRuleSetRequest createTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule. More...

DeletedEntityResponse	DeleteTaxRuleSet (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. <br> Deletes the rule set for all effective time. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteTaxRuleSetWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. <br> Deletes the rule set for all effective time. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteTaxRuleSetAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. <br> Deletes the rule set for all effective time. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteTaxRuleSetWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. <br> Deletes the rule set for all effective time. <br> The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. <br> This cannot be undone. More...

TaxRuleSet	GetTaxRuleSet (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. Retrieves the tax rule set definition at the given effective and as at times. More...

Lusid.Sdk.Client.ApiResponse< TaxRuleSet >	GetTaxRuleSetWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. Retrieves the tax rule set definition at the given effective and as at times. More...

async System.Threading.Tasks.Task< TaxRuleSet >	GetTaxRuleSetAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. Retrieves the tax rule set definition at the given effective and as at times. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TaxRuleSet > >	GetTaxRuleSetWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. Retrieves the tax rule set definition at the given effective and as at times. More...

ResourceListOfTaxRuleSet	ListTaxRuleSets (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. Retrieves all tax rule set definitions at the given effective and as at times More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfTaxRuleSet >	ListTaxRuleSetsWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. Retrieves all tax rule set definitions at the given effective and as at times More...

async System.Threading.Tasks.Task< ResourceListOfTaxRuleSet >	ListTaxRuleSetsAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. Retrieves all tax rule set definitions at the given effective and as at times More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfTaxRuleSet > >	ListTaxRuleSetsWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. Retrieves all tax rule set definitions at the given effective and as at times More...

TaxRuleSet	UpdateTaxRuleSet (string scope, string code, UpdateTaxRuleSetRequest updateTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule. More...

Lusid.Sdk.Client.ApiResponse< TaxRuleSet >	UpdateTaxRuleSetWithHttpInfo (string scope, string code, UpdateTaxRuleSetRequest updateTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule. More...

async System.Threading.Tasks.Task< TaxRuleSet >	UpdateTaxRuleSetAsync (string scope, string code, UpdateTaxRuleSetRequest updateTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< TaxRuleSet > >	UpdateTaxRuleSetWithHttpInfoAsync (string scope, string code, UpdateTaxRuleSetRequest updateTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.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

Constructor & Destructor Documentation

◆ TaxRuleSetsApi() [1/4]

Lusid.Sdk.Api.TaxRuleSetsApi.TaxRuleSetsApi ( )

inline

Initializes a new instance of the TaxRuleSetsApi class.

Returns

◆ TaxRuleSetsApi() [2/4]

Lusid.Sdk.Api.TaxRuleSetsApi.TaxRuleSetsApi ( string basePath )

inline

Initializes a new instance of the TaxRuleSetsApi class.

Returns

◆ TaxRuleSetsApi() [3/4]

Lusid.Sdk.Api.TaxRuleSetsApi.TaxRuleSetsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the TaxRuleSetsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ TaxRuleSetsApi() [4/4]

Lusid.Sdk.Api.TaxRuleSetsApi.TaxRuleSetsApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the TaxRuleSetsApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ CreateTaxRuleSet()

TaxRuleSet Lusid.Sdk.Api.TaxRuleSetsApi.CreateTaxRuleSet	(	CreateTaxRuleSetRequest	createTaxRuleSetRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createTaxRuleSetRequest	The contents of the rule set.
effectiveAt	The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ CreateTaxRuleSetAsync()

async System.Threading.Tasks.Task<TaxRuleSet> Lusid.Sdk.Api.TaxRuleSetsApi.CreateTaxRuleSetAsync	(	CreateTaxRuleSetRequest	createTaxRuleSetRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createTaxRuleSetRequest	The contents of the rule set.
effectiveAt	The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ CreateTaxRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TaxRuleSet> Lusid.Sdk.Api.TaxRuleSetsApi.CreateTaxRuleSetWithHttpInfo	(	CreateTaxRuleSetRequest	createTaxRuleSetRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createTaxRuleSetRequest	The contents of the rule set.
effectiveAt	The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ CreateTaxRuleSetWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TaxRuleSet> > Lusid.Sdk.Api.TaxRuleSetsApi.CreateTaxRuleSetWithHttpInfoAsync	(	CreateTaxRuleSetRequest	createTaxRuleSetRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. Creates a tax rule set definition at the given effective time. The user must be entitled to read any properties specified in each rule.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

createTaxRuleSetRequest	The contents of the rule set.
effectiveAt	The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (TaxRuleSet)

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ DeleteTaxRuleSet()

DeletedEntityResponse Lusid.Sdk.Api.TaxRuleSetsApi.DeleteTaxRuleSet	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. Deletes the rule set for all effective time. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ DeleteTaxRuleSetAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.TaxRuleSetsApi.DeleteTaxRuleSetAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. Deletes the rule set for all effective time. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ DeleteTaxRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.TaxRuleSetsApi.DeleteTaxRuleSetWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. Deletes the rule set for all effective time. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ DeleteTaxRuleSetWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.TaxRuleSetsApi.DeleteTaxRuleSetWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. Deletes the rule set for all effective time. The rule set will remain viewable at previous as at times, but it will no longer be considered applicable. This cannot be undone.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.TaxRuleSetsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

◆ GetTaxRuleSet()

TaxRuleSet Lusid.Sdk.Api.TaxRuleSetsApi.GetTaxRuleSet	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. Retrieves the tax rule set definition at the given effective and as at times.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ GetTaxRuleSetAsync()

async System.Threading.Tasks.Task<TaxRuleSet> Lusid.Sdk.Api.TaxRuleSetsApi.GetTaxRuleSetAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. Retrieves the tax rule set definition at the given effective and as at times.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ GetTaxRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TaxRuleSet> Lusid.Sdk.Api.TaxRuleSetsApi.GetTaxRuleSetWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. Retrieves the tax rule set definition at the given effective and as at times.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ GetTaxRuleSetWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TaxRuleSet> > Lusid.Sdk.Api.TaxRuleSetsApi.GetTaxRuleSetWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] GetTaxRuleSet: Retrieve the definition of single tax rule set. Retrieves the tax rule set definition at the given effective and as at times.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
effectiveAt	The effective datetime or cut label at which to retrieve the rule definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definition. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (TaxRuleSet)

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ ListTaxRuleSets()

ResourceListOfTaxRuleSet Lusid.Sdk.Api.TaxRuleSetsApi.ListTaxRuleSets	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. Retrieves all tax rule set definitions at the given effective and as at times

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfTaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ ListTaxRuleSetsAsync()

async System.Threading.Tasks.Task<ResourceListOfTaxRuleSet> Lusid.Sdk.Api.TaxRuleSetsApi.ListTaxRuleSetsAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. Retrieves all tax rule set definitions at the given effective and as at times

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfTaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ ListTaxRuleSetsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfTaxRuleSet> Lusid.Sdk.Api.TaxRuleSetsApi.ListTaxRuleSetsWithHttpInfo	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. Retrieves all tax rule set definitions at the given effective and as at times

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfTaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ ListTaxRuleSetsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfTaxRuleSet> > Lusid.Sdk.Api.TaxRuleSetsApi.ListTaxRuleSetsWithHttpInfoAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. Retrieves all tax rule set definitions at the given effective and as at times

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

effectiveAt	The effective datetime or cut label at which to retrieve the rule definitions. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the rule definitions. Defaults to returning the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfTaxRuleSet)

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ UpdateTaxRuleSet()

TaxRuleSet Lusid.Sdk.Api.TaxRuleSetsApi.UpdateTaxRuleSet	(	string	scope,
		string	code,
		UpdateTaxRuleSetRequest	updateTaxRuleSetRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
updateTaxRuleSetRequest	The contents of the rule set.
effectiveAt	The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ UpdateTaxRuleSetAsync()

async System.Threading.Tasks.Task<TaxRuleSet> Lusid.Sdk.Api.TaxRuleSetsApi.UpdateTaxRuleSetAsync	(	string	scope,
		string	code,
		UpdateTaxRuleSetRequest	updateTaxRuleSetRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
updateTaxRuleSetRequest	The contents of the rule set.
effectiveAt	The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

◆ UpdateTaxRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TaxRuleSet> Lusid.Sdk.Api.TaxRuleSetsApi.UpdateTaxRuleSetWithHttpInfo	(	string	scope,
		string	code,
		UpdateTaxRuleSetRequest	updateTaxRuleSetRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
updateTaxRuleSetRequest	The contents of the rule set.
effectiveAt	The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of TaxRuleSet

Implements Lusid.Sdk.Api.ITaxRuleSetsApiSync.

◆ UpdateTaxRuleSetWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<TaxRuleSet> > Lusid.Sdk.Api.TaxRuleSetsApi.UpdateTaxRuleSetWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdateTaxRuleSetRequest	updateTaxRuleSetRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EXPERIMENTAL] UpdateTaxRuleSet: Update a tax rule set. Updates the tax rule set definition at the given effective time. The changes will take place from this effective time until the next effective time that the rule has been updated at. For example, consider a rule that has been created or updated effective at the first day of the coming month. An upsert effective from the current day will only change the definition until that day. An additional upsert at the same time (first day of the month) is required if the newly-updated definition is to supersede the future definition. The user must be entitled to read any properties specified in each rule.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The rule set scope.
code	The rule set code.
updateTaxRuleSetRequest	The contents of the rule set.
effectiveAt	The effective datetime or cut label at which the rule set will take effect. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (TaxRuleSet)

Implements Lusid.Sdk.Api.ITaxRuleSetsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.TaxRuleSetsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.TaxRuleSetsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.TaxRuleSetsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.TaxRuleSetsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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/Api/TaxRuleSetsApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TaxRuleSetsApi() [1/4]

◆ TaxRuleSetsApi() [2/4]

◆ TaxRuleSetsApi() [3/4]

◆ TaxRuleSetsApi() [4/4]

Member Function Documentation

◆ CreateTaxRuleSet()

◆ CreateTaxRuleSetAsync()

◆ CreateTaxRuleSetWithHttpInfo()

◆ CreateTaxRuleSetWithHttpInfoAsync()

◆ DeleteTaxRuleSet()

◆ DeleteTaxRuleSetAsync()

◆ DeleteTaxRuleSetWithHttpInfo()

◆ DeleteTaxRuleSetWithHttpInfoAsync()

◆ GetBasePath()

◆ GetTaxRuleSet()

◆ GetTaxRuleSetAsync()

◆ GetTaxRuleSetWithHttpInfo()

◆ GetTaxRuleSetWithHttpInfoAsync()

◆ ListTaxRuleSets()

◆ ListTaxRuleSetsAsync()

◆ ListTaxRuleSetsWithHttpInfo()

◆ ListTaxRuleSetsWithHttpInfoAsync()

◆ UpdateTaxRuleSet()

◆ UpdateTaxRuleSetAsync()

◆ UpdateTaxRuleSetWithHttpInfo()

◆ UpdateTaxRuleSetWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory