AgreementHeader Table
The AgreementHeader table contains each of the purchase and sales agreements.
Configuration Key: TradeBlanketOrder
Methods
| Method | Description | |
|---|---|---|
.gif "Public method") |
agreementClassification_RU | Gets the AgreementClassification record from the current AgreementHeader record. |
|
agreementDate_RU | Gets the agreement date from the AgreementHeaderExt_RU record. |
|
agreementHeaderDefault | Gets the default AgreementHeader record from the current AgreementHeader record. |
|
agreementValidityPeriodText | Retrieves a string the explains the validity period when intercompany agreements are enabled. |
|
allowCurrencyChange | Indicates whether a change to CurrencyCode is permitted. |
|
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.) |
|
canAddLinesToAgreement | Specifies whether the lines can be added to the agreement or not. |
|
canAuthorizeFinancialDimension | Specifies whether a financial dimension can be authorized. |
|
canBeIntercompanyAgreement | Specifies whether the agreement can be an intercompany agreement. |
|
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
|
canChangeContractor | Specifies whether a contractor can be changed. |
|
canCreateChildAgreement | Specifies whether a child agreement can be created. |
|
canCreateIntercompanyAgreement | Indicates whether the agreement can be used for creating an intercompany agreement. |
|
canCreateIntracompanyAgreement_RU | Indicates whether the agreement can be used for creating an intracompany agreement. |
|
canDeleteAgreement | Indicates whether the agreement can be deleted. |
|
canReleaseAgreement | Indicates whether if the agreement can be released. |
|
canSubmitToWorkflow | Indicates whether submission to workflow is possible. (Inherited from xRecord.) |
|
caption | Gets and sets the caption property of a table. (Inherited from xRecord.) |
|
checkAllLinesHaveCompleteCommitments | Validates that all lines that are associated with the current agreement header are referenced by at least one commitment line with a header document state of complete. |
|
checkInvalidFieldAccess | Gets and sets invalid field access. (Inherited from xRecord.) |
|
checkInventOwner_RU | Determines whether it is possible to change agreement document title in case of related inventory owner. |
|
checkRecord | Gets and sets the property that indicates whether to check mandatory fields. (Inherited from xRecord.) |
|
checkRestrictedDeleteActions | Gets and sets the property that indicates whether a record can be deleted. (Inherited from xRecord.) |
|
clear | Removes all rows from the table buffer. (Inherited from xRecord.) |
.gif "Private method") |
clearAgreementReference_RU | |
|
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 | Changes CurrencyCode used by AgreementHeader and updates all AgreementLines recalculating their fields depedable on currency. |
|
copyDimension | Retrieves a dimension set that can be applied to the defaultDimension field on this table. |
|
createAgreementReleaseHeaderMatch | Creates an instance of the AgreementReleaseHeaderMatchclass that links an agreement header with a release order header. |
|
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 from the AgreementHeader table and subtype tables. |
|
deleteIntercompanyAgreementHeader | Deletes the related intercompany agreement header and the reference. |
|
disableCache | Gets and sets the property that indicates whether caching is disabled. (Inherited from xRecord.) |
|
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.) |
|
fieldChanged | Specifies whether a field in the AgreementHeader buffer has changed with regard to the intercompany. |
|
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.) |
|
getAttachedDocuments | Retrives search object for documents attached to agreement. |
|
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.) |
|
getLegalEntity | Retrieves the legal entity for the agreement. |
|
getModuleType | Retrieves the type of the agreement. |
|
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.) |
|
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. |
|
initFromAgreementClassification | Initializes the agreement header values from the AgreementClassification record. |
|
initFromCustVendTable | Sets the default value for the AgreemenHeader records from the CustTable or VendTable tables. |
|
initValue | Initializes the current AgreementHeader record with default values. |
|
inputStatus | Sets or returns the current input status of the table buffer. (Inherited from xRecord.) |
|
insert | Inserts a record into the AgreementHeader table. |
|
interactiveContext | Sets or returns the current interactive context of the table buffer. (Inherited from xRecord.) |
|
intercompanyErrorAgreementClassification | Throws an error. |
|
intercompanyLinkExist | Indicates whether an intercompany link for the agreement exists. |
|
intercompanyOriginDisplay | Indicates how the agreement was created with regard to intercompany agreements. |
|
intercompanyUpdateNow | Specifies whether the intercompany agreement should be updated. |
|
intracompanyLinkExist_RU | Indicates whether an intracompany link for the agreement exists. |
|
invoiceExists | Specifies whether the invoice journal records exist for the agreement. |
|
isDerivedAgreement | Specifies whether the agreement is a derived intercompany agreement. |
|
isDirectVendorInvoiceEnabled | Determines whether direct vendor invoicing is enabled for the current purchase agreement classification. |
|
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.) |
|
isNewRecord | Returns true if the record is a new record that hasn't been persisted yet. (Inherited from xRecord.) |
|
isPartOfUOWSaveChanges | (Inherited from xRecord.) |
|
isReleased | Specifies whether the agreement is released. |
|
isReleaseOrderMatched | Specifies whether the agreement has a matched release order. |
|
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.) |
|
joinChild | Finds the join child of the current record. (Inherited from xRecord.) |
|
joinParent | Finds the join parent of the current record. (Inherited from xRecord.) |
|
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 | Modifies the specified field to the original. (Inherited from xRecord.) |
|
modifiedFieldValue | Modifies the specified field to the original value. (Inherited from xRecord.) |
|
moduleType | Retrieves the type of the agreement that is either purchase or sales. |
|
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.) |
|
originatorName | Gets the originators name for the current AgreementHeader record. |
|
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.) |
|
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.) |
|
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 whether invoices, releases, and hisotry records assiciated with the current agreement exist. |
|
relatedTable | Sets or returns the related buffer of a link of a table buffer. (Inherited from xRecord.) |
|
removeAgreementReleaseHeaderMatch | Finds and deletes an instance of the AgreementReleaseHeaderMatch class that links an agreement header with a release order header. |
|
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.) |
|
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.) |
|
setCheckFailedTextAgreementState | Sets the check failed text for the agreement state field. |
|
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.) |
|
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.) |
|
showDocHandIcon | Gets the document handling icon for the current SalesAgreementHeader record. |
|
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 agreement as deleted. |
|
suppressWarnings | Gets and sets the property that indicates whether to suppress warnings for this pointer. (Inherited from xRecord.) |
|
syncField | Synchronizes a field value from this AgreementHeader record to another AgreementHeader record. |
|
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.) |
|
update | Updates the current record. (Inherited from xRecord.) |
|
updateLinesDefaultDimension | Changes DimensionDefault used by AgreementHeaderand updates all AgreementLine financial dimensions. |
|
usageCount | Retrieves the current number of references (the value of the reference counter) that the object has. (Inherited from xRecord.) |
|
useExistingTempDBTable | (Inherited from xRecord.) |
|
validateDelete | Validates that the agreement can be deleted. |
|
validateDeleteErrorMessage | |
|
validateField | Validates the changes to a field in the AgreementHeader record. |
|
validateFieldValue | (Inherited from xRecord.) |
|
validateWrite | Determines whether the current record is valid and ready to be written. (Inherited from xRecord.) |
|
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.) |
.gif "Static member") |
::exist | Determines whether the specified record in the AgreementHeader table exists. |
|
::find | Finds the specified record in the AgreementHeader table. |
|
::logisticsLocationSelectionLookup | Looks up a LogisticsPostalAddress record. |
|
::partyAgreementsQuery | Gets a query for the effective party agreements for a certain customer. |
|
::posCanCreateIntercompanyAgreement | Retrieves the position of the release existence flag in the result container that was returned by the relatedObjectExistanceFlags method. |
|
::posCanCreateIntracompanyAgreement_RU | Retrieves the position of the release existence flag in the result container that was returned by the relatedObjectExistanceFlags method. |
|
::posCanDeleteAgreement | Retrieves the position of the history existence flag in the result container that was returned by the relatedObjectExistanceFlags method. |
|
::posCanReleaseAgreement | Retrieves the position of the release existence flag in a result container that was returned by the relatedObjectExistanceFlags method. |
|
::posCanViewNotSettled_RU | Retrieves the position of the history existence flag in a result container that was returned by the relatedObjectExistanceFlags method. |
|
::posCanViewRelatedAgreement | Retrieves the position of the history existence flag in a result container that was returned by the relatedObjectExistanceFlags method. |
|
::posCanViewRelatedAgreement_RU | Retrieves the position of the history existence flag in a result container that was returned by the relatedObjectExistanceFlags method. |
|
::posCanViewSettled_RU | Retrieves the position of the history existence flag in a result container that was returned by the relatedObjectExistanceFlags method. |
|
::posConfirmationsExist | Retrieves the position of the history existence flag in a result container that was returned by the relatedObjectExistanceFlags method. |
|
::posInvoicesExist | Retrieves the position of the invoice existence flag in a result container that was returned by the relatedObjectExistanceFlags method. |
|
::posReleasesExist | Retrieves the position of the release existence flag in a result container that was returned by the relatedObjectExistanceFlags method. |
|
::validatePeriod | Validates a period from effective date to expirations date. |
Top
Fields
| Field | Type | Configuration key | Description |
|---|---|---|---|
| AgreementClassification | Extended Data Type: RefRecId Type: Int64 |
None | Reference field in a different table |
| AgreementState | Enumeration: AgreementState |
TradeBlanketOrder | Agreement status |
| createdDateTime | Extended Data Type: CreatedDateTime Type: UtcDateTime |
None | |
| Currency | Extended Data Type: CurrencyCode Type: String |
None | Current currency code |
| DefaultAgreementLineEffectiveDate | Extended Data Type: EffectiveDate Type: Date |
None | The default effective date used when creating a new commitment on the agreement |
| DefaultAgreementLineExpirationDate | Extended Data Type: ExpirationDate Type: Date |
None | The default expiration date used when creating a new commitment on the agreement |
| DefaultAgreementLineType | Enumeration: CommitmentType |
None | Line type |
| DefaultDimension | Extended Data Type: DimensionDefault Type: Int64 |
LedgerBasic | Default dimensions (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3) |
| DocumentExternalReference | Extended Data Type: AgreementDocumentExternalReference Type: String |
TradeBlanketOrder | The external document reference associated with the agreement |
| DocumentTitle | Extended Data Type: AgreementDocumentTitle Type: String |
TradeBlanketOrder | Agreement document title |
| EarliestLineEffectiveDate | Extended Data Type: EarliestEffectiveDate Type: Date |
None | Earliest effective date calculated across agreement lines |
| InstanceRelationType | Extended Data Type: RelationType Type: Int64 |
None | Immediate derived table in table inheritance. |
| IsDeleted | Enumeration: NoYes |
None | |
| Language | Extended Data Type: LanguageId Type: String |
None | Select the language for the current text. |
| LatestLineExpirationDate | Extended Data Type: LatestExpirationDate Type: Date |
None | Latest expiration date calculated across agreement lines |
| modifiedBy | Extended Data Type: ModifiedBy Type: String |
None | |
| modifiedDateTime | Extended Data Type: ModifiedDateTime Type: UtcDateTime |
None | |
| Originator | Extended Data Type: RefRecId Type: Int64 |
None | Reference field in a different table |
| 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)) |
| 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 |
|---|---|
| AutoIdentification | |
| AgreementLineDefaultingPolicy | |
| Details | |
| Dimension | |
| Status | |
| Currency | |
| AutoReport | |
| ValidityPeriod |
Top
Relations
| Relation | Table | Lines |
|---|---|---|
| AgreementClassification | AgreementClassification | |
| Currency | Currency | |
| DefaultDimension | DimensionAttributeValueSet | |
| LanguageTable | LanguageTable | |
| Originator | DirPerson | |
| Partition | Partitions |
Top
Indexes
| Index | AllowDuplicates | Enabled | Fields |
|---|---|---|---|
| AgreementClassificationIdx | Yes | Yes | |
| CurrencyIdx | Yes | Yes | |
| OriginatorIdx | Yes | Yes | |
| RecId | No | Yes |
Top
Inheritance Hierarchy
xRecord Class
Common Table
AgreementHeader Table
PurchAgreementHeader Table
SalesAgreementHeader Table