details of an individual, a group or a body having a role in a business function
000001
a standard identification of an entity doing business as assigned by a standards agency.
Party. Identifier
PartyID
Party
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
defines whether any data is language dependent or not
Party. LanguageDependency. Indicator
LanguageDependent
Party
LanguageDependency
Indicator
Indicator
IndicatorType
0..1
Basic
International
used to provide information about the language which text relating to this party is written in
Party. Language. Details
Party
Language
Details
Language
LanguageType
0..1
Aggregate
International
contains the name of an entity
Party. Name
Name1
Party
Name
Name
Text
TextType
1..1
Basic
contain additional names for the entity
Party. Additional. Name
Name2, Name3
Party
Additional
Name
Name
Text
TextType
0..n
Basic
Party. Address. Details
NameAddress
Party
Address
Details
Address
AddressType
0..1
Aggregate
the means for contacting a person or department responsible for receiving of goods or services.
Party. Receiving Contact. Details
ReceivingContact
Party
Receiving
Contact
Details
Contact
ContactType
0..1
Aggregate
contains the means for contacting a person or department responsible for transporting goods
Party. Shipping Contact. Details
ShippingContac
Party
Shipping
Contact
Details
Contact
ContactType
0..1
Aggregate
contains the means for contacting a person or department responsible for managing orders
Party. Ordering Contact. Details
OrderContact
Party
Ordering
Contact
Details
Contact
ContactType
0..1
Aggregate
contains the means for contacting a person or department for other aspects of the Party
Party. Contact. Details
OtherContacts
Party
Contact
Details
Contact
ContactType
0..1
Aggregate
describes the taxing information for the buying party.
Party. Tax. Details
Buyer/SellerTaxInformation
Party
Tax
Details
TaxScheme
TaxSchemeType
0..1
Aggregate
used to provide information about the language which text is written in
identifies the language using ISO standards
Language. Identification. Code
LanguageCode
Language
Identification
Code
Code
CodeType
1..1
Basic
ISO 639-1998
the common name of the language
Language. Name
Language
Name
Name
Text
TextType
0..1
Basic
identifies the locale/location where the language is spoken.
Language. Locale. Code
LocaleCode
Language
Locale
Code
Code
CodeType
0..1
Basic
enumerated list in xCBL
the address information for an entity
CC defintions is specific to postal, this element covers any addressing form. We should utlize the OASIS CIQ structures if possible.
a globaly unique value that is used for referencing the address when specifying specific user information ( unique within partner organization)
Address. Identifier
ExternalAddressID
Address
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
Address. House. Name
Address
House
Name
Text
TextType
0..1
Basic
the house number or description that identifies the location of a building on a street
Address. House. Identifier
HouseNumber
Address
House
Identifier
Identifier
IdentifierType
0..1
Basic
000026
a post office box number or a numbered post box in a post office assigned to a person or organization where letters for them are kept until called for
Address. Postbox. Identifier
POBox
Address
Postbox
Identifier
Identifier
IdentifierType
0..1
Basic
maybe this may be better expressed as a coded identifier
000033
contains the name of the street.
Address. Street. Name
Street
Address
Street
Name
Text
TextType
0..1
Basic
any additional information to identify the street.
Address. Additional Street. Text
StreetSupplement1, StreetSupplement2
Address
Additional
Street
Text
Text
TextType
0..1
Basic
We have combined the two xCBL elements
the name of the building or house
Address. Building. Identifier
Building
Address
Building
Identifier
Identifier
IdentifierType
0..1
Basic
000035
the room identifier or the identification of a suite or apartment
Address. Room. Identifier
RoomNumber
Address
Room
Identifier
Identifier
IdentifierType
0..1
Basic
considered synonomous with CC suite.identifier (000036)
000036
the inhouse mail identifier
Address. InhouseMail. Identifier
InhouseMail
Address
InhouseMail
Identifier
Identifier
IdentifierType
0..1
Basic
the department number or name
Address. Department. Name
Department
Address
Department
Name
Text
TextType
0..1
Basic
the identifier for one or more properties according to the postal service of that country.(Zip-Code in US) or a group of letters and/or numbers which are added to the postal address to assist in the sorting of mail
Address. PostalZone. Identifier
PostalCode
Address
PostalZone
Identifier
Identifier
IdentifierType
0..1
Basic
this could be viewed as another code set
000031
the name of the county or a territorial division of some countries, forming the chief unit of local administration
Address. CountrySub-entity. Name
County
Address
CountrySub-entity
Name
Text
TextType
0..1
Basic
000043
the code identifiying the county or a territorial division of some countries, forming the chief unit of local administration
Address. CountrySub-entity. Code
Address
CountrySub-entity
Code
Code
CodeType
0..1
Basic
derived from ISO 3166/1998 (Country code subdivision code, UN/LOCODE 2000) or country defined list
we use the CC 'location.identification.code' (000061) as equivalent to this code
000061
the name of a region
Address. Region. Name
RegionCode
Address
Region
Name
Text
TextType
0..1
Basic
000061
the name of the district or a part of a town or region
Address. District. Name
DistrictName
Address
District
Name
Text
TextType
0..1
Basic
000028
the name or number of the floor
Address. Floor. Identifier
Floor
Address
Floor
Identifier
Identifier
IdentifierType
0..1
Basic
the name of the city or a built up area with a name, defined boundaries and a local government
Address. City. Name
City
Address
City
Name
Text
TextType
0..1
Basic
known as 'town.name' in CC (000029)
000029
the category or type of the address. for example, a business or home address. Not the Role of the address
Address. Category. Identifier
AddressTypeCode
Address
Category
Identifier
Identifier
IdentifierType
0..1
Basic
EDIFACT 3035 (Party Function Code Qualifier)
000024
a country or a nation with its own government expressed as an ISO standard code
Address. Country Identification. Code
CountryCode
Address
Country
Identification
Code
Code
CodeType
0..1
Basic
ISO 3166-1997
the CC defintion defines 'country' not 'countrycode'
000032
the value of the timezone. This is an offset from Greenwich Mean Time.
Address. TimeZoneOffset. Measure
TimeZone
Address
TimeZoneOffset
Measure
Measure
MeasureType
0..1
Basic
the xCBL enumerated list appears to hold 'times' offset from GMT. it is not the 'timezone' code
contains the means for contacting a person or department.
identifies the department or employee name
Contact. Name
ContactName
Contact
Name
Name
Text
TextType
1..1
Basic
holds the identifier of the department or employee
Contact. Identifier
ContactID
Contact
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
the channel and value of a communication point for the Contact
Contact. Communication. Details
ContactNumber
Contact
Communication
Details
Communication
CommunicationType
0..n
Aggregate
000050
the channel and value of a communication point or the information for one communication number or virtual address
000050
the value of the communication point or the number or virtual address of communication
Communication. Value. Text
ContactNumberValue
Communication
Value
Text
Text
TextType
1..1
Basic
this is a good example of name refinement
000055
identifies the channel of communication or the way or manner in which the communication is made using a standard code set
Communication. Channel. Identifier
ContactNumberTypeCode
Communication
Channel
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 3155 (Communication number code qualifier) and X12 365 (Communication number qualifier)
the code teels us what the numbervalue represents (ie it qualifies it)
000052
identifies a place by its function and either an identifier, an identification assigned to an address, or an address
contains the location identifier
Location. Identifier
LocationIdentifier
Location
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
Cannot show the exclusivity for LocationId/ExternalAddressId/NameaddressDetails
contains the name of an entity
Location. Name
Name1
Location
Name
Name
Text
TextType
1..1
Basic
contain additional names for the entity
Location. AdditionalName. Text
Name2, Name3
Location
AdditionalName
Text
Text
TextType
0..n
Basic
Location. Address. Details
NameAddress
Location
Address
Details
Address
AddressType
0..1
Aggregate
identifies the location by specific co-ordinates
Location. Coordinates. Details
GPSCooridinates
Location
Coordinates
Details
Coordinates
CoordinatesType
0..1
Aggregate
Details geographic co-ordinates
identifies the co-ordinate measuring system (eg. GPS)
Coordinates. System. Identifier
GPSSystem
Coordinates
System
Identifier
Identifier
IdentifierType
1..1
Basic
specifies the latitude of the location
Coordinates. Latitude. Measure
Latitude
Coordinates
Latitude
Measure
Measure
MeasureType
1..1
Basic
assume this is some kind of degree or radian. Is there a core component type for MeasureType?
specifies the longitude of the location.
Coordinates. Longitude. Measure
Longitude
Coordinates
Longitude
Measure
Measure
MeasureType
1..1
Basic
assume this is some kind of degree or radian. Is there a core component type for MeasureType?
Information pertaining to a stage of a shipment
a unique identifier for this stage of the shipment. Intended to be used as an internal reference for the document.
Shipment. Stage. Identifier
TransportID
Shipment
Stage
Identifier
Identifier
IdentifierType
1..1
Basic
specifies the method or type of transportation of this stage of the shipment. Typically this may be sea, air or road.
Shipment. TransportMode. Identifier
TransportMode
Shipment
TransportMode
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT Recommendation 19 (Mode of Transport) and X12 91 (Transportation Method/Type Code)
specifies the means of transportation for this stage of the shipment. Typically this may be by truck, sea- going vessel or aircraft.
Shipment. TransportMeans. Identifier
TransportMeans
Shipment
TransportMeans
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 8179(Transport Means Description Code) and X12 40 (Equipment Description Code)
the identifier assigned by the agency to the carrier. This identifies the carrier being used for this stage of the shipment.
Shipment. Carrier. Identifier
CarrierID
Shipment
Carrier
Identifier
Identifier
IdentifierType
0..1
Basic
provides a shipping contract reference to allow supplier to ship goods under specific freight conditions or the carrier to bill against a specific contract.
Shipment. Contract. Identifier
CustShippingContractNum
Shipment
Contract
Identifier
Identifier
IdentifierType
0..1
Basic
a code defining the level of service required.
Shipment. ServiceLevel. Identifier
ServiceLevelCoded
Shipment
ServiceLevel
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 4183 (Special condition code), 4219 (Transport priority coded), and 8335 (Movement type description code) and X12 284 (Service level code)
free form text for special shipping instructions.
Shipment. Instructions. Text
ShippingInstructions
Shipment
Instructions
Text
Text
TextType
0..1
Basic
identifies and describes the conatiner to be used for this stage of the shipment.
Shipment. TransportEquipment. Details
ListOfTransportEquipment
Shipment
TransportEquipment
Details
TransportEquipment
TransportEquipmentType
0..n
Aggregate
the transit direction for the shipment.
Shipment. Direction. Identifier
TransitDirectionCoded
Shipment
Direction
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 8101 (Transit direction indicator code) and X12 731 (Transit direction code)
the amount of transit time.
Shipment. Transit. Details
TransitTime
Shipment
Transit
Details
Period
PeriodType
0..1
Aggregate
any additonal text relating to the transport.
Shipment. Information. Text
TransportNote
Shipment
Information
Text
Text
TextType
0..1
Basic
identifies and describes the equipment used in the transportation of goods (e.g. the container)
This is a rationalization of the xCBL TransportEquipment
identifies the container for the purposes of referencing within the document domain.
Transport Equipment. Identifier
EquipmentID
Transport Equipment
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
identifies the type of provider for the container
Transport Equipment. ProviderType. Identifier
EquipmentProviderCoded
Transport Equipment
ProviderType
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 8077 (Equipment supplier code)
identifies the ownership relationship of the container
Transport Equipment. Ownership. Identifier
EquipmentOwnerCoded
Transport Equipment
Ownership
Identifier
Identifier
IdentifierType
0..1
Basic
derived from X12 102 (Ownership code)
the size and type of the container
Transport Equipment. SizeType. Code
EquipmentSizeTypeCoded
Transport Equipment
SizeType
Code
Code
CodeType
0..1
Basic
derived from EDIFACT 8155 (Equipment size and type description code) and X12 40 (Equipment description code)
these codes are incomplete
describes the current disposition of the container
Transport Equipment. Disposition. Identifier
EquipmentStatusCoded
Transport Equipment
Disposition
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 8249
describes whether the container already contains items.
Transport Equipment. Fullness Indicator. Code
FullIndicatorCoded
Transport Equipment
Fullness
Indicator
Code
Code
CodeType
0..1
Basic
derived from EDIFACT 8169 (Full/empty indicator, coded)
defines whether the refrigeration is on or off.
Transport Equipment. RefridgerationStatus. Indicator
RefrigerationOn
Transport Equipment
RefridgerationStatus
Indicator
Indicator
IndicatorType
0..1
Basic
holds free text information for the equipment.
Transport Equipment. Information. Text
EquipmentNote
Transport Equipment
Information
Text
Text
TextType
0..1
Basic
provides the information regarding the seals affixed to the container
Transport Equipment. Seal. Details
ListOfSealInfo
Transport Equipment
Seal
Details
Seal
SealType
0..n
Aggregate
lists measurement information on the container
Transport Equipment. Measurement. Details
ListOfEquipmentMeasurements
Transport Equipment
Measurement
Details
Measurement
MeasurementType
0..n
Aggregate
provides the information regarding the seals affixed to any equipment. (e.g. a container)
identifies the seal number of the equipment.
Seal. Identifier
SealNumber
Seal
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
provides information about the issuer of the seal for the equipment.
Seal. Issuer. Code
SealIssuer
Seal
Issuer
Code
Code
CodeType
0..1
Basic
derived from EDIFACT 9303 (Sealing party coded)
provides information on the status of the seal.
Seal. Information. Text
SealStatusDescription
Seal
Information
Text
Text
TextType
0..1
Basic
a quantitative physical characteristic.
Needed to add min/max to repeated occurrences of QuantityType
the value of the measurement
Measurement. Value. Measure
MeasurementValue
Measurement
Value
Measure
Measure
MeasureType
0..1
Basic
Should the Re-usable Type be text, this is simply a value and the following 4 elements give meaning to the value? that must use either the DimensionMeasure or the Min/Max range
the minimum value of the range
Measurement. Miminum. Measure
MinimumValue
Measurement
Miminum
Measure
Measure
MeasureType
0..1
Basic
the maximum value of the range
Measurement. Maximum. Measure
MaximumValue
Measurement
Maximum
Measure
Measure
MeasureType
0..1
Basic
defines the terms of delivery
indicates whether the terms relate to e.g. price conditions, delivery conditions, transport conditions, or a combination of these.
Delivery Terms. Basis. Identifier
TermsOfDeliveryFunctionCoded
Delivery Terms
Basis
Identifier
Identifier
IdentifierType
1..1
Basic
derived from EDIFACT 4055 (Delivery or transport terms function code)
the terms of delivery or transport.
Delivery Terms. Identifier
TransportTermsCoded
Delivery Terms
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
derived from INCOTERMS 1990
the method of payment for transport charges
Delivery Terms. PaymentMethod. Identifier
ShipmentMethodOfPaymentCoded
Delivery Terms
PaymentMethod
Identifier
Identifier
IdentifierType
1..1
Basic
derived from EDIFACT 4215 (Transport charges payment method code) and X12 146 (Shipment method of payment)
the location relevant to the terms of delivery specified.
Delivery Terms. Relevant Location. Details
Location
Delivery Terms
Relevant
Location
Details
Location
LocationType
0..1
Aggregate
the text description on special conditions or notes on the delivery.
Delivery Terms. SpecialTerms. Text
TermsOfDeliveryDescription
Delivery Terms
SpecialTerms
Text
Text
TextType
0..1
Basic
a description of transport.
Delivery Terms. TransportDescription. Text
TransportDescription
Delivery Terms
TransportDescription
Text
Text
TextType
0..1
Basic
example of the need for representation term = 'Description'
indicates the responsibility for risk of loss
Delivery Terms. RiskResponsibility. Identifier
RiskOfLossCoded
Delivery Terms
RiskResponsibility
Identifier
Identifier
IdentifierType
0..1
Basic
derived from X12 54 (Risk of loss qualifier)
a text description of the risk of loss information.
Delivery Terms. LossRisk. Text
RiskOfLossDescription
Delivery Terms
LossRisk
Text
Text
TextType
0..1
Basic
the pricing scheme
contains the value of the unit price.
Pricing. UnitPrice. Amount
UnitPriceValue
Pricing
UnitPrice
Amount
Amount
AmountType
1..1
Basic
contains a quantity and unit of measurement to which the unit price applies if that quantity is greater than. For example if a pricing scheme were $50/500 lbs, then 500 lbs would be contained in this element. This can also be used, when the UnitOfMeasurement element is one (1).
Pricing. Basis. Quantity
PriceBasisQuantity
Pricing
Basis
Quantity
Quantity
QuantityType
0..1
Basic
specifies the start and end date for the pricing if a range dates applies to the pricing scheme.
Pricing. Validity Period. Details
ValidityDates
Pricing
Validity
Period
Details
Period
PeriodType
0..1
Aggregate
contains a range of quantity over which the pricing information is applicable. This is commonly used for step pricing scenarios.
Pricing. Quantity
PriceQuantityRange
Pricing
Quantity
Quantity
Quantity
QuantityType
0..1
Basic
specifies the minimum quantity in a range
Pricing. Minimum. Quantity
MinimumValue
Pricing
Minimum
Quantity
Quantity
QuantityType
0..1
Basic
specifies the maximum quantity in a range
Pricing. Maximum. Quantity
MaximumValue
Pricing
Maximum
Quantity
Quantity
QuantityType
0..1
Basic
contains a code when the unit price is to be multiplied to arrive at the final price for an item. This can be used to apply a discount to a basic unit price.
Pricing. MultiplierReason. Identifier
PriceMultiplierCode
Pricing
MultiplierReason
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 5393 (Price Multiplier Qualifier) and X12 648 (Price Multiplier Qualifier)
contains a value by which the unit price is multiplied by to arrive at the final price for an item. For example, if the unit price is to be discounted by 10%, the value of the multiplier would be 0.9 .
Pricing. Multiplier. Value
Multiplier
Pricing
Multiplier
Value
Numeric
NumericType
0..1
Basic
details about one payment condition, such as discount eligibility.
contains details about one payment condition, such as discount eligibility.
Payment Terms. Identifier
PaymentTermCode
Payment Terms
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
derived from EDIFACT 4279 (Payment terms type code qulaifier) and X12 336 (Terms type code)
specifies the value that pertains to the payment terms.
Payment Terms. Amount
PaymentTermValue
Payment Terms
Amount
Amount
Amount
AmountType
0..1
Basic
used to communicate any discounts that may be associated with the payment term.
Payment Terms. Discount. Details
PaymentTermDetails
Payment Terms
Discount
Details
Discount
DiscountType
0..n
Aggregate
holds discount information
the percent discounted in the terms of the payment. If a discount percent is specified then DiscountAmount should not be used.
Discount. Percent
DiscountPercent
Discount
Percent
Percent
Numeric
NumericType
0..1
Basic
Cannot show rules that either DiscountAmount or DiscountPercent must be used.
the amount to be discounted from the payment value. If a discount amount is specified then DiscountPercent should not be used.
Discount. Amount
DiscountAmount
Discount
Amount
Amount
Amount
AmountType
0..1
Basic
the number of days which the amount has to be paid by in order to receive the discount.
Discount. PaymentDays. Value
DiscountDaysDue
Discount
PaymentDays
Value
Value
ValueType
0..1
Basic
example of need for representation term = "Days"
only used in the case where the discount appies to a payment term.
the date the amount has to paid by in order to receive the discount.
Discount. Payment. DateTime
DiscountDueDate
Discount
Payment
DateTime
DateTime
DateTimeType
0..1
Basic
only used in the case where the discount appies to a payment term.
the event on which the discount terms are based from using a standard codelist.
Discount. Event. Identifier
DiscountDateTimeRefCoded
Discount
Event
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 2475 (Payment time reference code) and X12 333 (Term basis date code)
this is supposed to be a point in time but in fact looks more like an event.
only used in the case where the discount appies to a payment term.
the number of days the amount has to be paid in full by.
Discount. Full PaymentDays. Value
NetDaysDue
Discount
Full
PaymentDays
Value
Value
ValueType
0..1
Basic
only used in the case where the discount appies to a payment term.
the specific date that the payment is due in full.
Discount. Full PaymentDue. Date
NetDueDate
Discount
Full
PaymentDue
Date
DateTime
DateTimeType
0..1
Basic
only used in the case where the discount appies to a payment term.
the event on which the net days due are based from using a standard codelist.
Discount. Full PaymentEvent. Identifier
NetDateTimeRefCoded
Discount
Full
PaymentEvent
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 2475 (Payment time reference code) and X12 333 (Term basis date code)
this is supposed to be a point in time but in fact looks more like an event.
only used in the case where the discount appies to a payment term.
the specific manner in which a payment is to be made.
a valid means of paying the debt.
Payment Means. Type. Code
PaymentMeanCoded
Payment Means
Type
Code
Code
CodeType
1..1
Basic
derived from EDIFACT 4461 (payment means code) and X12 107 (payment method code).
information relating to the specified payment means. For example, if the selected payment means were cheque, then PaymentMeansReference would be used to communicate the cheque number.
Payment Means. Payment. Identifier
PaymentMeanReference
Payment Means
Payment
Identifier
Identifier
IdentifierType
0..1
Basic
Payment Means. Payment. Date Time
RefDate
Payment Means
Payment
Date Time
DateTime
DateTimeType
0..1
Basic
the system through which the payment is processed using a standard codelist.
Payment Means. Payment. Channel
PaymentSystemCoded
Payment Means
Payment
Channel
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 4435 (Payment channel code).
information for the financial institution and associated account details from which the funds are originating (Payer's bank details).
Payment Means. Payer Account. Details
OriginatingFIAccount
Payment Means
Payer
Account
Details
Account
AccountType
0..1
Aggregate
information for the financial institution and associated account details to which the funds are being sent (Payee's bank details).
Payment Means. Payee Account. Details
ReceivingFIAccount
Payment Means
Payee
Account
Details
Account
AccountType
0..1
Aggregate
the credit or debit card that is being used for the payment.
Payment Means. CreditCard. Details
CardInfo
Payment Means
CreditCard
Details
CreditCard
CreditCardType
0..1
Aggregate
the account number or identifier for the account.
Account. Identifier
AccountID
Account
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
not needed if only the Financial Institution is used.
the financial institution by code.
Account. FinancialInstitution. Identifier
FinancialInstitutionID
Account
FinancialInstitution
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
the branch of the institution
Account. FinancialInstitution Branch. Name
FIBranchID
Account
FinancialInstitution
Branch
Name
Text
TextType
0..1
Basic
a secondary account number to identify the account.
Account. Secondary Account. Identifier
SecondaryAccountID
Account
Secondary
Account
Identifier
Identifier
IdentifierType
0..1
Basic
Needs more explanation of business function
the control number to uniquely identify the account at the financial institution.
Account. Control. Identifier
AccountControlKey
Account
Control
Identifier
Identifier
IdentifierType
0..1
Basic
a code qualifying the type of account.
Account. Type. Identifier
AccountTypeCoded
Account
Type
Identifier
Identifier
IdentifierType
1..1
Basic
derived from X12 569 (Account Number Qualifier)
the main account holder of the account.
Account. Account. Name
AccountName1
Account
Account
Name
Text
TextType
1..1
Basic
a secondary name on the account.
Account. Secondary Account. Name
AccountName2
Account
Secondary
Account
Name
Text
TextType
0..1
Basic
the currency that applies to the account.
Account. Currency Identification. Code
Currency
Account
Currency
Identification
Code
Code
CodeType
0..1
Basic
derived from ISO recommendation no.9
a list of coded references to specify an identifier or name associated with the account.
Account. InformationSource. Details
AccountReferences
Account
InformationSource
Details
InformationSource
InformationSourceType
0..n
Aggregate
the financial institution by code.
Financial Institution. Identifier
FinancialInstitutionID
Financial Institution
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
the name of the financial institution.
Financial Institution. Name
FinancialInstitutionName
Financial Institution
Name
Name
Text
TextType
0..1
Basic
the branches of this institution
Financial Institution. Branch. Details
FIBranchID
Financial Institution
Branch
Details
Branch
BranchType
0..n
Aggregate
the identification of the branch
Branch. Identifier
FIBranchID
Branch
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
the name of the branch
Branch. Name
FIBranchName
Branch
Name
Name
Text
TextType
0..1
Basic
the city where the branch is located.
Branch. City. Name
FIBranchCity
Branch
City
Name
Text
TextType
0..1
Basic
the country where the branch is based.
Branch. Country Identication. Code
FIBranchCountry
Branch
Country
Identication
Code
Code
CodeType
0..1
Basic
derived from ISO 3166-1997
identifies the source of the information using a standard codelist.
This code provides meaning to a reference. This code list is derived from EDIFACT 1153 (Reference function code qualifier) and X12 128 (Reference identification qualifier)
Information Source. ReferenceType. Code
ReferenceTypeCode
Information Source
ReferenceType
Code
Code
CodeType
1..1
Basic
the highest level of the associated instance to which the information source applies (e.g. this codeset applies to the entire Order)
Information Source. PrimaryLevel. Text
PrimaryReference
Information Source
PrimaryLevel
Text
Text
TextType
1..1
Basic
the secondary level of the associated instance to which the information source applies (e.g. this codeset applies to the entire Lineitem)
Information Source. SecondaryLevel. Text
SupportingReference
Information Source
SecondaryLevel
Text
Text
TextType
0..1
Basic
the lowest level of the associated instance to which the information source applies (e.g. this codeset applies to a specific sub-structure)
Information Source. LowestLevel. Text
SupportingSubReference
Information Source
LowestLevel
Text
Text
TextType
0..1
Basic
used to describe a reference using free form text
Information Source. Description. Text
ReferenceDescription
Information Source
Description
Text
Text
TextType
0..1
Basic
details of a credit or debit card
the identifying number of the credit or debit card.
Credit Card. Identifier
CardNum
Credit Card
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
the authorization number of the card.
Credit Card. Authorisation. Text
CardAuthCode
Credit Card
Authorisation
Text
Text
TextType
0..1
Basic
the customer reference number. This is used to enable transmission of customer specific information with the card.
Credit Card. Customer. Identifier
CardRefNum
Credit Card
Customer
Identifier
Identifier
IdentifierType
0..1
Basic
the date up to which the card is valid .
Credit Card. Expiry. Date Time
CardExpirationDate
Credit Card
Expiry
Date Time
DateTime
DateTimeType
0..1
Basic
the type of card used for payment
Credit Card. Issuer. Identifier
CardType
Credit Card
Issuer
Identifier
Identifier
IdentifierType
0..1
Basic
enumerated list in xCBL
the name of the holder of the card.
Credit Card. Holder. Name
CardHolderName
Credit Card
Holder
Name
Text
TextType
0..1
Basic
describes the tax information for a party.
TaxschemeId is the tax identifier or registration number of the party. The agency that allocated this identifier is dependent on the tax jurisdiction of the party. Can also be referred to as the tax exemption or certificate number.
Tax Scheme. Identifier
TaxIdentifier
Tax Scheme
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
RegistrationName is the name of the party as registered with the tax authority. This must be present if a) the tax regulations require it, and b) it is different from the Name element in the NameAddress element of the party.
Tax Scheme. Registration. Name
RegisteredName
Tax Scheme
Registration
Name
Text
TextType
0..1
Basic
RegistrationOffice is the registered office of the party. This must be present if a) the tax regulations require it, and b) it is different from the Address element in the NameAddress element of the party.
Tax Scheme. Registration Address. Details
RegisteredOffice
Tax Scheme
Registration
Address
Details
Address
AddressType
0..1
Aggregate
TaxLocation holds the tax location.
Tax Scheme. Tax Location. Details
TaxLocation
Tax Scheme
Tax
Location
Details
Location
LocationType
0..1
Aggregate
CompanyRegistrationNumber is the company registration number of the party. This must be present if tax regulations require it.
Tax Scheme. Company Tax. Identifier
CompanyRegistrationNumber
Tax Scheme
Company
Tax
Identifier
Identifier
IdentifierType
0..1
Basic
QuoteReferencesType refers to a Quote ID or ShoppingCart ID.
QuoteReferenceId is the reference characters which identify the Quote.
Quote. Identifier
RefNum
Quote
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
xCBL uses a generic reference component, we are using a context specific reference.
QuoteReferenceDatetime holds the date of the Quote.
Quote. Reference. Date Time
RefDate
Quote
Reference
Date Time
DateTime
DateTimeType
0..1
Basic
Provides the details of an agreement between trading partners.
ContractId is a unique identifier assigned to the contract.
Contract. Identifier
ContractID
Contract
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
None
ContractTypeCode identifies the type of contract.
Contract. Type. Code
ContractType
Contract
Type
Code
Code
CodeType
0..1
Basic
X12 1166
specifies the dates or duration for which the Contract is valid.
Contract. Validity. Details
ValidityDates
Contract
Validity
Details
Period
PeriodType
0..1
Aggregate
specifies the dates or duration for which an event is effective.
specifies the first point in time on which validity/effectivity occurs.
Period. Start. Date Time
StartDate
Period
Start
Date Time
DateTime
DateTimeType
0..1
Basic
ValidityperiodEndDate specifies the last point in time for which a validity/effectivity occurs.
Period. End. Date Time
EndDate
Period
End
Date Time
DateTime
DateTimeType
0..1
Basic
A duration of time expressed as a formal code. The Measure. Code inside the Measure. Type should be ISO 8601.
Period. Duration. Date Time
Period
Duration
Date Time
DateTime
DateTimeType
0..1
Basic
ISO 8601
A code that describes the significance of the dates or the duration.
Period. Description. Code
Period
Description
Code
Code
CodeType
0..n
Basic
xCBL DateTimeRefCode
Perhaps a business event sets this off, or triggers something to happen.
information that can be used to find further information elsewhere.
the reference characters which distinguish the source of information.
Request. Identifier
RefNum
Request
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
the date of the reference information.
Request. Reference. Date Time
RefDate
Request
Reference
Date Time
DateTime
DateTimeType
0..1
Basic
used if the exchange rate to another currency
the reference currency of the rate of exchange. The currency from which the exchange is being made (CC Definition)
Exchange Rate. ReferenceCurrency Identification. Code
ReferenceCurrency
Exchange Rate
ReferenceCurrency
Identification
Code
Code
CodeType
1..1
Basic
the target currency of the rate of exchange. This is the currency to which the exchange is being made. (CC Definition)
Exchange Rate. TargetCurrency Identification. Code
TargetCurrency
Exchange Rate
TargetCurrency
Identification
Code
Code
CodeType
1..1
Basic
the currency market from which the exchange rate is taken
Exchange Rate. Exchange Market. Identifier
Exchange Rate
Exchange
Market
Identifier
Identifier
IdentifierType
0..1
Basic
the value that the reference currency is to be multiplied by to convert it to the target currency. That is, the rate at which the currency exchange is calculated (CC Definition)
Exchange Rate. Exchange. Rate
RateOfExchange
Exchange Rate
Exchange
Rate
Rate
Numeric
NumericType
1..1
Basic
the rate of exchange given as target currency : reference currency.
Exchange Rate. Inverse. Rate
InverseRateOfExchange
Exchange Rate
Inverse
Rate
Rate
Numeric
NumericType
0..1
Basic
the date the rate of exchange was quoted.
Exchange Rate. Quote. Date Time
DateOfRateOfExchange
Exchange Rate
Quote
Date Time
DateTime
DateTimeType
0..1
Basic
a reference to identify rate of exchange request.
Exchange Rate. Request. Details
ListOfRateOfExchangeReference
Exchange Rate
Request
Details
Request
RequestType
0..n
Aggregate
identifies a service, promotion, allowance, or charge and specifies the amount or percentage for the service, promotion, allowance, or charge.
description of the reference or charge usinga codelist
Payment Variation. Service. Identifier
AllowanceOrChargeDescription
Payment Variation
Service
Identifier
Identifier
IdentifierType
1..1
Basic
derived from X12 1300 (Service, promotion, allowance or charge code)
description of the reference or charge using free text
Payment Variation. Service. Text
AllowanceOrChargeDescription
Payment Variation
Service
Text
Text
TextType
1..1
Basic
identifies whether an allowance or a charge applies using a standard codelist. Allowances are considered to be discounts.
Payment Variation. Condition. Identifier
IndicatorCoded
Payment Variation
Condition
Identifier
Identifier
IdentifierType
1..1
Basic
derived from EDIFACT 5463 (Allowance) and X12 248 (Allowance Or Charge Indicator)
the basis the allowance or charge is calculated using a standard codelist.
Payment Variation. Basis. Identifier
BasisCoded
Payment Variation
Basis
Identifier
Identifier
IdentifierType
0..1
Basic
enumerated list in xCBL
how the allowance or charge will be settled using a standard codelist.
Payment Variation. Settlement. Identifier
MethodOfHandlingCoded
Payment Variation
Settlement
Identifier
Identifier
IdentifierType
1..1
Basic
derived from X12 331 (Allowance or charge method of handling code)
the dates between which the allowance or charge takes effect.
Payment Variation. Validity. Details
ValidityDates
Payment Variation
Validity
Details
Period
PeriodType
0..1
Aggregate
a specific value of a quantity over which the allowance or charge applies.
Payment Variation. Quantity
QuantityValue
Payment Variation
Quantity
Quantity
Quantity
QuantityType
0..1
Basic
a minimum quantity over which the allowance or charge applies.
Payment Variation. Minimum. Quantity
MinimumValue
Payment Variation
Minimum
Quantity
Quantity
QuantityType
0..1
Basic
a maximum quantity over which the allowance or charge applies.
Payment Variation. Maximum. Quantity
MaximumValue
Payment Variation
Maximum
Quantity
Quantity
QuantityType
0..1
Basic
a number representing the monetary limit.
Payment Variation. Amount
MonetaryLimitValue
Payment Variation
Amount
Amount
Amount
AmountType
0..1
Basic
to specify whether the monetary limit value is a lower or upper limit.
Payment Variation. AmountLimit Level. Identifier
SignificanceCoded
Payment Variation
AmountLimit
Level
Identifier
Identifier
IdentifierType
0..1
Basic
a minimum amount over which the allowance or charge applies.
Payment Variation. Minimum Applicable. Amount
MinimumMonetaryValue
Payment Variation
Minimum
Applicable
Amount
Amount
AmountType
0..1
Basic
a maximum amount over which the allowance or charge applies.
Payment Variation. Maximum Applicable. Amount
MaximumMonetaryValue
Payment Variation
Maximum
Applicable
Amount
Amount
AmountType
0..1
Basic
the quantity where the calculation is based on quantity.
Payment Variation. Calculated. Quantity
Quantity
Payment Variation
Calculated
Quantity
Quantity
QuantityType
0..1
Basic
These could be another -reusable type/class. But included here for simplicity
the allowance or charge based on a percentage
Payment Variation. PercentCalculation. Details
PercentageAllowanceOrCharge
Payment Variation
PercentCalculation
Details
PercentCalculation
PercentCalculationType
0..1
Aggregate
the monetary amount of the allowance or charge when charged as a lump sum
Payment Variation. LumpSum. Amount
MonetaryValue
Payment Variation
LumpSum
Amount
Amount
AmountType
0..1
Basic
any tax levies on the allowance or charge if applicable.
Payment Variation. Tax. Details
Tax
Payment Variation
Tax
Details
Tax
TaxType
0..n
Aggregate
the calculations sequence is used when multiple allowances and/or charges are applicable. If various allowances and/or charges percentages, quantities, monetary amounts or rates are applicable to the same base price, then the calculation sequence indicator will always equal one. If the various allowances and/or charges are applied against a fluctuating price (constantly changing because of the application of other allowances and/or charges) then the sequence of calculation is indicated using this data element. Note that several allowances or charges may have the same sequence number, indicating they are applied to the same quantity.
Payment Variation. Sequence. Value
SeqNo
Payment Variation
Sequence
Value
Numeric
NumericType
1..1
Basic
details of a calculation based on quantity.
the quantity where the calculation is based on quantity.
Quantity Calculation. Quantity
Quantity
Quantity Calculation
Quantity
Quantity
Quantity
QuantityType
1..1
Basic
These could be another -reusable type/class. But included here for simplicity
the rate where the calculation is based on quantity.
Quantity Calculation. Rate
Rate
Quantity Calculation
Rate
Rate
Numeric
NumericType
1..1
Basic
These could be another -reusable type/class. But included here for simplicity
the allowance or charge where the calculation is based on quantity.
Quantity Calculation. Amount
QuantityMonetaryValue
Quantity Calculation
Amount
Amount
Amount
AmountType
0..1
Basic
These could be another -reusable type/class. But included here for simplicity
the allowance or charge where the calculation is based on quantity.
Quantity Calculation. ExchangeRate. Details
RateOfExchangeDetail
Quantity Calculation
ExchangeRate
Details
ExchangeRate
ExchangeRateType
0..1
Aggregate
These could be another -reusable type/class. But included here for simplicity
details of an amount calculated from a percentage
the percentage is calculated using a standard codelist.
Percent Calculation. Basis. Identifier
PercentQualifierCoded
Percent Calculation
Basis
Identifier
Identifier
IdentifierType
1..1
Basic
derived from X12 378 (Allowance or Charge Percent Qualifier)
the percentage value
Percent Calculation. Percent
Percent
Percent Calculation
Percent
Percent
Numeric
NumericType
1..1
Basic
the value of the percentage allowance or charge.
Percent Calculation. Amount
PercentageMonetaryValue
Percent Calculation
Amount
Amount
Amount
AmountType
1..1
Basic
the exchange rate to another currency needs to be set for the monetary value expressed.
Percent Calculation. ExchangeRate. Details
RateOfExchangeDetail
Percent Calculation
ExchangeRate
Details
ExchangeRate
ExchangeRateType
0..1
Aggregate
an amount when charged as a lump sum
needed to add exchange rate to AmountType
the value of the monetary amount.
Monetary Amount. Amount
MonetaryAmount
Monetary Amount
Amount
Amount
Amount
AmountType
1..1
Basic
used if the exchange rate to another currency needs to be set for the monetary value expressed.
Monetary Amount. ExchangeRate. Details
RateOfExchangeDetail
Monetary Amount
ExchangeRate
Details
ExchangeRate
ExchangeRateType
0..1
Aggregate
an amount when charged as a lump sum
the function of the Tax element, e.g. tax, customs duty.
Tax. Context. Code
TaxFunctionQualifierCoded
Tax
Context
Code
Code
CodeType
1..1
Basic
derived from EDIFACT 5283 (Duty or tax or fee function code qualifier)
the category of the tax and, by implication, the tax rate that applies. The actual percentage is dependent on the tax jurisdiction.
Tax. Rate Category. Code
TaxCategoryCoded
Tax
Rate
Category
Code
Code
CodeType
1..1
Basic
derived from EDIFACT 5305(Duty or tax or fee category code) and X12 441 (Tax exempt code)
explains why a TaxCategory is exempt.
Tax. Exempt Reason. Code
ReasonTaxExemptCoded
Tax
Exempt
Reason
Code
Code
CodeType
0..1
Basic
derived from X12 441 (Tax exempt code)
the type of the tax.
Tax. Type. Code
TaxTypeCoded
Tax
Type
Code
Code
CodeType
1..1
Basic
derived from EDIFACT 5153 (Duty or tax or fee type name code) and X12 963 (Tax type code)
the tax rate as a percentage.
Tax. Rate. Percent
TaxPercent
Tax
Rate
Percent
Numeric
NumericType
0..1
Basic
the method by which the tax will be paid.
Tax. PaymentMeans. Details
TaxPaymentMethodCoded
Tax
PaymentMeans
Details
PaymentMeans
PaymentMeansType
0..1
Aggregate
the taxable amount in the payment currency.
Tax. InvoiceCurrency TaxAmount. Details
TaxableAmount
Tax
InvoiceCurrency
TaxAmount
Details
TaxAmount
TaxAmountType
0..1
Aggregate
must use one of either tax amount.
the taxable amount in the tax accounting currency.
Tax. AccountingCurrency TaxAmount. Details
TaxableAmount
Tax
AccountingCurrency
TaxAmount
Details
TaxAmount
TaxAmountType
0..1
Aggregate
the location for which the tax applies.
Tax. Location. Details
TaxLocation
Tax
Location
Details
Location
LocationType
0..1
Aggregate
components of the tax amounts
the taxable amount (ie what tax rate is applied to)
Tax Amount. Taxable. Amount
TaxAmount
Tax Amount
Taxable
Amount
Amount
AmountType
0..1
Basic
the tax amount (ie what tax rate is due)
Tax Amount. Tax. Amount
TaxAmountInTaxAccountingCurrency
Tax Amount
Tax
Amount
Amount
AmountType
1..1
Basic
notes may include the message text, or this text may be referenced with an external identifier or a URL.
used to provide a note in text form if desired.
Note. Text
GeneralNote
Note
Text
Text
Text
TextType
0..1
Basic
an ID assigned to this note. Is an implied attribute.
Note. Identifier
NoteID
Note
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
the URL that this note is referencing. Is an implied attribute.
Note. UniversalResourceLocation. Identifier
NoteURL
Note
UniversalResourceLocation
Identifier
Identifier
IdentifierType
0..1
Basic
identifies the line item for a product
identification of a product or service as assigned by the buyer.
Item. Buyer ItemIdentifier. Details
BuyerPartNumber
Item
Buyer
ItemIdentifier
Details
ItemIdentifier
ItemIdentifierType
0..1
Aggregate
identification of a product or service as assigned by the seller of the product or service.
Item. Seller ItemIdentifier. Details
SellerPartNumber
Item
Seller
ItemIdentifier
Details
ItemIdentifier
ItemIdentifierType
0..1
Aggregate
the identifaction of the manufacturer as assigned by a standards agency.
Item. Manufacturer ItemIdentifier. Details
ManufacturerPartNumber
Item
Manufacturer
ItemIdentifier
Details
ItemIdentifier
ItemIdentifierType
0..1
Aggregate
the commonly accepted identification of a product or service that is assigend by a standards agency.
Item. Standard ItemIdentifier. Details
StandardPartNumber
Item
Standard
ItemIdentifier
Details
ItemIdentifier
ItemIdentifierType
0..1
Aggregate
a collection of identifications of products or services that are acceptable substitutions for the product of service identified.
Item. Substitute ItemIdentifier. Details
SubstitutePartNumbers
Item
Substitute
ItemIdentifier
Details
ItemIdentifier
ItemIdentifierType
0..n
Aggregate
a collection of any other identifiactions of the product or service that are not explicitly stated as the content of the other elements contained elsewhere
Item. ItemIdentifier. Details
OtherItemIdentifiers
Item
ItemIdentifier
Details
ItemIdentifier
ItemIdentifierType
0..n
Aggregate
this is the 'context-free' case.
a free form field that can be used to give a text description of the item.
Item. Description. Text
ItemDescription
Item
Description
Text
Text
TextType
0..1
Basic
a collection of physical attributes other than dimensions of an item.
Item. PhysicalAttribute. Details
ListOfItemCharacteristic
Item
PhysicalAttribute
Details
PhysicalAttribute
PhysicalAttributeType
0..n
Aggregate
classification of the type of goods using the Harmonised (HS) system code. This is the international notation controlled by the WCO (World Customs Organisation) to officially categorise individual commodities. These are also known as customs commodity codes.
Item. HarmonisedSystem. Code
CommodityCode
Item
HarmonisedSystem
Code
Code
CodeType
0..1
Basic
one or more quantitative measurements of the item.
Item. Dimension. Details
ListOfDimension
Item
Dimension
Details
Measure
MeasureType
0..n
Basic
the total quantity of the item on this line
Item. Quantity
Quantity
Item
Quantity
Quantity
Quantity
QuantityType
0..1
Basic
the total quantity of the item on this line
Item. Minimum. Quantity
MinimumValue
Item
Minimum
Quantity
Quantity
QuantityType
0..1
Basic
the total quantity of the item on this line
Item. Maximum. Quantity
MaximumValue
Item
Maximum
Quantity
Quantity
QuantityType
0..1
Basic
the maximum quantity of an item that a customer will allow to be back ordered.
Item. Maximum Backorder. Quantity
MaxBackOrderQuantity
Item
Maximum
Backorder
Quantity
Quantity
QuantityType
0..1
Basic
a flag to denote whether the item was ordered from a catalog.
Item. FromCatalog. Indicator
OffCatalogFlag
Item
FromCatalog
Indicator
Indicator
IndicatorType
0..1
Basic
one or more references relating to the line item.
Item. InformationSource. Details
ListOfItemReferences
Item
InformationSource
Details
InformationSource
InformationSourceType
0..n
Aggregate
the country code for the country in which the line item was manufactured.
Item. OriginCountry Identification. Code
CountryOfOrigin
Item
OriginCountry
Identification
Code
Code
CodeType
0..1
Basic
the country code for the country in which the delivery is finally received.
Item. DestinationCountry Identification. Code
CountryOfDestination
Item
DestinationCountry
Identification
Code
Code
CodeType
0..1
Basic
the person or organization who will ultimately receive the item or items.
Item. FinalRecipient. Details
FinalRecipient
Item
FinalRecipient
Details
Party
PartyType
0..1
Aggregate
the conditions of sale for the item
Item. SalesCondition. Details
ConditionsOfSale
Item
SalesCondition
Details
SalesCondition
SalesConditionType
0..1
Aggregate
the hazardous information for the line item.
Item. HazardousGoods. Details
HazardousMaterials
Item
HazardousGoods
Details
HazardousGoods
HazardousGoodsType
0..1
Aggregate
the conditions of sale for the item
any specific sales information relating to the item.
Sales Condition. Condition. Identifier
SalesRequirement
Sales Condition
Condition
Identifier
Identifier
IdentifierType
1..n
Basic
derived from X12 563 (Sales requirement code)
what action should be undertaken in specific circumstances.
Sales Condition. Action. Identifier
SalesActionCoded
Sales Condition
Action
Identifier
Identifier
IdentifierType
0..1
Basic
derived from X12 306 (Action code)
the value associated with the action code.
Sales Condition. Description. Text
SalesActionValue
Sales Condition
Description
Text
Text
TextType
0..1
Basic
a complete identifiaction for a product or service.
the basic identification for a product or service.
Item Identifier. Identifier
PartID
Item Identifier
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
codeset ProductIdentifierQualifierCode used in xCBL3.0
additional identification for a product or service. An example of this would be a color code for a specific product.
Item Identifier. Extension. Text
PartIDExt
Item Identifier
Extension
Text
Text
TextType
0..1
Basic
the physical attributes other than dimensions of an item
the characteristic being described using a standard codelist.
Physical Attribute. Identifier
ItemCharacteristicCoded
Physical Attribute
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 7081 (Item characteristic code)and X12 750 (Product/process characteristic code)
the surface layer or the position of the item using a standard codelist.
Physica Attribute. Position. Identifier
SurfaceLayerPositionCoded
Physica Attribute
Position
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 7383 (Surface layer code) and X12 752 (Surface/layer/position code)
the value of the characteristic
Physica Attribute. Description. Text
ItemCharacteristicValue
Physica Attribute
Description
Text
Text
TextType
1..1
Basic
the unit of measure for the value of the characteristic.
Physica Attribute. Measurement Unit. Code
UnitOfMeasurement
Physica Attribute
Measurement
Unit
Code
Code
CodeType
0..1
Basic
derived from UNECE Rec 20 and X12 355 (Unit or Basis for measurement code)
the hazardous information for the line item.
identifier of the hazardous material being described.
Hazardous Goods. HazardousGoodsIdentification. Details
ListOfHazardousIdentifiers
Hazardous Goods
HazardousGoodsIdentification
Details
HazardousGoodsIdentification
HazardousGoodsIdentificationType
1..n
Aggregate
code qualifying hazardous class. Values are primary or secondary.
Hazardous Goods. Class. Identifier
HazardClassCoded
Hazardous Goods
Class
Identifier
Identifier
IdentifierType
0..1
Basic
the placard notation corresponding to the hazard class of the hazardous commodity. Can also be the hazard identification number of the orange placard (upper part) required on the means of transport.
Hazardous Goods. PlacardNotation. Text
Hazardous Goods
PlacardNotation
Text
Text
TextType
0..1
Basic
the placard endorsement that is to be shown on the shipping papers for the hazardous commodity. Can also be used for the number of the orange placard (lower part) required on the means of transport.
Hazardous Goods. PlacardEndorsement. Text
HazardousPlacardText
Hazardous Goods
PlacardEndorsement
Text
Text
TextType
0..1
Basic
specific hazardous material reference numbers.
Hazardous Goods. InformationSource. Details
HazardousReferences
Hazardous Goods
InformationSource
Details
InformationSource
InformationSourceType
0..n
Aggregate
the seller's contact for more information on the hazardous information.
Hazardous Goods. Contact. Details
HazardousContact
Hazardous Goods
Contact
Details
Contact
ContactType
0..1
Aggregate
additional information regarding the hazardous substance. (Can be used to hold information such as the type of regulatory requirements that apply to a description, e.g. N.O.S.).
Hazardous Goods. Additional Information. Text
HazardNote
Hazardous Goods
Additional
Information
Text
Text
TextType
0..1
Basic
a unique serial number assigned within the United Nations to substances and articles contained in a list of the dangerous goods most commonly carried.
Hazardous Goods. Undg. Identifier
UNDGNum
Hazardous Goods
Undg
Identifier
Identifier
IdentifierType
0..1
Basic
UNDG
the lowest temperature at which the vapor of a combustible liquid can be made to ignite momentarily in air.
Hazardous Goods. Flashpoint. Measure
Flashpoint
Hazardous Goods
Flashpoint
Measure
Measure
MeasureType
0..1
Basic
the temperature at which emergency procedures apply for the disposal of temperature-controlled goods.
Hazardous Goods. EmergencyTemperature. Measure
Emergency
Hazardous Goods
EmergencyTemperature
Measure
Measure
MeasureType
0..1
Basic
the maximum temperature at which certain products can be safely transported.
Hazardous Goods. Maximum TransportTemperature. Measure
Control
Hazardous Goods
Maximum
TransportTemperature
Measure
Measure
MeasureType
0..1
Basic
a list of one or more temperatures.
Hazardous Goods. Temperature. Details
ListOfTemperatureCoded
Hazardous Goods
Temperature
Details
Dimension
MeasureType
0..n
Basic
information related to the shipping and packaging of hazardous goods.
Hazardous Goods. HazardousShipment. Details
HazardousShipmentInformation
Hazardous Goods
HazardousShipment
Details
HazardousShipment
HazardousShipmentType
0..1
Aggregate
a reference to the emergency procedures for ships carrying dangerous goods.
Hazardous Goods. Emergency Procedures. Identifier
EMSNum
Hazardous Goods
Emergency
Procedures
Identifier
Identifier
IdentifierType
0..1
Basic
EMS for maritime
a reference to the medical first aid guide.
Hazardous Goods. Medical FirstAidGuide. Identifier
Mfag
Hazardous Goods
Medical
FirstAidGuide
Identifier
Identifier
IdentifierType
0..1
Basic
MFAG
identifier of the hazardous material being described.
the value of the hazard code.
Hazardous Goods Identification. HazardousGoods. Identifier
HazardCode
Hazardous Goods Identification
HazardousGoods
Identifier
Identifier
IdentifierType
1..1
Basic
an extension to the hazardous code above. Can also be used to hold additional code values such as a Waste Characteristics Code in conjunction with an EPA Waste Stream code.
Hazardous Goods Identification. Extension. Identifier
CodeExtension
Hazardous Goods Identification
Extension
Identifier
Identifier
IdentifierType
0..1
Basic
the identification of a transport emergency card, giving advice for emergency actions. Can be used for the identity number of a specific hazardous emergency response plan that is assigned by the Director General of Canada.
Hazardous Goods Identification. TransportEmergencyCard. Identifier
TremCardNum
Hazardous Goods Identification
TransportEmergencyCard
Identifier
Identifier
IdentifierType
0..1
Basic
TREM Card Number
Canada?
information related to the shipping and packaging of hazardous goods.
This code identifies the packing criteria for hazardous materials as assigned by IATA/IMDB/ADR/RID.
Hazardous Shipment. PackingCriteria. Identifier
HazardPackingCoded
Hazardous Shipment
PackingCriteria
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 8339 (Packing group code)
the type of information being passed so that a receiver may format a description of hazardous commodity movements that meets regulatory requirements.
Hazardous Shipment. Regulations. Identifier
HazardousShipmentCoded
Hazardous Shipment
Regulations
Identifier
Identifier
IdentifierType
0..1
Basic
derived from X12 808 (Hazardous material shipment information qualifier)
specific information required by law for hazardous material shipments or any free form text relating to hazardous shipments.
Hazardous Shipment. Regulations. Text
HazardousShipmentNote
Hazardous Shipment
Regulations
Text
Text
TextType
0..1
Basic
the Department of Transportation assigned zone designating the Inhalation Toxicity Hazard Zone.
Hazardous Shipment. InhalationToxicityZone. Identifier
HazardousZoneCoded
Hazardous Shipment
InhalationToxicityZone
Identifier
Identifier
IdentifierType
0..1
Basic
derived from X12 1023 (Hazard zone code)
the scheduling information for a distinct set of ship from party, ship to party, and transport information
the location to which the shipments are to be delivered.
Delivery. ShipTo Location. Details
ShipToLocation
Delivery
ShipTo
Location
Details
Location
LocationType
0..1
Aggregate
the location from which the item is to be shipped from.
Delivery. ShipFrom Location. Details
ShipFromLocation
Delivery
ShipFrom
Location
Details
Location
LocationType
0..1
Aggregate
a portion of the line item shipment to be sent on particular set of dates with a particular set of transport information.
Delivery. Schedule. Details
ListOfScheduleLine
Delivery
Schedule
Details
DeliverySchedule
DeliveryScheduleType
0..n
Aggregate
reference information when detailed packaging information contained in list of package detail is to be associated with the line item.
Delivery. Reference. Details
ItemPackagingReference
Delivery
Reference
Details
Reference
IdentifierType
0..1
Basic
free form text relating to the packaging.
Delivery. Packaging. Text
SimplePackageNote
Delivery
Packaging
Text
Text
TextType
0..1
Basic
the information related to delivery including shipment method payment and transport.
Delivery. Terms. Details
TermsOfDelivery
Delivery
Terms
Details
DeliveryTerms
DeliveryTermsType
0..1
Aggregate
different conventions for the classification and description of the goods being transported.
Delivery. Goods Classification. Details
CargoClassification
Delivery
Goods
Classification
Details
GoodsClassification
GoodsClassificationType
0..1
Aggregate
shipment to be sent on particular set of dates with a particular set of transport information.
identifies the schedule line
Delivery Schedule. Identifier
ScheduleLineID
Delivery Schedule
Identifier
Identifier
Identifier
IdentifierType
0..1
Basic
the sub-quantity to be shipped on a particular set of dates.
Delivery Schedule. Quantity
Quantity
Delivery Schedule
Quantity
Quantity
Quantity
QuantityType
0..1
Basic
the minimum sub-quantity to be shipped on a particular set of dates.
Delivery Schedule. Minimum. Quantity
Delivery Schedule
Minimum
Quantity
Quantity
QuantityType
0..1
Basic
the maximum sub-quantity to be shipped on a particular set of dates.
Delivery Schedule. Maximum. Quantity
Delivery Schedule
Maximum
Quantity
Quantity
QuantityType
0..1
Basic
the date the buyer requested for delivery.
Delivery Schedule. Requested Delivery. Date Time
RequestedDeliveryDate
Delivery Schedule
Requested
Delivery
Date Time
DateTime
DateTimeType
0..1
Basic
the dates revolving around delivery.This is used to express simple date information that is not tied to particular carriers, transport, etc.
Delivery Schedule. Delivery. Date Time
ListOfOtherDeliveryDate
Delivery Schedule
Delivery
Date Time
DateTime
DateTimeType
0..n
Basic
contains carrier, equipment, and mode of transport information.
Delivery Schedule. Shipment. Details
Transport
Delivery Schedule
Shipment
Details
Shipment
ShipmentType
0..n
Aggregate
the transport routing element to identify which transport legs the package is travelling on. This element is repeated if the package travels on more than one transport route.
Delivery Schedule. Shipment. Identifier
TransportReference
Delivery Schedule
Shipment
Identifier
Identifier
IdentifierType
0..1
Basic
place and quantity information regarding the shipto sub-location.
Delivery Schedule. SplitLocation. Details
ListOfShipToSubInformation
Delivery Schedule
SplitLocation
Details
SplitLocation
SplitLocationType
0..n
Aggregate
the information for the locations and quantities of the goods for the schedule lines.
places inside the ship to location where specific sub deliveries will be made. This is also called a mail stop.
Split Location. Delivery. Details
ShipToSubLocation
Split Location
Delivery
Details
Location
LocationType
1..1
Aggregate
the quantity associated with the ship to sub location.
Split Location. Quantity
ShipToSubQuantity
Split Location
Quantity
Quantity
Quantity
QuantityType
1..1
Basic
Split Location. Package. Details
SubLocationItemPackagingReference
Split Location
Package
Details
Package
PackageType
0..1
Aggregate
to be used when specifying packaging details related to each shipment to a sub location.
the package ID of the package containing the item
Package. Identifier
PackageIDReference
Package
Identifier
Identifier
Identifier
IdentifierType
1..1
Basic
the quantity should match the values in shipto sub quantity. These values override packaging references supplied at the delivery detail level.
Package. Quantity
Quantity
Package
Quantity
Quantity
Quantity
QuantityType
0..1
Basic
provides a reference for the packaging of the item.
Package. Composite Package. Details
PackageReference
Package
Composite
Package
Details
Package
PackageType
0..1
Aggregate
recursive structure
the high level nature of goods code issued by a specific maintenance agency. It is generally the first two digits of the HS code. This also defines the maintenance agency for the codelist (usually WCO World Customs Organization).
Goods Classification. Nature. Code
NatureOfGoods
Goods Classification
Nature
Code
Code
CodeType
0..1
Basic
the classification of the cargo using a standard codelist.
Goods Classification. Classification. Identifier
OperationalTypeCoded
Goods Classification
Classification
Identifier
Identifier
IdentifierType
0..1
Basic
derived from EDIFACT 7085 (Cargo type classification code)
the commodity code that identifies at a high level what the items are. Set of understood description of goods.
Goods Classification. Commodity. Identifier
TypeOfCargo
Goods Classification
Commodity
Identifier
Identifier
IdentifierType
0..1
Basic
UN/ECE Rec 21 single digit type of cargo coded. Note; UN/ECE rec 21 is under revision and will need to update to recommendation 29.