Agreement Invoice Setup (msdyn_agreementinvoicesetup) table/entity reference (Microsoft Dynamics 365 Field Service)

2025-08-29

Specify the invoices for this agreement.

Messages

The following table lists the messages for the Agreement Invoice Setup (msdyn_agreementinvoicesetup) 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_agreementinvoicesetups(msdyn_agreementinvoicesetupid) 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_agreementinvoicesetups See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /msdyn_agreementinvoicesetups(msdyn_agreementinvoicesetupid) 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_agreementinvoicesetups(msdyn_agreementinvoicesetupid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /msdyn_agreementinvoicesetups 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_agreementinvoicesetups(msdyn_agreementinvoicesetupid) Update the `statecode` and `statuscode` properties.	SetStateRequest
`Update` Event: True	`PATCH` /msdyn_agreementinvoicesetups(msdyn_agreementinvoicesetupid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: False	`PATCH` /msdyn_agreementinvoicesetups(msdyn_agreementinvoicesetupid) 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 Invoice Setup (msdyn_agreementinvoicesetup) table.

Property	Value
DisplayName	Agreement Invoice Setup
DisplayCollectionName	Agreement Invoice Setups
SchemaName	`msdyn_agreementinvoicesetup`
CollectionSchemaName	`msdyn_agreementinvoicesetups`
EntitySetName	`msdyn_agreementinvoicesetups`
LogicalName	`msdyn_agreementinvoicesetup`
LogicalCollectionName	`msdyn_agreementinvoicesetups`
PrimaryIdAttribute	`msdyn_agreementinvoicesetupid`
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_agreementinvoicesetupId
msdyn_Description
msdyn_InternalFlags
msdyn_name
msdyn_PostponeGenerationUntil
msdyn_ProcessStartedOn
msdyn_RecurrenceSettings
msdyn_Revision
OverriddenCreatedOn
OwnerId
OwnerIdType
processid
stageid
statecode
statuscode
TimeZoneRuleVersionNumber
traversedpath
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	Agreement this Invoice Setup relates to
DisplayName	Agreement
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_agreement`
RequiredLevel	ApplicationRequired
Type	Lookup
Targets	msdyn_agreement

msdyn_agreementinvoicesetupId

Property	Value
Description	Shows the entity instances.
DisplayName	Agreement Invoice Setup
IsValidForForm	False
IsValidForRead	True
LogicalName	`msdyn_agreementinvoicesetupid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_Description

Property	Value
Description	Type a description of this invoice setup.
DisplayName	Description
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_description`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

msdyn_InternalFlags

Property	Value
Description	For internal use only.
DisplayName	Internal Flags
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_internalflags`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

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	100

msdyn_PostponeGenerationUntil

Property	Value
Description	Intended for internal use. Manipulating values in this field is not supported and can lead to unexpected system behavior.
DisplayName	Postpone Generation Until
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_postponegenerationuntil`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	True
DateTimeBehavior	TimeZoneIndependent
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

msdyn_ProcessStartedOn

Property	Value
Description	For internal use only
DisplayName	Process Started On
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_processstartedon`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	True
DateTimeBehavior	TimeZoneIndependent
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

msdyn_RecurrenceSettings

Property	Value
Description	Stores the invoice recurrence settings.
DisplayName	Recurrence Settings
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_recurrencesettings`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

msdyn_Revision

Property	Value
Description	For internal use only.
DisplayName	Revision
IsValidForForm	True
IsValidForRead	True
LogicalName	`msdyn_revision`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	1

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

processid

Property	Value
Description	Contains the ID of the process associated with the entity.
DisplayName	Process Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`processid`
RequiredLevel	None
Type	Uniqueidentifier

stageid

Property	Value
Description	Contains the ID of the stage where the entity is located.
DisplayName	Stage Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`stageid`
RequiredLevel	None
Type	Uniqueidentifier

statecode

Property	Value
Description	Status of the Agreement Invoice Setup
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`msdyn_agreementinvoicesetup_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 Invoice Setup
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	`msdyn_agreementinvoicesetup_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

traversedpath

Property	Value
Description	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.
DisplayName	Traversed Path
IsValidForForm	False
IsValidForRead	True
LogicalName	`traversedpath`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1250

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
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
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

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

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_agreementinvoicesetup_Agreement

One-To-Many Relationship: msdyn_agreement msdyn_msdyn_agreement_msdyn_agreementinvoicesetup_Agreement

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

One-to-Many relationships

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

msdyn_agreementinvoicesetup_msdyn_bookingalerts
msdyn_msdyn_agreementinvoicesetup_msdyn_agreementinvoicedate_InvoiceSetup
msdyn_msdyn_agreementinvoicesetup_msdyn_agreementinvoiceproduct_AgreementInvoiceSetup

msdyn_agreementinvoicesetup_msdyn_bookingalerts

Many-To-One Relationship: msdyn_bookingalert msdyn_agreementinvoicesetup_msdyn_bookingalerts

Property	Value
ReferencingEntity	`msdyn_bookingalert`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`msdyn_agreementinvoicesetup_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_agreementinvoicesetup_msdyn_agreementinvoicedate_InvoiceSetup

Many-To-One Relationship: msdyn_agreementinvoicedate msdyn_msdyn_agreementinvoicesetup_msdyn_agreementinvoicedate_InvoiceSetup

Property	Value
ReferencingEntity	`msdyn_agreementinvoicedate`
ReferencingAttribute	`msdyn_invoicesetup`
ReferencedEntityNavigationPropertyName	`msdyn_msdyn_agreementinvoicesetup_msdyn_agreementinvoicedate_InvoiceSetup`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseLabel` Group: `Details` Label: Invoice Dates MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

msdyn_msdyn_agreementinvoicesetup_msdyn_agreementinvoiceproduct_AgreementInvoiceSetup

Many-To-One Relationship: msdyn_agreementinvoiceproduct msdyn_msdyn_agreementinvoicesetup_msdyn_agreementinvoiceproduct_AgreementInvoiceSetup

Property	Value
ReferencingEntity	`msdyn_agreementinvoiceproduct`
ReferencingAttribute	`msdyn_agreementinvoicesetup`
ReferencedEntityNavigationPropertyName	`msdyn_msdyn_agreementinvoicesetup_msdyn_agreementinvoiceproduct_AgreementInvoiceSetup`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseLabel` Group: `Details` Label: Invoice Products MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Feedback

Was this page helpful?