Agreement Booking Service (msdyn_agreementbookingservice) table/entity reference (Microsoft Dynamics 365 Field Service)

Article
2025-02-08

Specify the booking service for the agreement.

Messages

The following table lists the messages for the Agreement Booking Service (msdyn_agreementbookingservice) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Assign` Event: True	`PATCH` /msdyn_agreementbookingservices(msdyn_agreementbookingserviceid) Update the `ownerid` property.	AssignRequest
`Associate` Event: True	Associate records	Associate records
`BulkRetain` Event: True	BulkRetain	Learn to use messages with the SDK for .NET
`Create` Event: True	`POST` /msdyn_agreementbookingservices See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /msdyn_agreementbookingservices(msdyn_agreementbookingserviceid) See Delete	Delete records
`Disassociate` Event: True	Disassociate records	Disassociate records
`GrantAccess` Event: True	GrantAccess	GrantAccessRequest
`IsValidStateTransition` Event: False	IsValidStateTransition	IsValidStateTransitionRequest
`ModifyAccess` Event: True	ModifyAccess	ModifyAccessRequest
`PurgeRetainedContent` Event: True	PurgeRetainedContent	Learn to use messages with the SDK for .NET
`Restore` Event: True	Restore	Learn to use messages with the SDK for .NET
`Retain` Event: True	Retain	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /msdyn_agreementbookingservices(msdyn_agreementbookingserviceid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /msdyn_agreementbookingservices See Query data	Query data
`RetrievePrincipalAccess` Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
`RetrieveSharedPrincipalsAndAccess` Event: True	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
`RevokeAccess` Event: True	RevokeAccess	RevokeAccessRequest
`RollbackRetain` Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
`SetState` Event: True	`PATCH` /msdyn_agreementbookingservices(msdyn_agreementbookingserviceid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /msdyn_agreementbookingservices(msdyn_agreementbookingserviceid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /msdyn_agreementbookingservices(msdyn_agreementbookingserviceid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: False	UpsertMultiple	UpsertMultipleRequest
`ValidateRetentionConfig` Event: True	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Agreement Booking Service (msdyn_agreementbookingservice) table.

Property	Value
DisplayName	Agreement Booking Service
DisplayCollectionName	Agreement Booking Services
SchemaName	`msdyn_agreementbookingservice`
CollectionSchemaName	`msdyn_agreementbookingservices`
EntitySetName	`msdyn_agreementbookingservices`
LogicalName	`msdyn_agreementbookingservice`
LogicalCollectionName	`msdyn_agreementbookingservices`
PrimaryIdAttribute	`msdyn_agreementbookingserviceid`
PrimaryNameAttribute	`msdyn_name`
TableType	`Standard`
OwnershipType	`UserOwned`

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ImportSequenceNumber
msdyn_Agreement
msdyn_AgreementBookingIncident
msdyn_agreementbookingserviceId
msdyn_AgreementBookingSetup
msdyn_Currency
msdyn_CustomerAsset
msdyn_Duration
msdyn_DurationToBill
msdyn_IsCopied
msdyn_LineOrder
msdyn_name
msdyn_PriceList
msdyn_Service
msdyn_Unit
msdyn_UnitAmount
OverriddenCreatedOn
OwnerId
OwnerIdType
statecode
statuscode
TimeZoneRuleVersionNumber
TransactionCurrencyId
UTCConversionTimeZoneCode

ImportSequenceNumber

Property	Value
Description	Shows the sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`importsequencenumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

msdyn_Agreement

Property	Value
Description	Unique identifier for Agreement associated with Agreement Booking Service.
DisplayName	Agreement
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_agreement`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	msdyn_agreement

msdyn_AgreementBookingIncident

Property	Value
Description	The Agreement Booking Incident related to this service
DisplayName	Agreement Booking Incident
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_agreementbookingincident`
RequiredLevel	None
Type	Lookup
Targets	msdyn_agreementbookingincident

msdyn_agreementbookingserviceId

Property	Value
Description	Shows the entity instances.
DisplayName	Agreement Booking Service
IsValidForForm	False
IsValidForRead	True
LogicalName	`msdyn_agreementbookingserviceid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_AgreementBookingSetup

Property	Value
Description	Unique identifier for Agreement Booking Setup associated with Agreement Booking Service.
DisplayName	Agreement Booking Setup
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_agreementbookingsetup`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	msdyn_agreementbookingsetup

msdyn_Currency

Property	Value
Description
DisplayName	Currency
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_currency`
RequiredLevel	None
Type	Money
ImeMode	Auto
IsBaseCurrency	False
MaxValue	1000000000
MinValue	0
Precision	4
PrecisionSource	2 (TransactionCurrency.CurrencyPrecision)

msdyn_CustomerAsset

Property	Value
Description	Customer Asset related to this Service
DisplayName	Customer Asset
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_customerasset`
RequiredLevel	None
Type	Lookup
Targets	msdyn_customerasset

