msdyn_fieldservicesetting EntityType

Entity Set Path
[organization URI]/api/data/v9.0/msdyn_fieldservicesettings
Base Type
crmbaseentity
Display Name
Field Service Setting
Primary Key
msdyn_fieldservicesettingid
Primary Key Attribute
msdyn_name
Operations Supported
POST GET PATCH DELETE

Properties

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_advancedsettings Edm.String

For internal use only.

Display Name: Advanced Settings

msdyn_agreementprefix Edm.String

Display Name: Agreement Prefix

msdyn_agreementstartingnumber Edm.Int32

Display Name: Agreement Starting Number

msdyn_autoallocateestimatedproducts Edm.Boolean

If enabled then Allocated will be automatically set when entering a Work order Product with a Line Status of Estimate.

Display Name: Auto Allocate Estimated Products

Default Options
Value Label
1 Yes
0 No
msdyn_autogeneratewoforagreementbooking Edm.Boolean

Display Name: Auto Generate WO for Agreement Booking

Default Options
Value Label
1 Yes
0 No
msdyn_autogeocodeaddresses Edm.Boolean

If set then the system will automatically geo code addresses when the address has been updated and the record is saved

Display Name: Auto Geo Code Addresses

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

Display Name: Booking Alert Template (Deprecated)

msdyn_cancelcurrentslotswhenmoving Edm.Boolean

Select whether, when moving open slots to the next day, to leave the old slots and change their status to "Cancel."

Display Name: Cancel Current Slots When Moving (Deprecated)

Default Options
Value Label
1 Yes
0 No
msdyn_customgpsdata Edm.Boolean

If enabled system will use custom entity for its source of Geo Locations for resources to be displayed on map view

Display Name: Custom GPS Data (Deprecated)

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

Shows the logical name of the latitude field to be used for geolocations.

Display Name: Custom GPS Latitude field (Deprecated)

msdyn_customgpslocationentity Edm.String

Shows the logical name of custom entity to be used for geolocations.

Display Name: Custom GPS Location entity (Deprecated)

msdyn_customgpslongitudefield Edm.String

Shows the logical name of the longitude field to be used for geolocations.

Display Name: Custom GPS Longitude field (Deprecated)

msdyn_customgpsresourcefield Edm.String

Shows the logical name of the resource field to be used for geolocations.

Display Name: Custom GPS Resource field (Deprecated)

msdyn_customgpstimestampfield Edm.String

Shows the logical name of the timestamp field to be used for geolocations.

Display Name: Custom GPS Timestamp field (Deprecated)

msdyn_databaseversion Edm.Int32

For Internal Use

Display Name: Database Version

msdyn_deactivatebookingwhencanceled Edm.Boolean

Select whether the system should deactivate the resource booking when the system status is changed to "Canceled."

Display Name: Deactivate Booking When Canceled

Default Options
Value Label
1 Yes
0 No
msdyn_deactivatebookingwhencompleted Edm.Boolean

Select whether the system should deactivate the resource booking when the system status is changed to "Completed."

Display Name: Deactivate Booking When Completed

Default Options
Value Label
1 Yes
0 No
msdyn_deactivateworkorderwhencanceled Edm.Boolean

Select whether the system should deactivate the work order when the system status is changed to "Closed - Canceled."

Display Name: Deactivate Work Order When Canceled

Default Options
Value Label
1 Yes
0 No
msdyn_deactivateworkorderwhenposted Edm.Boolean

Select whether the system should deactivate the work order when the system status is changed to "Closed - Posted."

Display Name: Deactivate Work Order When Posted

Default Options
Value Label
1 Yes
0 No
msdyn_defaultbookingduration Edm.Int32

Display Name: Default Booking Duration (Deprecated)

msdyn_defaultradiusunit Edm.Boolean

Display Name: Default Radius Unit (Deprecated)

Default Options
Value Label
1 mi
0 km
msdyn_defaultradiusvalue Edm.Int32

Display Name: Default Radius Value (Deprecated)

msdyn_defaultworkordercompletedstatus Edm.Int32

