Inbound shipment header in WMS(WHSInboundShipmentHeaderEntity)

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 Inbound shipment header	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
DeliveryTermsCode		WMS/WHSInboundShipmentHeaderEntity
ShipmentId		WMS/WHSInboundShipmentHeaderEntity
VendorShipmentId		WMS/WHSInboundShipmentHeaderEntity
VendorAddressCountryRegionId		WMS/WHSInboundShipmentHeaderEntity
VendorAddressStreet		WMS/WHSInboundShipmentHeaderEntity
VendorAddressStreetInKana		WMS/WHSInboundShipmentHeaderEntity
VendorAddressStateId		WMS/WHSInboundShipmentHeaderEntity
VendorAddressCountyId		WMS/WHSInboundShipmentHeaderEntity
VendorAddressCity		WMS/WHSInboundShipmentHeaderEntity
VendorAddressCityInKana		WMS/WHSInboundShipmentHeaderEntity
VendorAddressZipCode		WMS/WHSInboundShipmentHeaderEntity
InboundLoadId		WMS/WHSInboundShipmentHeaderEntity
Relationship_WHSInboundLoadHeaderEntityRelationshipId		WMS/WHSInboundShipmentHeaderEntity
BackingTable_WHSShipmentTableRelationshipId		WMS/WHSInboundShipmentHeaderEntity
Relationship_PrimaryCompanyContextRelationshipId		WMS/WHSInboundShipmentHeaderEntity

DeliveryTermsCode

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ShipmentId

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorShipmentId

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorAddressCountryRegionId

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorAddressStreet

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorAddressStreetInKana

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorAddressStateId

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorAddressCountyId

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorAddressCity

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorAddressCityInKana

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

VendorAddressZipCode

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

InboundLoadId

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

First included in: WMS/WHSInboundShipmentHeaderEntity (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the BackingTable_WHSShipmentTableRelationshipId 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/SupplyChain/Inventory/WorksheetHeader/WHSShipmentTable.cdm.json/WHSShipmentTable 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: WMS/WHSInboundShipmentHeaderEntity (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