Pay statements in WorksheetHeader(PayrollPayStatement)

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	PayrollPayStatement/(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 statements	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		WorksheetHeader/PayrollPayStatement
BatchNumber		WorksheetHeader/PayrollPayStatement
DocumentNumber		WorksheetHeader/PayrollPayStatement
GrossAccountingCurrencyAmount		WorksheetHeader/PayrollPayStatement
IsReversed		WorksheetHeader/PayrollPayStatement
NetAccountingCurrencyAmount		WorksheetHeader/PayrollPayStatement
PaymentDate		WorksheetHeader/PayrollPayStatement
PaymentJournalBatchNum		WorksheetHeader/PayrollPayStatement
PaymentMethodType		WorksheetHeader/PayrollPayStatement
PaymentStatus		WorksheetHeader/PayrollPayStatement
PaymentType		WorksheetHeader/PayrollPayStatement
PayPeriod		WorksheetHeader/PayrollPayStatement
PostedStatus		WorksheetHeader/PayrollPayStatement
ReversedPayStatement		WorksheetHeader/PayrollPayStatement
SourceDocumentHeader		WorksheetHeader/PayrollPayStatement
VendTrans		WorksheetHeader/PayrollPayStatement
Worker		WorksheetHeader/PayrollPayStatement
CreationType		WorksheetHeader/PayrollPayStatement
DisableAccounting		WorksheetHeader/PayrollPayStatement
DataAreaId		WorksheetHeader/PayrollPayStatement
Relationship_LedgerJournalTableRelationshipId		WorksheetHeader/PayrollPayStatement
Relationship_SourceDocumentHeader_FKRelationshipId		WorksheetHeader/PayrollPayStatement
Relationship_VendInvoicePostedRelationshipId		WorksheetHeader/PayrollPayStatement
Relationship_CompanyRelationshipId		WorksheetHeader/PayrollPayStatement

RecId

First included in: WorksheetHeader/PayrollPayStatement (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	PayrollPayStatement/(resolvedAttributes)/RecId	attribute

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

BatchNumber

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the BatchNumber attribute are listed below.

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

DocumentNumber

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the DocumentNumber attribute are listed below.

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

GrossAccountingCurrencyAmount

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
displayName	Gross pay
dataFormat	decimal
isNullable	true

Traits

List of traits for the GrossAccountingCurrencyAmount 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 Gross pay	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

IsReversed

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
displayName	Pay statement reversed
dataFormat	int32
isNullable	true

Traits

List of traits for the IsReversed 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 Pay statement reversed	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

NetAccountingCurrencyAmount

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
displayName	Net pay
dataFormat	decimal
isNullable	true

Traits

List of traits for the NetAccountingCurrencyAmount 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 Net pay	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

PaymentDate

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	date

Traits

List of traits for the PaymentDate attribute are listed below.

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

PaymentJournalBatchNum

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
displayName	Payment journal
dataFormat	string
isNullable	true

Traits

List of traits for the PaymentJournalBatchNum 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 Payment journal	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

PaymentMethodType

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the PaymentMethodType attribute are listed below.

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

is.dataFormat.integer

PaymentStatus

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the PaymentStatus attribute are listed below.

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

is.dataFormat.integer

PaymentType

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the PaymentType attribute are listed below.

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

is.dataFormat.integer

PayPeriod

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the PayPeriod attribute are listed below.

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

PostedStatus

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the PostedStatus attribute are listed below.

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

is.dataFormat.integer

ReversedPayStatement

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
displayName	Reversed pay statement
dataFormat	int64
isNullable	true

Traits

List of traits for the ReversedPayStatement 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 Reversed pay statement	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

SourceDocumentHeader

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	int64
isReadOnly	true
isNullable	true

Traits

List of traits for the SourceDocumentHeader 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: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
displayName	Payment invoice
dataFormat	int64
isNullable	true

Traits

List of traits for the VendTrans 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 Payment invoice	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

Worker

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the Worker attribute are listed below.

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

CreationType

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the CreationType attribute are listed below.

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

is.dataFormat.integer

DisableAccounting

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
displayName	Disable accounting
dataFormat	int32
isNullable	true

Traits

List of traits for the DisableAccounting 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 Disable accounting	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DataAreaId

First included in: WorksheetHeader/PayrollPayStatement (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_LedgerJournalTableRelationshipId

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_SourceDocumentHeader_FKRelationshipId

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_VendInvoicePostedRelationshipId

First included in: WorksheetHeader/PayrollPayStatement (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_VendInvoicePostedRelationshipId 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: WorksheetHeader/PayrollPayStatement (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