Select whether the default work order completed status is either "Completed" or "Posted."

Display Name: Default Work Order Completed Status

Default Options
Value Label
690970000 Open - Unscheduled
690970001 Open - Scheduled
690970002 Open - In Progress
690970003 Open - Completed
690970004 Closed - Posted
690970005 Closed - Canceled
msdyn_enablelegacyscheduleassistant Edm.Boolean

Display Name: Enable Legacy Schedule Assistant

Default Options
Value Label
1 Yes
0 No
msdyn_entitynumberlength Edm.Int32

Display Name: Entity Number Length

msdyn_fieldservicesettingid Edm.Guid

Shows the entity instances.

Display Name: Field Service Setting

msdyn_generateagreementinvoicesxdaysinadvance Edm.Int32

Display Name: Generate Agreement Invoices X Days In Advance

msdyn_generateagreementwoxdaysinadvance Edm.Int32

Specify default how many days in advance of the Agreement Booking Date the system should automatically generate a Work Order

Display Name: Generate Agreement WO X Days In Advance

msdyn_generatebookingdatesxmonthsinadvance Edm.Int32

Display Name: Generate Booking Dates X Months In Advance

msdyn_generateinvoicedatesxmonthsinadvance Edm.Int32

Display Name: Generate Invoice Dates X Months In Advance

msdyn_gpslocationexpiresafterxminutes Edm.Int32

Display Name: GPS Location Expires After X Minutes (Deprecated)

msdyn_inventoryadjustmentprefix Edm.String

Shows the prefix to be added to the inventory adjustment numbers.

Display Name: Inventory Adjustment Prefix

msdyn_inventoryadjustmentstartingnumber Edm.Int32

Shows the number to be used as the starting number for inventory adjustments.

Display Name: Inventory Adjustment Starting Number

msdyn_inventorytransferprefix Edm.String

Shows the prefix to be added to the inventory transfer numbers.

Display Name: Inventory Transfer Prefix

msdyn_inventorytransferstartingnumber Edm.Int32

Shows the number to be used as the starting number for inventory transfers.

Display Name: Inventory Transfer Starting Number

msdyn_name Edm.String

Enter the name of the custom entity.

Display Name: Name

msdyn_notificationtimeout Edm.Int32

Display Name: Notification Timeout (In sec) (Deprecated)

msdyn_postponenumbercleanupuntil Edm.DateTimeOffset

Shows the date when cleanup of unique numbers will occur.

Display Name: Postpone Number Cleanup Until

msdyn_productcostorder Edm.Int32

Display Name: Product Cost Order

Default Options
Value Label
690970000 Standard/Current
690970001 Current/Standard
msdyn_purchaseorderapprovalrequired Edm.Boolean

Enable if a Purchase Order requires approval in order for the status to be changed to Submitted

Display Name: Purchase Order Approval Required

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

Shows the prefix to be added to the purchase order numbers.

Display Name: Purchase Order Prefix

msdyn_purchaseorderstartingnumber Edm.Int32

Shows the number to be used as starting number for the automatically generated purchase order number.

Display Name: Purchase Order Starting Number

msdyn_resourcessynchronizationtimeout Edm.Int32

Display Name: Resources Synchronization Timeout (Deprecated)

msdyn_rmaprefix Edm.String

Display Name: RMA Prefix

msdyn_rmastartingnumber Edm.Int32

Shows the number to be used as the starting number for the automatically generation RMA number.

Display Name: RMA Starting Number

msdyn_rtvprefix Edm.String

Display Name: RTV Prefix

msdyn_rtvstartingnumber Edm.Int32

Shows the number to be used as the starting number for the automatically generated RTV number.

Display Name: RTV Starting Number

msdyn_saautofilterserviceterritory Edm.Boolean

Select whether the schedule assistant should automatically filter the results based on the territory set on the work order.

Display Name: Auto Filter Service Territory (Deprecated)

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

Display Name: Scheduler Business Unit Details View (Deprecated)

msdyn_schedulerbusinessunittooltipview Edm.String

