RenewContractRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.0.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains the data that is needed to renew a contract and create the contract details for a new contract.

For the Web API use the RenewContract Action.

public ref class RenewContractRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RenewContractRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RenewContractRequest = class
    inherit OrganizationRequest

Public NotInheritable Class RenewContractRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
RenewContractRequest

Attributes: DataContractAttribute

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the RenewContractResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Contract entity and access rights on the specified record in the ContractId property. For a complete list of the required privileges, see RenewContract message privileges.

Constructors

RenewContractRequest()

Initializes a new instance of the RenewContractRequest class.

Properties

ContractId	Gets or sets the ID of the contract to be renewed. Required.
ExtensionData	Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest)
IncludeCanceledLines	Gets or sets a value that indicates whether the canceled line items of the original contract should be included in the renewed contract. Required.
Item[String]	Gets or sets the indexer for the `Parameters` collection. (Inherited from OrganizationRequest)
Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
Status	Gets or sets the status of the contract.

Applies to