Payroll parameter in Parameter(PayrollParameters)

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

ParameterValueData typeExplanation
attributePayrollParameters/(resolvedAttributes)/RecIdattribute

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"1.1"stringsemantic version number of the entity

is.application.releaseVersion

ParameterValueData typeExplanation
releaseVersion"10.0.13.0"stringsemantic version number of the application introducing this entity

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPayroll parameter
entitya reference to the constant entity holding the list of localized text

Attributes

Name Description First Included in Instance
RecId Parameter/PayrollParameters
AccrualDateBasis Parameter/PayrollParameters
AllowRetirementLimitOverride Parameter/PayrollParameters
ApplyRetirementAnnualWageLimit Parameter/PayrollParameters
ArrearThresholdOverride Parameter/PayrollParameters
EarningAccountingDate Parameter/PayrollParameters
ElectronicPaymMode Parameter/PayrollParameters
EnableLogging Parameter/PayrollParameters
Key Parameter/PayrollParameters
PaymentJournalName Parameter/PayrollParameters
PaymentTaskGroupingCount Parameter/PayrollParameters
PaymMode Parameter/PayrollParameters
PaySlipContributions Parameter/PayrollParameters
ProcurementCategory Parameter/PayrollParameters
RecoverArrearInAllRunTypes Parameter/PayrollParameters
SalaryClearingAccountLedgerDimension Parameter/PayrollParameters
VendorAccountNum Parameter/PayrollParameters
EnableElectronicPaymentNumber Parameter/PayrollParameters
DataAreaId Parameter/PayrollParameters
Relationship_EcoResCategoryRelationshipId Parameter/PayrollParameters
Relationship_LedgerDimension_FKRelationshipId Parameter/PayrollParameters
Relationship_LedgerJournalNameRelationshipId Parameter/PayrollParameters
Relationship_VendPaymModeTableRelationshipId Parameter/PayrollParameters
Relationship_VendPaymModeTable_ElectronicRelationshipId Parameter/PayrollParameters
Relationship_VendTableRelationshipId Parameter/PayrollParameters
Relationship_CompanyRelationshipId Parameter/PayrollParameters

RecId

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
isPrimaryKeytrue
dataFormatint64
isReadOnlytrue

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

ParameterValueData typeExplanation
attributePayrollParameters/(resolvedAttributes)/RecIdattribute

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

AccrualDateBasis

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatint32
isNullabletrue

Traits

List of traits for the AccrualDateBasis attribute are listed below.

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

is.dataFormat.integer

AllowRetirementLimitOverride

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameAllow retirement limit override
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAllow retirement limit override
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

ApplyRetirementAnnualWageLimit

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameApply annual retirement wage limit
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enApply annual retirement wage limit
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

ArrearThresholdOverride

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameArrear threshold
dataFormatdecimal
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enArrear threshold
entitya 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

EarningAccountingDate

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameAccounting date options for earnings
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAccounting date options for earnings
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

ElectronicPaymMode

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameElectronic method of payment
dataFormatstring
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enElectronic method of payment
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

EnableLogging

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameEnable logging
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEnable logging
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

Key

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatint32
isReadOnlytrue
isNullabletrue

Traits

List of traits for the Key attribute are listed below.

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

is.dataFormat.integer

PaymentJournalName

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNamePayment journal name
dataFormatstring
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPayment journal name
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

PaymentTaskGroupingCount

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameBatch bundle size
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBatch bundle size
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

PaymMode

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameCheck method of payment
dataFormatstring
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCheck method of payment
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

PaySlipContributions

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNamePrint employer contributions
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPrint employer contributions
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

ProcurementCategory

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameProcurement category
dataFormatint64
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enProcurement category
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

RecoverArrearInAllRunTypes

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameRecover in all payment run types
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRecover in all payment run types
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

SalaryClearingAccountLedgerDimension

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNamePayroll clearing account
dataFormatint64
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enPayroll clearing account
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

VendorAccountNum

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameVendor account for worker payments
dataFormatstring
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enVendor account for worker payments
entitya reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

EnableElectronicPaymentNumber

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
displayNameEnable electronic payment number
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enEnable electronic payment number
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

DataAreaId

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatstring
isReadOnlytrue

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_EcoResCategoryRelationshipId

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatguid

Traits

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

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/SupplyChain/ProductInformationManagement/Main/EcoResCategory.cdm.json/EcoResCategoryRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_LedgerDimension_FKRelationshipId

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatguid

Traits

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

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/FinancialDimensions/Main/DimensionAttributeValueCombination.cdm.json/DimensionAttributeValueCombinationRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_LedgerJournalNameRelationshipId

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatguid

Traits

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

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/AccountingFoundation/Group/LedgerJournalName.cdm.json/LedgerJournalNameRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_VendPaymModeTableRelationshipId

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatguid

Traits

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

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/Bank/Group/VendPaymModeTable.cdm.json/VendPaymModeTableRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_VendPaymModeTable_ElectronicRelationshipId

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatguid

Traits

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

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/Bank/Group/VendPaymModeTable.cdm.json/VendPaymModeTableRecId
entitya reference to the constant entity holding the list of entity references

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

Relationship_VendTableRelationshipId

First included in: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatguid

Traits

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

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/SupplyChain/Vendor/Main/VendTable.cdm.json/VendTableRecId
entitya 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: Parameter/PayrollParameters (this entity)

Properties

NameValue
dataFormatguid

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
/core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfoRecId
entitya reference to the constant entity holding the list of entity references

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