Contract entity messages and methods

 

Applies To: Dynamics CRM 2015

A contract is an agreement to provide customer service support during specified coverage dates or for a specified number of cases or length of time. When customers contact customer service, the level of support they receive is determined by their contract.

The schema name for this entity is Contract. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AssignRequest	Assigns a contract to another user or team.
CancelContractRequest	Cancels a contract.
CloneContractRequest	Copies a contract.
CreateRequest	Creates a contract. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes a contract. You can also call the IOrganizationService.Delete method.
GrantAccessRequest	Shares a contract with another security principal (user or team).
ModifyAccessRequest	Changes the access rights for a contract previously shared with another security principal (user or team).
RenewContractRequest	Renews a contract.
RetrieveRequest	Retrieves a contract. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of contracts. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access the specified security principal (user or team) has to a contract.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves the security principals (users or teams) that have access to a contract, together with their access rights to the contract.
RevokeAccessRequest	Removes all access to a contract for the specified security principal (user or team).
RollupRequest	Rolls up or retrieves all the contracts related to the specified account or contact.
SetStateRequest	Sets the state of a contract. If you are using early bound types, use the ContractState enumeration to set the possible states. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.
UpdateRequest	Updates a contract. You can also call the IOrganizationService.Update method.

See Also

Contract entities
ContractDetail (contract line) entity messages and methods
Sample: Manage contracts
Contract entity privileges

© 2016 Microsoft. All rights reserved. Copyright