Display Name: Scheduler Business Unit Tooltip View (Deprecated)

msdyn_schedulercoredetailsview Edm.String

Display Name: Scheduler Core Details View (Deprecated)

msdyn_schedulercoreslottexttemplate Edm.String

Display Name: Scheduler Core Slot Text Template (Deprecated)

msdyn_schedulercoretooltipview Edm.String

Display Name: Scheduler Core Tooltip View (Deprecated)

msdyn_schedulerfieldservicedetailsview Edm.String

Display Name: Scheduler Field Service Details View (Deprecated)

msdyn_schedulerfieldserviceslottexttemplate Edm.String

Display Name: Scheduler Field Service Slot Text Template (Deprecated)

msdyn_schedulerfieldservicetooltipview Edm.String

Display Name: Scheduler Field Service Tooltip View (Deprecated)

msdyn_schedulerresourcedetailsview Edm.String

Display Name: Scheduler Resource Details View (Deprecated)

msdyn_schedulerresourcetooltipview Edm.String

Display Name: Scheduler Resource Tooltip View (Deprecated)

msdyn_schedulerunscheduledview Edm.String

Display Name: Scheduler Unscheduled View (Deprecated)

msdyn_sdkapimapkey Edm.String

Api key for map

Display Name: Bing API Key (Deprecated)

msdyn_traveltimerescheduling Edm.Boolean

Display Name: Travel Time Rescheduling (Deprecated)

Default Options
Value Label
1 Yes
0 No
msdyn_undefinedbookinglocation Edm.Int32

Location for schedules where geo code info has not been defined

Display Name: Undefined Booking Location (Deprecated)

Default Options
Value Label
690970000 Previous Known Location
690970001 Ignore Location
msdyn_unscheduledwotooltipsviewid Edm.String

Display Name: Unscheduled WO Tooltips View Id (Deprecated)

msdyn_useofproductsoutofstock Edm.Int32

Specify how the system should react when trying to use products that are out of stock.

Display Name: Use of Products Out of Stock

Default Options
Value Label
690970000 Confirm
690970001 Restrict
msdyn_workorderinvoicecreation Edm.Int32

Specify whether the system should automatically generate an invoice for work orders.

Display Name: Work Order Invoice Creation

Default Options
Value Label
690970001 On Work Order Posted
690970000 Never
msdyn_workorderprefix Edm.String

Display Name: Work Order Prefix

msdyn_workorderstartingnumber Edm.Int32

Display Name: Work Order Starting Number

overriddencreatedon Edm.DateTimeOffset

Shows the date and time that the record was migrated.

Display Name: Record Created On

statecode Edm.Int32

Status of the Field Service Setting

Display Name: Status

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

Shows the reason for the status of the field service setting.

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.

_msdyn_breakpaytype_value msdyn_breakpaytype

Default Pay Type to be used for Break hours

_msdyn_businessclosurepaytype_value msdyn_businessclosurepaytype

Default Pay Type to be used for business closure work hours

_msdyn_defaultcanceledbookingstatus_value msdyn_defaultcanceledbookingstatus
_msdyn_defaultscheduledbookingstatus_value msdyn_defaultscheduledbookingstatus
_msdyn_defaultwarehouse_value msdyn_defaultwarehouse

Shows the warehouse associated with the field service setting.

_msdyn_overtimepaytype_value msdyn_overtimepaytype

Default Pay Type to be used for overtime work hours

_msdyn_travelchargeitemid_value msdyn_travelchargeitemid

Product/Service to be used by the system for Travel Charges on Work Orders

_msdyn_travelpaytype_value msdyn_travelpaytype

Default Pay Type to be used for Travel hours

_msdyn_workpaytype_value msdyn_workpaytype

Default Pay Type to be used for regular work hours

