Sales Agreement Additional Fields in WorksheetHeader(TMSSalesAgreementHeader)

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	TMSSalesAgreementHeader/(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 Sales Agreement Additional Fields	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		WorksheetHeader/TMSSalesAgreementHeader
CarrierCode		WorksheetHeader/TMSSalesAgreementHeader
CarrierGroupCode		WorksheetHeader/TMSSalesAgreementHeader
CarrierServiceCode		WorksheetHeader/TMSSalesAgreementHeader
ModeCode		WorksheetHeader/TMSSalesAgreementHeader
RefRecId		WorksheetHeader/TMSSalesAgreementHeader
RouteConfigCode		WorksheetHeader/TMSSalesAgreementHeader
TransportationTemplateId		WorksheetHeader/TMSSalesAgreementHeader
DataAreaId		WorksheetHeader/TMSSalesAgreementHeader
Relationship_SalesAgreementHeaderRelationshipId		WorksheetHeader/TMSSalesAgreementHeader
Relationship_TMSCarrierRelationshipId		WorksheetHeader/TMSSalesAgreementHeader
Relationship_TMSCarrierGroupRelationshipId		WorksheetHeader/TMSSalesAgreementHeader
Relationship_TMSCarrierServiceRelationshipId		WorksheetHeader/TMSSalesAgreementHeader
Relationship_TMSModeRelationshipId		WorksheetHeader/TMSSalesAgreementHeader
Relationship_TMSRouteConfigRelationshipId		WorksheetHeader/TMSSalesAgreementHeader
Relationship_TMSTransportationTemplateRelationshipId		WorksheetHeader/TMSSalesAgreementHeader
Relationship_CompanyRelationshipId		WorksheetHeader/TMSSalesAgreementHeader

RecId

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

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

CarrierCode

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

CarrierGroupCode

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

CarrierServiceCode

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

ModeCode

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

RefRecId

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	int64

Traits

List of traits for the RefRecId attribute are listed below.

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

RouteConfigCode

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

TransportationTemplateId

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

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

DataAreaId

First included in: WorksheetHeader/TMSSalesAgreementHeader (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_SalesAgreementHeaderRelationshipId

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_SalesAgreementHeaderRelationshipId 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/SalesAndMarketing/WorksheetHeader/SalesAgreementHeader.cdm.json/SalesAgreementHeader 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: WorksheetHeader/TMSSalesAgreementHeader (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_TMSCarrierGroupRelationshipId

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_TMSCarrierServiceRelationshipId

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_TMSModeRelationshipId

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_TMSRouteConfigRelationshipId

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

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

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

Relationship_TMSTransportationTemplateRelationshipId

First included in: WorksheetHeader/TMSSalesAgreementHeader (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_TMSTransportationTemplateRelationshipId 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/TMSTransportationTemplate.cdm.json/TMSTransportationTemplate 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/TMSSalesAgreementHeader (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