Pay statement benefit lines in WorksheetLine(PayrollPayStatementBenefitLine)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	PayrollPayStatementBenefitLine/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Pay statement lines en Pay statement benefit lines	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		WorksheetLine/PayrollPayStatementBenefitLine
AccountingCurrencyAmount		WorksheetLine/PayrollPayStatementBenefitLine
AccountingDate		WorksheetLine/PayrollPayStatementBenefitLine
AccountingDistributionTemplate		WorksheetLine/PayrollPayStatementBenefitLine
InstanceRelationType		WorksheetLine/PayrollPayStatementBenefitLine
IsEmployer		WorksheetLine/PayrollPayStatementBenefitLine
IsLineLocked		WorksheetLine/PayrollPayStatementBenefitLine
IsMarkedForRemoval		WorksheetLine/PayrollPayStatementBenefitLine
IsPayStatementLineOverridden		WorksheetLine/PayrollPayStatementBenefitLine
PayStatement		WorksheetLine/PayrollPayStatementBenefitLine
Position		WorksheetLine/PayrollPayStatementBenefitLine
ReversedPayStatementLine		WorksheetLine/PayrollPayStatementBenefitLine
Source		WorksheetLine/PayrollPayStatementBenefitLine
SourceDocumentLine		WorksheetLine/PayrollPayStatementBenefitLine
VendTrans		WorksheetLine/PayrollPayStatementBenefitLine
LineNum		WorksheetLine/PayrollPayStatementBenefitLine
DataAreaId		WorksheetLine/PayrollPayStatementBenefitLine
Relationship_AccountingDistributionTemplate_FKRelationshipId		WorksheetLine/PayrollPayStatementBenefitLine
Relationship_PayStatement_FKRelationshipId		WorksheetLine/PayrollPayStatementBenefitLine
Relationship_SourceDocumentLine_FKRelationshipId		WorksheetLine/PayrollPayStatementBenefitLine
Relationship_VendTrans_FKRelationshipId		WorksheetLine/PayrollPayStatementBenefitLine
Relationship_CompanyRelationshipId		WorksheetLine/PayrollPayStatementBenefitLine
BaseTimeEarningBaseAmount		WorksheetLine/PayrollPayStatementBenefitLine
BaseTimeEarningBaseHours		WorksheetLine/PayrollPayStatementBenefitLine
Benefit		WorksheetLine/PayrollPayStatementBenefitLine
PremiumEarningBaseAmount		WorksheetLine/PayrollPayStatementBenefitLine
PremiumEarningBaseHours		WorksheetLine/PayrollPayStatementBenefitLine

RecId

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	PayrollPayStatementBenefitLine/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

AccountingCurrencyAmount

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	decimal

Traits

List of traits for the AccountingCurrencyAmount attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

AccountingDate

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	date

Traits

List of traits for the AccountingDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.dataFormat.date

AccountingDistributionTemplate

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Template ID
dataFormat	int64
isNullable	true

Traits

List of traits for the AccountingDistributionTemplate attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Template ID	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

InstanceRelationType

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	int64
isReadOnly	true
isNullable	true

Traits

List of traits for the InstanceRelationType attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

IsEmployer

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Employer contribution
dataFormat	int32
isNullable	true

Traits

List of traits for the IsEmployer attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Employer contribution	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsLineLocked

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Line locked
dataFormat	int32
isNullable	true

Traits

List of traits for the IsLineLocked attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Line locked	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsMarkedForRemoval

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Line to remove
dataFormat	int32
isNullable	true

Traits

List of traits for the IsMarkedForRemoval attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Line to remove	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsPayStatementLineOverridden

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Line locked
dataFormat	int32
isNullable	true

Traits

List of traits for the IsPayStatementLineOverridden attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Line locked	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

PayStatement

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the PayStatement attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big

Position

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	unknown
isNullable	true

Traits

List of traits for the Position attribute are listed below.

is.nullable
The attribute value may be set to NULL.

ReversedPayStatementLine

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	unknown
isNullable	true

Traits

List of traits for the ReversedPayStatementLine attribute are listed below.

is.nullable
The attribute value may be set to NULL.

Source

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the Source attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

SourceDocumentLine

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	int64
isReadOnly	true
isNullable	true

Traits

List of traits for the SourceDocumentLine attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

VendTrans

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	int64
isReadOnly	true
isNullable	true

Traits

List of traits for the VendTrans attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

LineNum

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	decimal
isNullable	true

Traits

List of traits for the LineNum attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

DataAreaId

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the DataAreaId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array

Relationship_AccountingDistributionTemplate_FKRelationshipId

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_AccountingDistributionTemplate_FKRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/AccountingFoundation/Group/AccountingDistributionTemplate.cdm.json/AccountingDistributionTemplate RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_PayStatement_FKRelationshipId

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_PayStatement_FKRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/HumanResources/Payroll/WorksheetHeader/PayrollPayStatement.cdm.json/PayrollPayStatement RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_SourceDocumentLine_FKRelationshipId

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_SourceDocumentLine_FKRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/AccountingFoundation/TransactionLine/SourceDocumentLine.cdm.json/SourceDocumentLine RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_VendTrans_FKRelationshipId

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_VendTrans_FKRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/AccountsPayable/Transaction/VendTrans.cdm.json/VendTrans RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_CompanyRelationshipId

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CompanyRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfo RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

BaseTimeEarningBaseAmount

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Base earning amount
dataFormat	decimal
isNullable	true

Traits

List of traits for the BaseTimeEarningBaseAmount attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Base earning amount	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

BaseTimeEarningBaseHours

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Base earning hours
dataFormat	decimal
isNullable	true

Traits

List of traits for the BaseTimeEarningBaseHours attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Base earning hours	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Benefit

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the Benefit attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.dataFormat.integer
is.dataFormat.big

PremiumEarningBaseAmount

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Premium earning amount
dataFormat	decimal
isNullable	true

Traits

List of traits for the PremiumEarningBaseAmount attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Premium earning amount	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

PremiumEarningBaseHours

First included in: WorksheetLine/PayrollPayStatementBenefitLine (this entity)

Properties

Name	Value
displayName	Premium earning hours
dataFormat	decimal
isNullable	true

Traits

List of traits for the PremiumEarningBaseHours attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Premium earning hours	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values