Worker postal addresses V2 in HRM(HcmWorkerPostalAddressV2Entity)

Artikkeli
02/22/2022

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	Worker postal addresses V2

entity

a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
PersonnelNumber		HRM/HcmWorkerPostalAddressV2Entity
FormattedAddress		HRM/HcmWorkerPostalAddressV2Entity
AttentionToAddressLine		HRM/HcmWorkerPostalAddressV2Entity
BuildingCompliment		HRM/HcmWorkerPostalAddressV2Entity
AddressApartment		HRM/HcmWorkerPostalAddressV2Entity
AddressBuilding		HRM/HcmWorkerPostalAddressV2Entity
AddressCity		HRM/HcmWorkerPostalAddressV2Entity
AddressCityInKana		HRM/HcmWorkerPostalAddressV2Entity
AddressCountryRegionId		HRM/HcmWorkerPostalAddressV2Entity
AddressCountryRegionISOCode		HRM/HcmWorkerPostalAddressV2Entity
AddressCountyId		HRM/HcmWorkerPostalAddressV2Entity
AddressDescription		HRM/HcmWorkerPostalAddressV2Entity
AddressDistrictName		HRM/HcmWorkerPostalAddressV2Entity
AddressLatitude		HRM/HcmWorkerPostalAddressV2Entity
AddressLocationId		HRM/HcmWorkerPostalAddressV2Entity
AddressLongitude		HRM/HcmWorkerPostalAddressV2Entity
AddressPostBox		HRM/HcmWorkerPostalAddressV2Entity
AddressState		HRM/HcmWorkerPostalAddressV2Entity
AddressStreet		HRM/HcmWorkerPostalAddressV2Entity
AddressStreetInKana		HRM/HcmWorkerPostalAddressV2Entity
AddressStreetNumber		HRM/HcmWorkerPostalAddressV2Entity
AddressTimeZone		HRM/HcmWorkerPostalAddressV2Entity
AddressZipCode		HRM/HcmWorkerPostalAddressV2Entity
AddressLocationRoles		HRM/HcmWorkerPostalAddressV2Entity
DunsNumber		HRM/HcmWorkerPostalAddressV2Entity
IsLocationOwner		HRM/HcmWorkerPostalAddressV2Entity
IsPostalAddress		HRM/HcmWorkerPostalAddressV2Entity
IsPrimary		HRM/HcmWorkerPostalAddressV2Entity
IsPrimaryTaxRegistration		HRM/HcmWorkerPostalAddressV2Entity
IsPrivate		HRM/HcmWorkerPostalAddressV2Entity
IsPrivatePostalAddress		HRM/HcmWorkerPostalAddressV2Entity
IsRoleBusiness		HRM/HcmWorkerPostalAddressV2Entity
IsRoleDelivery		HRM/HcmWorkerPostalAddressV2Entity
IsRoleHome		HRM/HcmWorkerPostalAddressV2Entity
IsRoleInvoice		HRM/HcmWorkerPostalAddressV2Entity
Effective		HRM/HcmWorkerPostalAddressV2Entity
Expiration		HRM/HcmWorkerPostalAddressV2Entity
Relationship_WorkerRelationshipId		HRM/HcmWorkerPostalAddressV2Entity
BackingTable_DirPartyLocationPostalAddressV2EntityRelationshipId		HRM/HcmWorkerPostalAddressV2Entity

PersonnelNumber

First included in: HRM/HcmWorkerPostalAddressV2Entity (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

FormattedAddress

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AttentionToAddressLine

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

BuildingCompliment

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressApartment

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressBuilding

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressCity

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressCityInKana

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressCountryRegionId

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressCountryRegionISOCode

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressCountyId

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressDescription

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressDistrictName

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressLatitude

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressLocationId

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressLongitude

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressPostBox

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressState

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressStreet

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressStreetInKana

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressStreetNumber

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressTimeZone

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressZipCode

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

AddressLocationRoles

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

DunsNumber

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsLocationOwner

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsPostalAddress

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsPrimary

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsPrimaryTaxRegistration

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsPrivate

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsPrivatePostalAddress

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsRoleBusiness

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsRoleDelivery

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsRoleHome

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

IsRoleInvoice

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Effective

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Expiration

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

First included in: HRM/HcmWorkerPostalAddressV2Entity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the BackingTable_DirPartyLocationPostalAddressV2EntityRelationshipId attribute are listed below.

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

Jaa

Worker postal addresses V2 in HRM(HcmWorkerPostalAddressV2Entity)

Traits

Attributes

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits

Properties

Traits