_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_fieldservicesetting_createdby
createdonbehalfby systemuser lk_msdyn_fieldservicesetting_createdonbehalfby
modifiedby systemuser lk_msdyn_fieldservicesetting_modifiedby
modifiedonbehalfby systemuser lk_msdyn_fieldservicesetting_modifiedonbehalfby
msdyn_breakpaytype msdyn_resourcepaytype msdyn_msdyn_resourcepaytype_msdyn_fieldservicesetting_BreakPayType
msdyn_businessclosurepaytype msdyn_resourcepaytype msdyn_msdyn_resourcepaytype_msdyn_fieldservicesetting_BusinessClosurePayType
msdyn_defaultcanceledbookingstatus bookingstatus msdyn_bookingstatus_msdyn_fieldservicesetting_DefaultCanceledBookingStatus
msdyn_defaultscheduledbookingstatus bookingstatus msdyn_bookingstatus_msdyn_fieldservicesetting_DefaultScheduledBookingStatus
msdyn_defaultwarehouse msdyn_warehouse msdyn_msdyn_warehouse_msdyn_fieldservicesetting_DefaultWarehouse
msdyn_overtimepaytype msdyn_resourcepaytype msdyn_msdyn_resourcepaytype_msdyn_fieldservicesetting_OvertimePayType
msdyn_travelchargeitemid product msdyn_product_msdyn_fieldservicesetting
msdyn_travelpaytype msdyn_resourcepaytype msdyn_msdyn_resourcepaytype_msdyn_fieldservicesetting_TravelPayType
msdyn_workpaytype msdyn_resourcepaytype msdyn_msdyn_resourcepaytype_msdyn_fieldservicesetting_WorkPayType
ownerid principal owner_msdyn_fieldservicesetting
owningbusinessunit businessunit business_unit_msdyn_fieldservicesetting
owningteam team team_msdyn_fieldservicesetting
owninguser systemuser user_msdyn_fieldservicesetting

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_fieldservicesetting_ActivityPointers activitypointer regardingobjectid_msdyn_fieldservicesetting
msdyn_fieldservicesetting_Annotations annotation objectid_msdyn_fieldservicesetting
msdyn_fieldservicesetting_Appointments appointment regardingobjectid_msdyn_fieldservicesetting_appointment
msdyn_fieldservicesetting_AsyncOperations asyncoperation regardingobjectid_msdyn_fieldservicesetting
msdyn_fieldservicesetting_BulkDeleteFailures bulkdeletefailure regardingobjectid_msdyn_fieldservicesetting
msdyn_fieldservicesetting_Emails email regardingobjectid_msdyn_fieldservicesetting_email
msdyn_fieldservicesetting_Faxes fax regardingobjectid_msdyn_fieldservicesetting_fax
msdyn_fieldservicesetting_Letters letter regardingobjectid_msdyn_fieldservicesetting_letter
msdyn_fieldservicesetting_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_msdyn_fieldservicesetting
msdyn_fieldservicesetting_msdyn_approvals msdyn_approval regardingobjectid_msdyn_fieldservicesetting_msdyn_approval
msdyn_fieldservicesetting_msdyn_bookingalerts msdyn_bookingalert regardingobjectid_msdyn_fieldservicesetting_msdyn_bookingalert
msdyn_fieldservicesetting_PhoneCalls phonecall regardingobjectid_msdyn_fieldservicesetting_phonecall
msdyn_fieldservicesetting_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_msdyn_fieldservicesetting
msdyn_fieldservicesetting_ProcessSession processsession regardingobjectid_msdyn_fieldservicesetting
msdyn_fieldservicesetting_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_msdyn_fieldservicesetting_recurringappointmentmaster
msdyn_fieldservicesetting_ServiceAppointments serviceappointment regardingobjectid_msdyn_fieldservicesetting_serviceappointment
msdyn_fieldservicesetting_SocialActivities socialactivity regardingobjectid_msdyn_fieldservicesetting_socialactivity
msdyn_fieldservicesetting_SyncErrors syncerror regardingobjectid_msdyn_fieldservicesetting
msdyn_fieldservicesetting_Tasks task regardingobjectid_msdyn_fieldservicesetting_task

Operations

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

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

Solutions

The following solutions include the msdyn_fieldservicesetting 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