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

Inheritance diagram for Lusid.Sdk.Api.ITaxRuleSetsApiSync:

[legend]

Public Member Functions
TaxRuleSet	CreateTaxRuleSet (CreateTaxRuleSetRequest createTaxRuleSetRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] CreateTaxRuleSet: Create a tax rule set. 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. More...

DeletedEntityResponse	DeleteTaxRuleSet (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteTaxRuleSetWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] DeleteTaxRuleSet: Delete a tax rule set. 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. 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. More...

ResourceListOfTaxRuleSet	ListTaxRuleSets (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListTaxRuleSets: List tax rule sets. 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. 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. 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. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateTaxRuleSet()

TaxRuleSet Lusid.Sdk.Api.ITaxRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ CreateTaxRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TaxRuleSet> Lusid.Sdk.Api.ITaxRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ DeleteTaxRuleSet()

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

[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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ DeleteTaxRuleSetWithHttpInfo()

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

[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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ GetTaxRuleSet()

TaxRuleSet Lusid.Sdk.Api.ITaxRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ GetTaxRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TaxRuleSet> Lusid.Sdk.Api.ITaxRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ ListTaxRuleSets()

ResourceListOfTaxRuleSet Lusid.Sdk.Api.ITaxRuleSetsApiSync.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

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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ ListTaxRuleSetsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfTaxRuleSet> Lusid.Sdk.Api.ITaxRuleSetsApiSync.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

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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ UpdateTaxRuleSet()

TaxRuleSet Lusid.Sdk.Api.ITaxRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

◆ UpdateTaxRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<TaxRuleSet> Lusid.Sdk.Api.ITaxRuleSetsApiSync.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.

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

Implemented in Lusid.Sdk.Api.TaxRuleSetsApi.

The documentation for this interface 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

Detailed Description

Member Function Documentation

◆ CreateTaxRuleSet()

◆ CreateTaxRuleSetWithHttpInfo()

◆ DeleteTaxRuleSet()

◆ DeleteTaxRuleSetWithHttpInfo()

◆ GetTaxRuleSet()

◆ GetTaxRuleSetWithHttpInfo()

◆ ListTaxRuleSets()

◆ ListTaxRuleSetsWithHttpInfo()

◆ UpdateTaxRuleSet()

◆ UpdateTaxRuleSetWithHttpInfo()