msdyn_agreement EntityType

Provides ability to store details about service agreements you have with your customers

Entity Set Path
[organization URI]/api/data/v9.0/msdyn_agreements
Base Type
Display Name
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_agreementdetails Edm.String

Shows the details of this agreement, as presented to the customer

Display Name: Agreement Details

msdyn_agreementid Edm.Guid

Shows the entity instances.

Display Name: Agreement

msdyn_agreementrecordgeneration Edm.DateTimeOffset

This field defines the time of day when Work Orders and Invoices are generated by the Agreement Booking Setups and Agreement Invoice Setups defined on this Agreement. If this field is blank, the logic will look to the overall setting on the Field Service Settings record.

Display Name: Agreement Record Generation

msdyn_autonumbering Edm.String

Internal field used to generate the next name upon entity creation. It is optionally copied to the msdyn_name field.

Display Name: Auto-Numbering

msdyn_childindex Edm.Int32

Display Name: Child Index

msdyn_datecanceled Edm.DateTimeOffset

Enter the date this agreement was canceled.

Display Name: Date Canceled

msdyn_description Edm.String

Type a description of the agreement.

Display Name: Description

msdyn_duration Edm.Int32

Shows the duration how long this agreement is active.

Display Name: Duration

msdyn_enddate Edm.DateTimeOffset

Enter the date when this agreement is no longer active.

Display Name: End Date

msdyn_name Edm.String

Display Name: Agreement Number

msdyn_startdate Edm.DateTimeOffset

Enter the date from when this agreement is active.

Display Name: Start Date

msdyn_systemstatus Edm.Int32

Tracks the current system status.

Display Name: System Status

Default Options
Value Label
690970000 Estimate
690970001 Active
690970002 Expired
690970003 Canceled
msdyn_taxable Edm.Boolean

Specify if Agreement is taxable. By default an Agreement is taxable if billing account is not tax exempt, and Agreement type is taxable. If any of the above is false it will be set to non-taxable.

Display Name: Taxable

Default Options
Value Label
1 Yes
0 No
overriddencreatedon Edm.DateTimeOffset

Shows the date and time that the record was migrated.

Display Name: Record Created On

processid Edm.Guid

Contains the ID of the process associated with the entity.

Display Name: Process Id

statecode Edm.Int32

Status of the Agreement

Display Name: Status

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

Reason for the status of the Agreement

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

traversedpath Edm.String

Shows a comma-separated list of string values that represent the unique identifiers of stages in a business process flow instance in the order that they occur.

Display Name: Traversed Path

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.

_msdyn_billingaccount_value msdyn_billingaccount

Account to be billed. If a billing account has been set on service account it will be populated by default. Otherwise, the billing account will be the same as the service account.

_msdyn_originatingagreement_value msdyn_originatingagreement_msdyn_agreement

If this agreement originates from another agreement, you should specify the originating agreement here

_msdyn_pricelist_value msdyn_pricelist

Price List that controls pricing for products added to this Agreement. By default the system will use the Price List specified on the account

_msdyn_salestaxcode_value msdyn_salestaxcode

Tax Code to be used to calculate tax when Agreement is taxable. By default the system will use the tax code specified on the service account

_msdyn_serviceaccount_value msdyn_serviceaccount

Account to be serviced

_msdyn_serviceterritory_value msdyn_serviceterritory

The service territory this Agreement relates to. By default this will be set to the Service Territory defined on the service account

_msdyn_substatus_value msdyn_substatus

Agreement Substatus

_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.

_stageid_value stageid

