RenewContractRequest Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
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.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RenewContractRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RenewContractRequest : OrganizationRequest
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RenewContractRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
RenewContractRequest() | Initializes a new instance of the RenewContractRequest class. |
Properties
Name | Description | |
---|---|---|
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. |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
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 theExecute 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.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
RenewContractResponse
Microsoft.Crm.Sdk.Messages Namespace
Contract entities
RenewContract message privileges
Sample: Manage contracts
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365
Return to top
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright