Carriage of Merchandise by Road in TransactionHeader(HMIMCarrOfMerchByRoad)

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	HMIMCarrOfMerchByRoad/(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 Carriage of Merchandise by Road	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		TransactionHeader/HMIMCarrOfMerchByRoad
ShipmentId		TransactionHeader/HMIMCarrOfMerchByRoad
CMRDocumentId		TransactionHeader/HMIMCarrOfMerchByRoad
PickupDate		TransactionHeader/HMIMCarrOfMerchByRoad
PickupName		TransactionHeader/HMIMCarrOfMerchByRoad
PickupLoc		TransactionHeader/HMIMCarrOfMerchByRoad
DropOffDate		TransactionHeader/HMIMCarrOfMerchByRoad
DropOffLoc		TransactionHeader/HMIMCarrOfMerchByRoad
DropOffName		TransactionHeader/HMIMCarrOfMerchByRoad
ConsignorInstruction		TransactionHeader/HMIMCarrOfMerchByRoad
CarrierCode		TransactionHeader/HMIMCarrOfMerchByRoad
CarrierName		TransactionHeader/HMIMCarrOfMerchByRoad
CarrierAddress		TransactionHeader/HMIMCarrOfMerchByRoad
SuccessiveCarrier		TransactionHeader/HMIMCarrOfMerchByRoad
CarrierObservation		TransactionHeader/HMIMCarrOfMerchByRoad
Documents		TransactionHeader/HMIMCarrOfMerchByRoad
SpecialAgreement		TransactionHeader/HMIMCarrOfMerchByRoad
Payment		TransactionHeader/HMIMCarrOfMerchByRoad
Particular		TransactionHeader/HMIMCarrOfMerchByRoad
COD		TransactionHeader/HMIMCarrOfMerchByRoad
CRMConvention		TransactionHeader/HMIMCarrOfMerchByRoad
ShippingLocation		TransactionHeader/HMIMCarrOfMerchByRoad
CompanyName		TransactionHeader/HMIMCarrOfMerchByRoad
CustAccount		TransactionHeader/HMIMCarrOfMerchByRoad
DeliveryPostalAddress		TransactionHeader/HMIMCarrOfMerchByRoad
ShippingPostalAddress		TransactionHeader/HMIMCarrOfMerchByRoad
DataAreaId		TransactionHeader/HMIMCarrOfMerchByRoad
Relationship_WHSShipmentTableRelationshipId		TransactionHeader/HMIMCarrOfMerchByRoad
Relationship_TMSCarrierRelationshipId		TransactionHeader/HMIMCarrOfMerchByRoad
Relationship_DeliveryLogisticsPostalAddressRelationshipId		TransactionHeader/HMIMCarrOfMerchByRoad
Relationship_ShippingLogisticsPostalAddressRelationshipId		TransactionHeader/HMIMCarrOfMerchByRoad
Relationship_CustTableRelationshipId		TransactionHeader/HMIMCarrOfMerchByRoad
Relationship_CompanyRelationshipId		TransactionHeader/HMIMCarrOfMerchByRoad

RecId

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

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

ShipmentId

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the ShipmentId attribute are listed below.

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

CMRDocumentId

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string

Traits

List of traits for the CMRDocumentId attribute are listed below.

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

PickupDate

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the PickupDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

PickupName

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

PickupLoc

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

DropOffDate

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the DropOffDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

DropOffLoc

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

DropOffName

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ConsignorInstruction

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CarrierCode

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CarrierName

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CarrierAddress

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true
isNullable	true

Traits

List of traits for the CarrierAddress attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

SuccessiveCarrier

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CarrierObservation

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Documents

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

SpecialAgreement

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Payment

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

Particular

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

COD

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CRMConvention

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ShippingLocation

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CompanyName

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CustAccount

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

DeliveryPostalAddress

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
displayName	Delivery address
dataFormat	int64
isNullable	true

Traits

List of traits for the DeliveryPostalAddress 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 Delivery address	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

ShippingPostalAddress

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
displayName	Ship from
dataFormat	int64
isNullable	true

Traits

List of traits for the ShippingPostalAddress 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 Ship from	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer
is.dataFormat.big

DataAreaId

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (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/HMIMCarrOfMerchByRoad (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_TMSCarrierRelationshipId

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSCarrierRelationshipId 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/Transportation/Main/TMSCarrier.cdm.json/TMSCarrier RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_DeliveryLogisticsPostalAddressRelationshipId

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_DeliveryLogisticsPostalAddressRelationshipId 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/Common/GAB/Main/LogisticsPostalAddress.cdm.json/LogisticsPostalAddress RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_ShippingLogisticsPostalAddressRelationshipId

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_ShippingLogisticsPostalAddressRelationshipId 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/Common/GAB/Main/LogisticsPostalAddress.cdm.json/LogisticsPostalAddress RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_CustTableRelationshipId

First included in: TransactionHeader/HMIMCarrOfMerchByRoad (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CustTableRelationshipId 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/Common/Customer/Main/CustTable.cdm.json/CustTable 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/HMIMCarrOfMerchByRoad (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