Contains the ID of the stage where the entity is located.

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_agreement_createdby
createdonbehalfby systemuser lk_msdyn_agreement_createdonbehalfby
modifiedby systemuser lk_msdyn_agreement_modifiedby
modifiedonbehalfby systemuser lk_msdyn_agreement_modifiedonbehalfby
msdyn_billingaccount account msdyn_account_msdyn_agreement_BillingAccount
msdyn_originatingagreement_msdyn_agreement msdyn_agreement msdyn_msdyn_agreement_msdyn_agreement_OriginatingAgreement
msdyn_pricelist pricelevel msdyn_pricelevel_msdyn_agreement_PriceList
msdyn_salestaxcode msdyn_taxcode msdyn_msdyn_taxcode_msdyn_agreement_SalesTaxCode
msdyn_serviceaccount account msdyn_account_msdyn_agreement_ServiceAccount
msdyn_serviceterritory territory msdyn_territory_msdyn_agreement_ServiceTerritory
msdyn_substatus msdyn_agreementsubstatus msdyn_msdyn_agreementsubstatus_msdyn_agreement_SubStatus
ownerid principal owner_msdyn_agreement
owningbusinessunit businessunit business_unit_msdyn_agreement
owningteam team team_msdyn_agreement
owninguser systemuser user_msdyn_agreement
stageid processstage processstage_msdyn_agreement

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
bpf_msdyn_agreement_msdyn_bpf_baa0a411a239410cb8bded8b5fdd88e3 msdyn_bpf_baa0a411a239410cb8bded8b5fdd88e3 bpf_msdyn_agreementid
msdyn_agreement_ActivityPointers activitypointer regardingobjectid_msdyn_agreement
msdyn_agreement_Annotations annotation objectid_msdyn_agreement
msdyn_agreement_Appointments appointment regardingobjectid_msdyn_agreement_appointment
msdyn_agreement_AsyncOperations asyncoperation regardingobjectid_msdyn_agreement
msdyn_agreement_BulkDeleteFailures bulkdeletefailure regardingobjectid_msdyn_agreement
msdyn_agreement_connections1 connection record1id_msdyn_agreement
msdyn_agreement_connections2 connection record2id_msdyn_agreement
msdyn_agreement_DuplicateBaseRecord duplicaterecord baserecordid_msdyn_agreement
msdyn_agreement_DuplicateMatchingRecord duplicaterecord duplicaterecordid_msdyn_agreement
msdyn_agreement_Emails email regardingobjectid_msdyn_agreement_email
msdyn_agreement_Faxes fax regardingobjectid_msdyn_agreement_fax
msdyn_agreement_Letters letter regardingobjectid_msdyn_agreement_letter
msdyn_agreement_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_msdyn_agreement
msdyn_agreement_msdyn_approvals msdyn_approval regardingobjectid_msdyn_agreement_msdyn_approval
msdyn_agreement_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_msdyn_agreement_msdyn_bookingalert
msdyn_agreement_PhoneCalls phonecall regardingobjectid_msdyn_agreement_phonecall
msdyn_agreement_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_msdyn_agreement
msdyn_agreement_ProcessSession processsession regardingobjectid_msdyn_agreement
msdyn_agreement_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_msdyn_agreement_recurringappointmentmaster
msdyn_agreement_ServiceAppointments serviceappointment regardingobjectid_msdyn_agreement_serviceappointment
msdyn_agreement_SharePointDocumentLocations sharepointdocumentlocation regardingobjectid_msdyn_agreement
msdyn_agreement_SocialActivities socialactivity regardingobjectid_msdyn_agreement_socialactivity
msdyn_agreement_SyncErrors syncerror regardingobjectid_msdyn_agreement
msdyn_agreement_Tasks task regardingobjectid_msdyn_agreement_task
msdyn_msdyn_agreement_invoicedetail_Agreement invoicedetail msdyn_agreement
msdyn_msdyn_agreement_msdyn_actual_Agreement msdyn_actual msdyn_Agreement
msdyn_msdyn_agreement_msdyn_agreement_OriginatingAgreement msdyn_agreement msdyn_originatingagreement_msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementbookingdate_Agreement msdyn_agreementbookingdate msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementbookingincident_Agreement msdyn_agreementbookingincident msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementbookingproduct_Agreement msdyn_agreementbookingproduct msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementbookingservice_Agreement msdyn_agreementbookingservice msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementbookingservicetask_Agreement msdyn_agreementbookingservicetask msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementbookingsetup_Agreement msdyn_agreementbookingsetup msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementinvoicedate_Agreement msdyn_agreementinvoicedate msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementinvoiceproduct_Agreement msdyn_agreementinvoiceproduct msdyn_agreement
msdyn_msdyn_agreement_msdyn_agreementinvoicesetup_Agreement msdyn_agreementinvoicesetup msdyn_agreement
msdyn_msdyn_agreement_msdyn_workorder_Agreement msdyn_workorder msdyn_agreement
msdyn_msdyn_agreement_quotedetail_Agreement quotedetail msdyn_Agreement
msdyn_msdyn_agreement_salesorderdetail_Agreement salesorderdetail msdyn_agreement


The following operations can be used with the msdyn_agreement 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_agreement 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