msdyn_agreementsubstatus EntityType

Specify custom agreement sub-statuses, which can be used to specify the current agreement status more precisely.

Entity Set Path
[organization URI]/api/data/v9.0/msdyn_agreementsubstatuses
Base Type
Display Name
Agreement Sub-Status
Primary Key
Primary Key Attribute
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
createdon Edm.DateTimeOffset

Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read Only
importsequencenumber Edm.Int32

Shows the sequence number of the import that created this record.

Display Name: Import Sequence Number

modifiedon Edm.DateTimeOffset

Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read Only
msdyn_agreementsubstatusid Edm.Guid

Shows the entity instances.

Display Name: Agreement Sub-Status

msdyn_defaultsubstatus Edm.Boolean

Specify whether this status should be the default Sub-status for this status type

Display Name: Default Sub-Status

Default Options
Value Label
1 Yes
0 No
msdyn_name Edm.String

Shows the agreement sub-status name.

Display Name: Name

msdyn_systemstatus Edm.Int32

Specify the system status.

Display Name: System Status

Default Options
Value Label
690970000 Estimate
690970001 Active
690970002 Expired
690970003 Canceled
overriddencreatedon Edm.DateTimeOffset

Shows the date and time that the record was migrated.

Display Name: Record Created On

statecode Edm.Int32

Status of the Agreement Sub-Status

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Agreement Sub-Status

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Shows the time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_msdyn_agreementsubstatus_createdby
createdonbehalfby systemuser lk_msdyn_agreementsubstatus_createdonbehalfby
modifiedby systemuser lk_msdyn_agreementsubstatus_modifiedby
modifiedonbehalfby systemuser lk_msdyn_agreementsubstatus_modifiedonbehalfby
ownerid principal owner_msdyn_agreementsubstatus
owningbusinessunit businessunit business_unit_msdyn_agreementsubstatus
owningteam team team_msdyn_agreementsubstatus
owninguser systemuser user_msdyn_agreementsubstatus

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
msdyn_agreementsubstatus_Annotations annotation objectid_msdyn_agreementsubstatus
msdyn_agreementsubstatus_AsyncOperations asyncoperation regardingobjectid_msdyn_agreementsubstatus
msdyn_agreementsubstatus_BulkDeleteFailures bulkdeletefailure regardingobjectid_msdyn_agreementsubstatus
msdyn_agreementsubstatus_DuplicateBaseRecord duplicaterecord baserecordid_msdyn_agreementsubstatus
msdyn_agreementsubstatus_DuplicateMatchingRecord duplicaterecord duplicaterecordid_msdyn_agreementsubstatus
msdyn_agreementsubstatus_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_msdyn_agreementsubstatus
msdyn_agreementsubstatus_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_msdyn_agreementsubstatus
msdyn_agreementsubstatus_ProcessSession processsession regardingobjectid_msdyn_agreementsubstatus
msdyn_agreementsubstatus_SyncErrors syncerror regardingobjectid_msdyn_agreementsubstatus
msdyn_msdyn_agreementsubstatus_msdyn_agreement_SubStatus msdyn_agreement msdyn_substatus


The following operations can be used with the msdyn_agreementsubstatus entity type.

Name Binding
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound


The following solutions include the msdyn_agreementsubstatus entity type.

Name Description
Field Service Microsoft Dynamics 365 for Field Service allows organizations of any size to deliver intelligent, world class field service, managing all aspects of the end-to-end field service management cycle. Features include scheduling, mobile, asset management, inventory control, customer notifications, and resource utilization controls that help maximize efficiency and minimize costs.

See also