AgreementLine Table

The AgreementLine table stores information about the purchase agreement details.

Configuration Key: TradeBlanketOrder

Methods

	Method	Description
	agreementHeader	Retrieves the AgreementHeader record from the current AgreementLine record.
	agreementLineDefault
	agreementModuleType	Retrieves the type of the agreement.
	aosValidateDelete	Validates on the server that the specified record can be deleted from a table. (Inherited from xRecord.)
	aosValidateInsert	Validates on the server that the specified record can be inserted. (Inherited from xRecord.)
	aosValidateRead	Validates on the server that the specified record can be read. (Inherited from xRecord.)
	aosValidateUpdate	Validates on the server that the specified record can be updated. (Inherited from xRecord.)
	buf2con	Packs the table buffers of an xRecord instance into an X++ container. (Inherited from xRecord.)
	calculateAgreementRemansOnServer	Calculates the remains for an instance of the AgreementLine class and returns them in a container.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canDeleteAgreementLine	Indicates whether the agreement line can be deleted.
	canLinkTo	Indicates whether the specified order line can be associated with the current agreement line.
	canSubmitToWorkflow	Indicates whether submission to workflow is possible. (Inherited from xRecord.)
	caption	Gets and sets the caption property of a table. (Inherited from xRecord.)
	categoryChanged	Initializes the values in the AgreementLine record when the category has been changed.
	checkInvalidFieldAccess	Gets and sets invalid field access. (Inherited from xRecord.)
	checkPurchInventProfile_RU
	checkRecord	Gets and sets the property that indicates whether to check mandatory fields. (Inherited from xRecord.)
	checkRemaining
	checkRestrictedDeleteActions	Gets and sets the property that indicates whether a record can be deleted. (Inherited from xRecord.)
	checkSalesInventProfile_RU
	clear	Removes all rows from the table buffer. (Inherited from xRecord.)
	company	Gets and sets the property that indicates a legal entity for the record. (Inherited from xRecord.)
	con2buf	Unpacks a container into the table buffers. (Inherited from xRecord.)
	concurrencyModel	Gets and sets the default concurrency model to use to update records. (Inherited from xRecord.)
	context	Gets and sets the context property. (Inherited from xRecord.)
	convertCurrencyCode	Converts currency dependable fields when currency code has been changed according to exchange rates between old and new currencies.
	copyDimension	Retrieves a dimension set that can be applied to the defaultDimension field on this table.
	currencyCode	Retrieves the currency that is used for the agreement.
	data	Retrieves a row from the table. (Inherited from xRecord.)
	dataSource	Retrieves the data source of the table. (Inherited from xRecord.)
	defaultField	Populates default values in a field in the table. (Inherited from xRecord.)
	defaultRow	Populates default values in fields in the table in the non-interactive case. (Inherited from xRecord.)
	delete	Deletes the records in the AgreementLine table and subtype tables.
	deleteIntercompanyAgreementLine	Deletes the related intercompany agreement line and reference.
	deleteIntracompanyAgreementLine_RU	Deletes the related intracompany agreement line and reference.
	disableCache	Gets and sets the property that indicates whether caching is disabled. (Inherited from xRecord.)
	displayAgreementHeaderSequence	Displays the sequence number of a associated purchase agreement.
	dispose	Releases resources that are used by the xRecord object. (Inherited from xRecord.)
	doClear	Removes all rows from the table buffer and bypasses any additional logic in the clear method of the table. (Inherited from xRecord.)
	doDelete	Deletes the current record from the table and bypasses any additional logic in the delete method of the table. (Inherited from xRecord.)
	doInsert	Inserts the record into the table and bypasses any additional logic in the insert method of the table. (Inherited from xRecord.)
	doUpdate	Updates the current record and bypasses any additional logic in the update method of the table. (Inherited from xRecord.)
	doValidateDelete	Performs the action to validate that a record can be deleted. (Inherited from xRecord.)
	equal	Determines whether the specified object is equal to the current one. (Inherited from xRecord.)
	fieldAccessRight	Returns the field access right. (Inherited from xRecord.)
	fieldBufferAccessRight	Returns the field access right for the current record. (Inherited from xRecord.)
	fieldState	Sets or returns the state of a field in the table buffer. (Inherited from xRecord.)
	getAllowRedefault	Returns the list of fields that are allowed to re-default. (Inherited from xRecord.)
	getDefaultingDependencies	Returns the container that holds defaulting dependencies. (Inherited from xRecord.)
	getExtension	Returns the table extension. (Inherited from xRecord.)
	getFieldValue	Gets the value of the specified field from a table buffer. (Inherited from xRecord.)
	getInstanceRelationType	Returns the table name that corresponds to the InstanceRelationType ID. (Inherited from xRecord.)
	getPhysicalTableName	Return the physical table name, which, in the case of the SQL Temp DB table, is the table instance name. (Inherited from xRecord.)
	getPresenceFieldData	Retrieves the PresenceInfo value from the specified field. (Inherited from xRecord.)
	getPurchAgreementId
	getSQLStatement	Gets the SQL statement that is used to return records from the database. (Inherited from xRecord.)
	getTableInInstanceHierarchy	(Inherited from xRecord.)
	getTableType	Indicates the type of the table. (Inherited from xRecord.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hasRelatedTable	Indicates whether a foreign key constraint buffer is linked with the table. (Inherited from xRecord.)
	helpField	Retrieves a string that contains the Help text for the specified field. (Inherited from xRecord.)
	historyExists	Specifies whether the history records exist for the agreement line.
	initFromAgreementHeader	Sets the default value for the AgreementLine record from the AgreementHeader record.
	initFromInventTable	Initializes a new instance of the AgreementLine record from the InventTable table.
	initValue	Sets the default values for the AgreementLine record.
	inputStatus	Sets or returns the current input status of the table buffer. (Inherited from xRecord.)
	insert	Inserts the records into the AgreementLine table and subtype tables.
	interactiveContext	Sets or returns the current interactive context of the table buffer. (Inherited from xRecord.)
	intercompanyAgreementLine	Finds the intercompany agreement line record that relates to the AgreementLine record.
	intercompanyLinkExist	Indicates whether an intercompany link for the agreement line quantity exists.
	intercompanyOriginDisplay	Retrieves a string that specifies how the agreement line is created by using regard to intercompany agreements.
	intracompanyAgreementLine_RU	Finds the intracompany agreement line record that relates to the AgreementLine record.
	intracompanyLinkExist_RU	Indicates whether an intracompany link for the agreement line quantity exists.
	inventDim	Retrieves the InventDim record for the current agreement line.
	inventTable	Retrieves the InventTable record for the current blanket order line.
	invoiceExists	Specifies whether the invoice journal transaction records exist for the agreement line.
	isCategoryBased	Specifies whether the current AgreementLine record is category based.
	isDerivedAgreement	Indicates whether the agreement line is a derived intercompany agreement line.
	isFieldDataRetrieved	Checks whether the data of the given field has been retrieved. (Inherited from xRecord.)
	isFieldSet	Checks whether a field has a Set or Defaulted state. (Inherited from xRecord.)
	isFormDataSource	Indicates whether the data source is a form. (Inherited from xRecord.)
	isItemBased	Specifies whether the current AgreementLine record is item based.
	isLinkValid	Validates that the specified order line fits for the current agreement line.
	isNewRecord	Returns true if the record is a new record that hasn't been persisted yet. (Inherited from xRecord.)
	isPartOfUOWSaveChanges	(Inherited from xRecord.)
	isQuantityBased	Validates that the current agreement line is quantity based.
	isReleased	Specifies whether the agreement line has been released.
	isTempDb	Indicates whether the type of the table is SQL TempDB. (Inherited from xRecord.)
	isTmp	Indicates whether this is a temporary table. (Inherited from xRecord.)
	itemIdChanged	Initializes the values in the AgreementLine record when the item ID has been changed.
	joinChild	Finds the join child of the current record. (Inherited from xRecord.)
	joinParent	Finds the join parent of the current record. (Inherited from xRecord.)
	linkInventDim2Dimension	Sets the default inventory dimension values of the AgreementLine record by using the values in the InventDim record buffer.
	linkPhysicalTableInstance	Checks whether there is a link for the physical table instance for the record. (Inherited from xRecord.)
	merge	Merges the current table with the specified table. (Inherited from xRecord.)
	mergeDimension	Retrieves a dimension set that can be applied to the defaultDimension field on this table.
	modifiedField	Specifies when a field is modified on the AgreementLine record.
	modifiedFieldValue	Modifies the specified field to the original value. (Inherited from xRecord.)
	name	Gets the name of the item or category for the current agreement line.
	new	Initializes a new instance of the Object class. (Inherited from Object.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	orig	Retrieves the original values of the current record. (Inherited from xRecord.)
	overwriteSystemfields	Gets and sets the property that indicates whether system fields can be overwritten. (Inherited from xRecord.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pdsCWQuantityCheckRemaining	Indicates whether the specified quantity in catch weight can be covered by the agreement line.
	pdsCWQuantityRemainingQueried	Gets data and calculates the remaining quantity for the line in catch weight.
	pdsCWQuantityRemainingRelease	Gets the remaining catch weight quantity to be released.
	pdsSameLot	Gets the value of the same lot reservation parameter.
	postCacheLoad	Is executed after data is hit from the cache for the select operation on the table. (Inherited from xRecord.)
	postLoad	Is executed after a record is read. (Inherited from xRecord.)
	preRemoting	Is executed before a cross-tier call is about to be executed for the table that would pack its state to the other tier. (Inherited from xRecord.)
	purchAgreementHeader	Retrieves the PurchAgreementHeader record from the current AgreementLine record.
	quantityRemainingRelease	Calculates quantity that remains for the line.
	queryTimedOut	Indicates whether the query exceeded the time limit for execution. (Inherited from xRecord.)
	queryTimeout	Gets and sets the property that indicates the time limit for the execution of a query. (Inherited from xRecord.)
	readCommittedLock	(Inherited from xRecord.)
	readPast	Gets and sets the property that indicates whether to skip rows that are locked by other processes when a record is read. (Inherited from xRecord.)
	recordLevelSecurity	Gets and sets the property that indicates whether to apply security on a record level. (Inherited from xRecord.)
	relatedObjectExistanceFlags	Indicates that an invoice exists and releases the records that are associated with the current AgreementLine record.
	relatedTable	Sets or returns the related buffer of a link of a table buffer. (Inherited from xRecord.)
	remainingQueried	Queries data and calculates the remaining quantity for the line.
	renamePrimaryKey	Renames the foreign keys in other tables according to the change of the corresponding primary key value in this table. (Inherited from xRecord.)
	reread	Rereads the record from the table. (Inherited from xRecord.)
	RowCount	Retrieves the number of rows in the table. (Inherited from xRecord.)
	salesAgreementHeader	Retrieves the SalesAgreementHeader record from the current AgreementLine record.
	selectForUpdate	Gets and sets the property that indicates whether to select records for update when they are read. (Inherited from xRecord.)
	selectLocked	Indicates whether to select locked records. (Inherited from xRecord.)
	selectRefRecord	Selects the record by referenced field ID. (Inherited from xRecord.)
	selectWithRepeatableRead	Gets and sets the property that indicates whether repeatable read is enabled. (Inherited from xRecord.)
	setCommitment	Sets the CommitmentType enumeration value in the AgreementLine record.
	setConnection	Sets the user connection for this table. (Inherited from xRecord.)
	setCrossPartition	Sets or resets cross-partitioning for the table. (Inherited from xRecord.)
	setFieldValue	Sets the field value in the record buffer. (Inherited from xRecord.)
	setInventDimId	Applies the InventDim parameter to the InventDimId field of the AgreementLine record and sets the default values by using the new inventory dimensions.
	setLineProduct	Sets the line product in the AgreementLine record.
	setSQLTracing	Enables or disables SQL tracing mode. (Inherited from xRecord.)
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	setTmp	Sets the table so that it is not persisted to the database. (Inherited from xRecord.)
	setTmpData	Sets the contents of the temporary table to the specified data. (Inherited from xRecord.)
	setXDSContext	Sets new XDS context. (Inherited from xRecord.)
	skipAosValidation	Gets and sets the property that indicates whether to skip validation of Microsoft Dynamics AX Application Object Server (AOS). (Inherited from xRecord.)
	skipDatabaseLog	Gets and sets the property that indicates whether to skip database log requests. (Inherited from xRecord.)
	skipDataMethods	Gets and sets the property that indicates whether to discard overloaded methods. (Inherited from xRecord.)
	skipDeleteActions	Gets and sets the property that indicates whether to skip delete actions on the table. (Inherited from xRecord.)
	skipDeleteMethod	Gets and sets the property that indicates whether to discard overloaded methods. (Inherited from xRecord.)
	skipEvents	Provides an option to turn off calling the Application.event* methods for the lifetime of an xRecord object. (Inherited from xRecord.)
	skipPostLoad	Gets and sets the property that indicates whether to skip executing the xRecord.postLoad method on the table. (Inherited from xRecord.)
	skipTTSCheck	Gets and sets the property that indicates whether to skip the check to determine whether the record is selected for update. (Inherited from xRecord.)
	softDelete	Marks the AgreementLine record as deleted.
	suppressWarnings	Gets and sets the property that indicates whether to suppress warnings for this pointer. (Inherited from xRecord.)
	tableAccessRight	Returns the table access right. (Inherited from xRecord.)
	tableBufferAccessRight	Returns the table access right for the current record. (Inherited from xRecord.)
	takeOwnershipOfTempDBTable	(Inherited from xRecord.)
	toolTipField	Retrieves the HelpText value for the specified field. (Inherited from xRecord.)
	toolTipRecord	Retrieves the ToolTip value for the current record. (Inherited from xRecord.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	ttsabort	Aborts a transaction that was started by a call to the ttsbegin method. (Inherited from xRecord.)
	ttsbegin	Starts a transaction that can be either committed by the ttscommit method or aborted by the ttsabort method. (Inherited from xRecord.)
	ttscommit	Commits a transaction that was started by a call to the ttsbegin method. (Inherited from xRecord.)
	type	Creates an instance of the AgreementCommitment class by using the current record in the AgreementLine table.
	update	Updates the AgreementLine table and subtype table records.
	updateDefaultDimension	Updates the financial dimensions for a line.
	updateHeaderDates	Updates the LatestLineExpirationDate and EarliestLineEffectiveDate fields of the header table
	usageCount	Retrieves the current number of references (the value of the reference counter) that the object has. (Inherited from xRecord.)
	useExistingTempDBTable	(Inherited from xRecord.)
	validateAmount	Validates whether the specified order line amount fits the current agreement line.
	validateDelete	Validates that the AgreementLine record can be deleted.
	validateField	Validates a field in the AgreementLine table.
	validateFieldValue	(Inherited from xRecord.)
	validateModifyInventDim_RU	Determines whether the specified inventory dimension can be changed.
	validateRelease	Validates whether the agreementLine record can be associated with the record in a table that corresponds to the SalesPurchLine map.
	validateReleaseMinMaxAmount	Validates the release maximum or minimum amount setup of the AgreementLine record.
	validateWrite	Indicates whether the current record is valid and ready to be written to the database.
	validTimeStateUpdateMode	Sets a valid time state update mode on the cursor. (Inherited from xRecord.)
	wait	Pauses a process. (Inherited from Object.)
	wasCached	Specifies the location from which the data was retrieved. (Inherited from xRecord.)
	write	Updates a record if it exists; otherwise, inserts a record. (Inherited from xRecord.)
	xml	Retrieves an XML string that represents the current object. (Inherited from xRecord.)
	::calculateFulfillmentForLine	Initiates the calculations of fulfillment numbers for the line.
	::existsByAgreementHeader	Indicates whether a record exists for the specified value of the PurchAgreementHeader table record.
	::find	Finds the specified record in the AgreementLine table.
	::findCustInvoiceTrans	Finds the record in the AgreementLine table by using the specified record ID of a CustInvoiceTrans record.
	::findLineForAutoMatch	Retrieves the best agreement line to associate with the sales or purchase line.
	::findProjInvoiceItem	Finds the record in the AgreementLine table by using the specified record ID of a ProjInvoiceItem record.
	::findTheBestAgreementLine
	::findVendInvoiceTrans	Finds the record in the AgreementLine table by using the specified record ID of a VendInvoiceTrans record.
	::getAgreementLinesForOrderLine	Retrieves the list of the agreement lines that match to the sales or purchase line.
	::getAgreementLinesForPurchLine	Retrieves the list of agreement lines that match the specified sales or purchase line.
	::getAgreementLinesForPurchReqLine	Retrieves the list of agreement lines that match the specified purchase requisition line.
	::getAgreementLinesForVendInvoiceLine	Retrieves the list of agreement lines that match the specified vendor invoice line.
	::getAgreementLinesList	Retrieves the list of agreement lines that match the specified parameters.
	::getDimFieldList	Retrieves a list of field IDs that match the set fields in the table buffer of the InventDim with the AgreementDimensionsPrioritized field group.
	::lastLineNum	Retrieves the last line number that is used for the current agreement.
	::posCanDeleteAgreementLine	Retrieves the position of the release existence value in a result container that is returned by the relatedObjectExistanceFlags method.
	::posInvoicesExist	Returns position of invoice existence flag in a result container returned by relatedObjectExistanceFlags method.
	::posReleasesExist	Retrieves the value of the release existence value in a result container that is returned by the relatedObjectExistanceFlags method.

Top

Fields

Field	Type	Configuration key	Description
AgreedReleaseLineMaxAmount	Extended Data Type: AgreementMaximumReleaseAmount Type: Real	TradeBlanketOrder	The maximum release amount agreed on for each order line that uses the agreement.
AgreedReleaseLineMinAmount	Extended Data Type: AgreementMinimumReleaseAmount Type: Real	TradeBlanketOrder	The minimum release amount agreed on for each order line that uses the agreement.
Agreement	Extended Data Type: AgreementHeaderRecId Type: Int64	None	Reference to the agreement header record
AgreementLineProduct	Enumeration: AgreementLineProduct	TradeBlanketOrder	Product
AgreementLineType	Enumeration: CommitmentType	None	Line type
Category	Extended Data Type: RefRecId Type: Int64	None	Category from the procurement category hierarchy
DefaultDimension	Extended Data Type: DimensionDefault Type: Int64	LedgerBasic	Default dimensions (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3)
EffectiveDate	Extended Data Type: EffectiveDate Type: Date	None	The date from which the agreement line is valid.
ExpirationDate	Extended Data Type: ExpirationDate Type: Date	None	The date until which the agreement line is valid.
InstanceRelationType	Extended Data Type: RelationType Type: Int64	None	Immediate derived table in table inheritance.
InventDimDataAreaId	Extended Data Type: DataAreaId Type: String	None	ID for an area of data
InventDimId	Extended Data Type: InventDimId Type: String	None	Identification of dimensions for the item.
IsDeleted	Enumeration: NoYes	None
IsMaxEnforced	Extended Data Type: IsMaxEnforced Type: Enum	None	Is max enforced?
IsModified	Enumeration: NoYes	None
IsPriceInformationMandatory	Extended Data Type: IsPriceInfoMandatory Type: Enum	None	Is price info mandatory?
ItemDataAreaId	Extended Data Type: DataAreaId Type: String	None	ID for an area of data
ItemId	Extended Data Type: ItemId Type: String	LogisticsBasic	Identify item.
LineDiscountPercent	Extended Data Type: AgreementDiscPercent Type: Real	PriceDisc	Discount in percentage.
LineNumber	Extended Data Type: AgreementLineNum_PSN Type: Real	None	Used for sorting (COUNTER)
Partition	Extended Data Type: Partition Type: Int64	None	(This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS))
ProjectDataAreaId	Extended Data Type: DataAreaId Type: String	None	ID for an area of data
ProjectProjId	Extended Data Type: ProjId Type: String	ProjBasic	Project identification
RecId	Extended Data Type: RecId Type: Int64	None
recVersion	Extended Data Type: RecVersion Type: Integer	None
relationType	Extended Data Type: RelationType Type: Int64	None

Top

Field Groups

Field Group	Fields
Line
LineNumber
Price
Project
Quantity
ReleaseLimit
ValidityPeriod
Item
Category
Dimension
Discount
AutoIdentification
AutoReport

Top

Relations

Relation	Table	Lines
AgreementHeader	AgreementHeader
Category	EcoResCategory
DefaultDimension	DimensionAttributeValueSet
InventDim	InventDim
InventTable	InventTable
ItemId	InventTable
Partition	Partitions
ProjectProjId	ProjTable
ProjTable	ProjTable

Top

Indexes

Index	AllowDuplicates	Enabled	Fields
AgreementHeaderIdx	No	Yes
EcoResCategoryIdx	Yes	Yes
InventDimIdx	Yes	Yes
InventTableIdx	Yes	Yes
ProjTableIdx	Yes	Yes
RecId	No	Yes

Top

Inheritance Hierarchy

xRecord Class
  Common Table
    AgreementLine Table
      AgreementLineQuantityCommitment Table
      AgreementLineVolumeCommitment Table

See Also

Table Methods

Tables Overview