Shipper's declaration in TransactionHeader(HMIMShipperDeclaration)

Article
02/22/2022

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	HMIMShipperDeclaration/(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	Shipper's declaration

entity

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

Attributes

Name	Description	First Included in Instance
RecId		TransactionHeader/HMIMShipperDeclaration
ShipperName		TransactionHeader/HMIMShipperDeclaration
ShipperAddress		TransactionHeader/HMIMShipperDeclaration
ConsigneeName		TransactionHeader/HMIMShipperDeclaration
ConsigneeAddress		TransactionHeader/HMIMShipperDeclaration
AirWaybillNum		TransactionHeader/HMIMShipperDeclaration
ShipmentId		TransactionHeader/HMIMShipperDeclaration
Warning		TransactionHeader/HMIMShipperDeclaration
FooterMsg		TransactionHeader/HMIMShipperDeclaration
DataAreaId		TransactionHeader/HMIMShipperDeclaration
Relationship_WHSShipmentTableRelationshipId		TransactionHeader/HMIMShipperDeclaration
Relationship_CompanyRelationshipId		TransactionHeader/HMIMShipperDeclaration

RecId

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

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

ShipperName

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
displayName	Shipper
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

ShipperAddress

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
displayName	Shipper address
dataFormat	string
isNullable	true

Traits

List of traits for the ShipperAddress 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	Shipper address

entity

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

is.dataFormat.character
is.dataFormat.array

ConsigneeName

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
displayName	Consignee
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

ConsigneeAddress

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
displayName	Consignee address
dataFormat	string
isNullable	true

Traits

List of traits for the ConsigneeAddress 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	Consignee address

entity

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

is.dataFormat.character
is.dataFormat.array

AirWaybillNum

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AirWaybillNum 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: TransactionHeader/HMIMShipperDeclaration (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

Warning

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
displayName	WARNING
dataFormat	string
isNullable	true

Traits

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

entity

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

is.dataFormat.character
is.dataFormat.array

FooterMsg

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
displayName	Footer declaration
dataFormat	string
isNullable	true

Traits

List of traits for the FooterMsg 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	Footer declaration

entity

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

is.dataFormat.character
is.dataFormat.array

DataAreaId

First included in: TransactionHeader/HMIMShipperDeclaration (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_WHSShipmentTableRelationshipId

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

First included in: TransactionHeader/HMIMShipperDeclaration (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CompanyRelationshipId attribute are listed below.

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

Shipper's declaration in TransactionHeader(HMIMShipperDeclaration)

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

Feedback

Feedback

Additional resources