msdyn_Duration

Property	Value
Description	Shows the actual duration of service.
DisplayName	Duration
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_duration`
RequiredLevel	ApplicationRequired
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_DurationToBill

Property	Value
Description	Enter the duration you want to bill the customer for. By default, this will default to the same value as the "Duration" field.
DisplayName	Duration To Bill
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_durationtobill`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	0

msdyn_IsCopied

Property	Value
Description
DisplayName	Is Copied
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_iscopied`
RequiredLevel	None
Type	Boolean
GlobalChoiceName	`msdyn_agreementbookingservice_msdyn_iscopied`
DefaultValue	False
True Label	Yes
False Label	No

msdyn_LineOrder

Property	Value
Description	Shows the order of this service within the agreement services.
DisplayName	Line Order
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_lineorder`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

msdyn_name

Property	Value
Description	Enter the name of the custom entity.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_name`
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

msdyn_PriceList

Property	Value
Description	Optionally set Price List that will determine the pricing for this service on the Work Order
DisplayName	Price List
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_pricelist`
RequiredLevel	None
Type	Lookup
Targets	pricelevel

msdyn_Service

Property	Value
Description	Unique identifier for Product/Service associated with Agreement Booking Service.
DisplayName	Service
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_service`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	product

msdyn_Unit

Property	Value
Description	The unit that determines the pricing for this service when Price List is set
DisplayName	Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_unit`
RequiredLevel	None
Type	Lookup
Targets	uom

msdyn_UnitAmount

Property	Value
Description	Enter the amount you wish to charge the customer per unit. This field is optional.
DisplayName	Unit Amount
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_unitamount`
RequiredLevel	None
Type	Money
ImeMode	Disabled
IsBaseCurrency	False
MaxValue	1000000000
MinValue	0
Precision	2
PrecisionSource	1 (Organization.PricingDecimalPrecision)

OverriddenCreatedOn

Property	Value
Description	Shows the date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	`overriddencreatedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

OwnerId

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	`ownerid`
RequiredLevel	SystemRequired
Type	Owner
Targets	systemuser, team

OwnerIdType

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridtype`
RequiredLevel	SystemRequired
Type	EntityName

statecode

Property	Value
Description	Status of the Agreement Booking Service
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`msdyn_agreementbookingservice_statecode`

statecode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: `Active`
1	Label: Inactive DefaultStatus: 2 InvariantName: `Inactive`

statuscode

Property	Value
Description	Reason for the status of the Agreement Booking Service
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`msdyn_agreementbookingservice_statuscode`

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`timezoneruleversionnumber`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

TransactionCurrencyId

Property	Value
Description	Unique identifier of the currency associated with the entity.
DisplayName	Currency
IsValidForForm	True
IsValidForRead	True
LogicalName	`transactioncurrencyid`
RequiredLevel	None
Type	Lookup
Targets	transactioncurrency

UTCConversionTimeZoneCode

Property	Value
Description	Shows the time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	`utcconversiontimezonecode`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy
CreatedOn
CreatedOnBehalfBy
ExchangeRate
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
msdyn_currency_Base
msdyn_unitamount_Base
OwnerIdName
OwnerIdYomiName
OwningBusinessUnit
OwningTeam
OwningUser
VersionNumber

CreatedBy

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	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.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ExchangeRate

Property	Value
Description	Shows the exchange rate for the currency associated with the entity with respect to the base currency.
DisplayName	Exchange Rate
IsValidForForm	True
IsValidForRead	True
LogicalName	`exchangerate`
RequiredLevel	None
Type	Decimal
ImeMode	Disabled
MaxValue	100000000000
MinValue	1E-10
Precision	10
SourceTypeMask	0

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	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.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Shows who last updated the record on behalf of another user.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
Type	Lookup
Targets	systemuser

msdyn_currency_Base

Property	Value
Description	Shows the value of the currency in the base currency.
DisplayName	Currency (Base)
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_currency_base`
RequiredLevel	None
Type	Money
ImeMode	Disabled
IsBaseCurrency	True
MaxValue	922337203685477
MinValue	-922337203685477
Precision	4
PrecisionSource	2 (TransactionCurrency.CurrencyPrecision)

msdyn_unitamount_Base

Property	Value
Description	Shows the value of the unit amount in the base currency.
DisplayName	Unit Amount (Base)
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_unitamount_base`
RequiredLevel	None
Type	Money
ImeMode	Disabled
IsBaseCurrency	True
MaxValue	922337203685477
MinValue	-922337203685477
Precision	2
PrecisionSource	1 (Organization.PricingDecimalPrecision)

OwnerIdName

Property	Value
Description	Name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridname`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwnerIdYomiName

Property	Value
Description	Yomi name of the owner
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	`owneridyominame`
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OwningBusinessUnit

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	`owningbusinessunit`
RequiredLevel	None
Type	Lookup
Targets	businessunit

OwningTeam

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	`owningteam`
RequiredLevel	None
Type	Lookup
Targets	team

OwningUser

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	`owninguser`
RequiredLevel	None
Type	Lookup
Targets	systemuser

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	`versionnumber`
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

msdyn_msdyn_agreement_msdyn_agreementbookingservice_Agreement
msdyn_msdyn_agreementbookingincident_msdyn_agreementbookingservice_AgreementBookingIncident
msdyn_msdyn_agreementbookingsetup_msdyn_agreementbookingservice_AgreementBookingSetup
msdyn_msdyn_customerasset_msdyn_agreementbookingservice_CustomerAsset
msdyn_product_msdyn_agreementbookingservice_Service

msdyn_msdyn_agreement_msdyn_agreementbookingservice_Agreement

One-To-Many Relationship: msdyn_agreement msdyn_msdyn_agreement_msdyn_agreementbookingservice_Agreement

Property	Value
ReferencedEntity	`msdyn_agreement`
ReferencedAttribute	`msdyn_agreementid`
ReferencingAttribute	`msdyn_agreement`
ReferencingEntityNavigationPropertyName	`msdyn_agreement`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

msdyn_msdyn_agreementbookingincident_msdyn_agreementbookingservice_AgreementBookingIncident

One-To-Many Relationship: msdyn_agreementbookingincident msdyn_msdyn_agreementbookingincident_msdyn_agreementbookingservice_AgreementBookingIncident

Property	Value
ReferencedEntity	`msdyn_agreementbookingincident`
ReferencedAttribute	`msdyn_agreementbookingincidentid`
ReferencingAttribute	`msdyn_agreementbookingincident`
ReferencingEntityNavigationPropertyName	`msdyn_agreementbookingincident`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

msdyn_msdyn_agreementbookingsetup_msdyn_agreementbookingservice_AgreementBookingSetup

One-To-Many Relationship: msdyn_agreementbookingsetup msdyn_msdyn_agreementbookingsetup_msdyn_agreementbookingservice_AgreementBookingSetup

Property	Value
ReferencedEntity	`msdyn_agreementbookingsetup`
ReferencedAttribute	`msdyn_agreementbookingsetupid`
ReferencingAttribute	`msdyn_agreementbookingsetup`
ReferencingEntityNavigationPropertyName	`msdyn_agreementbookingsetup`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `Cascade` Delete: `Cascade` Merge: `NoCascade` Reparent: `Cascade` RollupView: `NoCascade` Share: `Cascade` Unshare: `Cascade`

msdyn_msdyn_customerasset_msdyn_agreementbookingservice_CustomerAsset

One-To-Many Relationship: msdyn_customerasset msdyn_msdyn_customerasset_msdyn_agreementbookingservice_CustomerAsset

Property	Value
ReferencedEntity	`msdyn_customerasset`
ReferencedAttribute	`msdyn_customerassetid`
ReferencingAttribute	`msdyn_customerasset`
ReferencingEntityNavigationPropertyName	`msdyn_customerasset`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `RemoveLink` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

msdyn_product_msdyn_agreementbookingservice_Service

One-To-Many Relationship: product msdyn_product_msdyn_agreementbookingservice_Service

Property	Value
ReferencedEntity	`product`
ReferencedAttribute	`productid`
ReferencingAttribute	`msdyn_service`
ReferencingEntityNavigationPropertyName	`msdyn_service`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `Restrict` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

msdyn_agreementbookingservice_msdyn_bookingalerts
msdyn_msdyn_agreementbookingservice_msdyn_workorderservice_AgreementBookingService

msdyn_agreementbookingservice_msdyn_bookingalerts

Many-To-One Relationship: msdyn_bookingalert msdyn_agreementbookingservice_msdyn_bookingalerts

Property	Value
ReferencingEntity	`msdyn_bookingalert`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`msdyn_agreementbookingservice_msdyn_bookingalerts`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

msdyn_msdyn_agreementbookingservice_msdyn_workorderservice_AgreementBookingService

Many-To-One Relationship: msdyn_workorderservice msdyn_msdyn_agreementbookingservice_msdyn_workorderservice_AgreementBookingService

Property	Value
ReferencingEntity	`msdyn_workorderservice`
ReferencingAttribute	`msdyn_agreementbookingservice`
ReferencedEntityNavigationPropertyName	`msdyn_msdyn_agreementbookingservice_msdyn_workorderservice_AgreementBookingService`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Share via