PayrollPayStatementBenefitLine Table
The PayrollPayStatementBenefitLine table holds the pay statement benefit lines
Configuration Key: Payroll
Methods
| Method | Description | |
|---|---|---|
.gif "Public method") |
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.) |
|
cancelTimeOut | Cancels a previous method call to the setTimeOut method. (Inherited from Object.) |
|
canSubmitToWorkflow | Indicates whether submission to workflow is possible. (Inherited from xRecord.) |
|
caption | Gets and sets the caption property of a table. (Inherited from xRecord.) |
|
checkInvalidFieldAccess | Gets and sets invalid field access. (Inherited from xRecord.) |
|
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.) |
|
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.) |
|
createProjectAccountingDistribution | Creates project accounting distributions. (Inherited from PayrollPayStatementLine.) |
|
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 current PayrollPayStatementBenefitLine record and adjusts the benefit limit remaining amount for the benefit, if applicable. |
|
disableCache | Gets and sets the property that indicates whether caching is disabled. (Inherited from xRecord.) |
|
displayBenefitPlanDescription | Displays the HcmBenefitPlan description that is associated with the HcmBenefit record. |
|
displayBudgetCheckResult | Gets the image position that displays the BudgetCheckResult value for the specified PayrollPayStatementLine record in the BudgetCheckResult values image list. (Inherited from PayrollPayStatementLine.) |
|
displayBudgetCheckResultText | Gets the text that represents the value of the budget check result for the PayrollPayStatementLine record. (Inherited from PayrollPayStatementLine.) |
|
displayIncludedInVendInvoiceImage | Indicates whether the pay statement line has been included in a vendor invoice. (Inherited from PayrollPayStatementLine.) |
|
displayVendorInvoice | Displays the vendor invoice ID from the transaction's invoice. (Inherited from PayrollPayStatementLine.) |
|
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.) |
|
getBudgetCheckResult | Calculates the BudgetCheckResult value for the specified PayrollPayStatementLine record. (Inherited from PayrollPayStatementLine.) |
|
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.) |
|
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.) |
|
initValue | Initializes a field to the default value. (Inherited from xRecord.) |
|
inputStatus | Sets or returns the current input status of the table buffer. (Inherited from xRecord.) |
|
insert | Inserts the PayrollPayStatementBenefitLine buffer into the table. |
|
interactiveContext | Sets or returns the current interactive context of the table buffer. (Inherited from xRecord.) |
|
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.) |
|
isLineLocked | Checks whether the line is locked. |
|
isNewRecord | Returns true if the record is a new record that hasn't been persisted yet. (Inherited from xRecord.) |
|
isPartOfUOWSaveChanges | (Inherited from xRecord.) |
|
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.) |
|
modifiedField | Modifies the specified field to the original. (Inherited from xRecord.) |
|
modifiedFieldValue | Modifies the specified field to the original value. (Inherited from xRecord.) |
|
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.) |
|
parmExchangeRateDate | Gets the exchange rate date that is used by the source document framework. (Inherited from PayrollPayStatementLine.) |
|
parmParentSourceDocumentLine | Gets the parent source document line. (Inherited from PayrollPayStatementLine.) |
|
parmSourceDocLineTypeEnumName | Gets the name of the source document line type enum. (Inherited from PayrollPayStatementLine.) |
|
parmSourceDocLineTypeEnumValue | Gets the value of the source document line type enum for a record. (Inherited from PayrollPayStatementLine.) |
|
parmSourceDocumentHeader | Gets the related source document header. (Inherited from PayrollPayStatementLine.) |
|
PayrollPayStatement | Looks up the related PayrollPayStatement table. (Inherited from PayrollPayStatementLine.) |
|
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.) |
|
relatedTable | Sets or returns the related buffer of a link of a table buffer. (Inherited from xRecord.) |
|
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.) |
|
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.) |
|
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.) |
|
statusIcon | Indicates the pay statement line status of the current record in the PayrollPayStatementLine table. (Inherited from PayrollPayStatementLine.) |
|
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.) |
|
update | Updates the current PayrollPayStatementBenefitLine record and adjusts the benefit limit remaining amount for the benefit, if applicable. |
|
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 | Determines whether the current record is valid and ready to be deleted from the database. (Inherited from xRecord.) |
|
validateField | Determines whether the specified field is valid. (Inherited from xRecord.) |
|
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") |
::canCreate | Determines whether it is safe to create a new PayrollPayStatementBenefitLine record on the current pay statement for the specified code. |
|
::checkExist | Checks whether a record ID exists in the PayrollPayStatementBenefitLine table and shows an Infolog message if the record does not exist. |
|
::create | Creates a new record and inserts it into the PayrollPayStatementBenefitLine table. |
|
::exist | Checks whether a record ID exists in the PayrollPayStatementBenefitLine table. |
|
::find | Finds a record in the PayrollPayStatementBenefitLine table, based on a record ID. |
|
::txtNotExist | Gets the message to use when a specific record in the PayrollPayStatementBenefitLine table does not exist. |
Top
Fields
| Field | Type | Configuration key | Description |
|---|---|---|---|
| AccountingCurrencyAmount | Extended Data Type: PayrollStatementAccountingCurrencyAmount Type: Real |
Payroll | The amount in the transaction currency (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| AccountingDate | Extended Data Type: AccountingDate Type: Date |
None | Transaction date (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| AccountingDistributionTemplate | Extended Data Type: AccountingDistributionTemplateRecId Type: Int64 |
LedgerBasic | Reference field in a different table (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| BaseTimeEarningBaseAmount | Extended Data Type: PayrollStatementAccountingCurrencyAmount Type: Real |
Payroll | The sum of the amount from the base time portion of the applicable earnings (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| BaseTimeEarningBaseHours | Extended Data Type: PayrollEarningQuantity Type: Real |
None | The sum of the hours from the base time portion of the applicable earnings (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| Benefit | Extended Data Type: HcmBenefitRecId Type: Int64 |
None | The benefit calculated for this pay statement line (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| createdBy | Extended Data Type: CreatedBy Type: String |
None | (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| createdDateTime | Extended Data Type: CreatedDateTime Type: UtcDateTime |
None | (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| dataAreaId | Extended Data Type: DataAreaId Type: String |
None | (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| InstanceRelationType | Extended Data Type: RelationType Type: Int64 |
None | Immediate derived table in table inheritance. (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| IsEmployer | Extended Data Type: NoYesId Type: Enum |
None | If this check box is selected, the pay statement line is an employer contribution (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| IsLineLocked | Extended Data Type: NoYesId Type: Enum |
None | When selected, pay statement lines using the selected tax code cannot be manually added or changed (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| IsMarkedForRemoval | Extended Data Type: NoYesId Type: Enum |
None | If this check box is selected, the line will be removed (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| IsPayStatementLineOverridden | Extended Data Type: NoYesId Type: Enum |
None | When selected, pay statement lines using the selected tax code cannot be manually added or changed (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| modifiedBy | Extended Data Type: ModifiedBy Type: String |
None | (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| modifiedDateTime | Extended Data Type: ModifiedDateTime Type: UtcDateTime |
None | (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| 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)) |
| PayStatement | Extended Data Type: PayrollPayStatementRecId Type: Int64 |
Payroll | Reference field in a different table (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| Position | Extended Data Type: HcmPositionRecId Type: Int64 |
None | Unique identification of position (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| PremiumEarningBaseAmount | Extended Data Type: PayrollStatementAccountingCurrencyAmount Type: Real |
Payroll | The sum of the amount from the premium time portion of the applicable earnings (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| PremiumEarningBaseHours | Extended Data Type: PayrollEarningQuantity Type: Real |
None | The sum of the hours from the premium time portion of the applicable earnings (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 | (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| recVersion | Extended Data Type: RecVersion Type: Integer |
None | (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| relationType | Extended Data Type: RelationType Type: Int64 |
None | (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| ReversedPayStatementLine | Extended Data Type: PayrollPayStatementLineRecId Type: Int64 |
Payroll | Reference field in a different table (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| Source | Enumeration: PayrollPayStatementLineSource |
Payroll | The document or process that the pay statement line originated from (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| SourceDocumentLine | Extended Data Type: SourceDocumentLineRecId Type: Int64 |
LedgerBasic | Reference field in a different table (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
| VendTrans | Extended Data Type: VendTransRefRecId Type: Int64 |
None | Reference field in a different table (This field applies only to the following version(s): Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2 (SYS)) |
Top
Field Groups
| Field Group | Fields |
|---|---|
| AutoReport |
Top
Relations
| Relation | Table | Lines |
|---|---|---|
| AccountingDistributionTemplate_FK | AccountingDistributionTemplate | |
| Benefit_FK | HcmBenefit | |
| dataAreaId | DataArea | |
| Partition | Partitions | |
| PayStatement_FK | PayrollPayStatement | |
| PayStatementLineBenefit_FK | PayrollPayStatementLine | |
| Position_FK | HcmPosition | |
| ReversedPayStatementLine_FK | PayrollPayStatementLine | |
| SourceDocumentLine_FK | SourceDocumentLine | |
| VendTrans | VendTrans | |
| VendTrans_FK | VendTrans |
Top
Indexes
| Index | AllowDuplicates | Enabled | Fields |
|---|---|---|---|
| BenefitIdx | Yes | Yes | |
| RecId | No | Yes |
Top
Inheritance Hierarchy
xRecord Class
Common Table
PayrollPayStatementLine Table
PayrollPayStatementBenefitLine Table