Pay statement earning lines in Payroll(PayrollPayStatementEarningLineInquiryEntity)

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

Traits

Traits for this entity are listed below.

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 earning lines	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
LineNum		Payroll/PayrollPayStatementEarningLineInquiryEntity
Worker		Payroll/PayrollPayStatementEarningLineInquiryEntity
PersonnelNumber		Payroll/PayrollPayStatementEarningLineInquiryEntity
PayStatementNumber		Payroll/PayrollPayStatementEarningLineInquiryEntity
PeriodEndDate		Payroll/PayrollPayStatementEarningLineInquiryEntity
PeriodStartDate		Payroll/PayrollPayStatementEarningLineInquiryEntity
PayCycleId		Payroll/PayrollPayStatementEarningLineInquiryEntity
AccountingDate		Payroll/PayrollPayStatementEarningLineInquiryEntity
EarningCode		Payroll/PayrollPayStatementEarningLineInquiryEntity
Description		Payroll/PayrollPayStatementEarningLineInquiryEntity
AccountingCurrencyAmount		Payroll/PayrollPayStatementEarningLineInquiryEntity
Quantity		Payroll/PayrollPayStatementEarningLineInquiryEntity
EarningRate		Payroll/PayrollPayStatementEarningLineInquiryEntity
PositionId		Payroll/PayrollPayStatementEarningLineInquiryEntity
TaxRegionDescription		Payroll/PayrollPayStatementEarningLineInquiryEntity
BenefitPlanIDGLI		Payroll/PayrollPayStatementEarningLineInquiryEntity
BenefitOptionIDGLI		Payroll/PayrollPayStatementEarningLineInquiryEntity
GeneralLiabilityInsurance		Payroll/PayrollPayStatementEarningLineInquiryEntity
BenefitPlanIDComp		Payroll/PayrollPayStatementEarningLineInquiryEntity
BenefitOptionIDComp		Payroll/PayrollPayStatementEarningLineInquiryEntity
WorkerCompensation		Payroll/PayrollPayStatementEarningLineInquiryEntity
Source		Payroll/PayrollPayStatementEarningLineInquiryEntity
Relationship_PayrollPayStatementHeaderEntityRelationshipId		Payroll/PayrollPayStatementEarningLineInquiryEntity
Relationship_HcmWorkerEntityRelationshipId		Payroll/PayrollPayStatementEarningLineInquiryEntity
BackingTable_PayrollPayStatementEarningLineRelationshipId		Payroll/PayrollPayStatementEarningLineInquiryEntity
Relationship_PrimaryCompanyContextRelationshipId		Payroll/PayrollPayStatementEarningLineInquiryEntity

LineNum

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the LineNum attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

Worker

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Worker attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

PersonnelNumber

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PersonnelNumber attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

PayStatementNumber

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PayStatementNumber attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

PeriodEndDate

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PeriodEndDate attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

PeriodStartDate

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PeriodStartDate attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

PayCycleId

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PayCycleId attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

AccountingDate

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AccountingDate attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

EarningCode

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EarningCode attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

Description

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Description attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

AccountingCurrencyAmount

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AccountingCurrencyAmount attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

Quantity

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Quantity attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

EarningRate

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the EarningRate attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

PositionId

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the PositionId attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

TaxRegionDescription

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
displayName	Tax region
dataFormat	string
isNullable	true

Traits

List of traits for the TaxRegionDescription attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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 Tax region	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

BenefitPlanIDGLI

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
displayName	@Payroll:GeneralLiabilityInsuranceBenefitPlanId
dataFormat	string
isNullable	true

Traits

List of traits for the BenefitPlanIDGLI attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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 @Payroll:GeneralLiabilityInsuranceBenefitPlanId	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

BenefitOptionIDGLI

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
displayName	@Payroll:GeneralLiabilityInsuranceBenefitOptionId
dataFormat	string
isNullable	true

Traits

List of traits for the BenefitOptionIDGLI attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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 @Payroll:GeneralLiabilityInsuranceBenefitOptionId	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

GeneralLiabilityInsurance

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
displayName	General liability insurance
dataFormat	string
isNullable	true

Traits

List of traits for the GeneralLiabilityInsurance attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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 General liability insurance	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

BenefitPlanIDComp

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
displayName	@Payroll:WorkerCompensationBenefitPlanId
dataFormat	string
isNullable	true

Traits

List of traits for the BenefitPlanIDComp attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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 @Payroll:WorkerCompensationBenefitPlanId	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

BenefitOptionIDComp

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
displayName	@Payroll:WorkerCompensationBenefitOptionId
dataFormat	string
isNullable	true

Traits

List of traits for the BenefitOptionIDComp attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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 @Payroll:WorkerCompensationBenefitOptionId	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

WorkerCompensation

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
displayName	Workers' compensation code
dataFormat	string
isNullable	true

Traits

List of traits for the WorkerCompensation attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
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 Workers' compensation code	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Source

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the Source attribute are listed below.

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

is.dataFormat.character
is.dataFormat.array

Relationship_PayrollPayStatementHeaderEntityRelationshipId

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_PayrollPayStatementHeaderEntityRelationshipId 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	empty table	entity	a reference to the constant entity holding the list of entity references

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

Relationship_HcmWorkerEntityRelationshipId

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_HcmWorkerEntityRelationshipId 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	empty table	entity	a reference to the constant entity holding the list of entity references

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

BackingTable_PayrollPayStatementEarningLineRelationshipId

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the BackingTable_PayrollPayStatementEarningLineRelationshipId 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/WorksheetLine/PayrollPayStatementEarningLine.cdm.json/PayrollPayStatementEarningLine RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_PrimaryCompanyContextRelationshipId

First included in: Payroll/PayrollPayStatementEarningLineInquiryEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_PrimaryCompanyContextRelationshipId 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