Party
Party
details of an individual, a group or a body having a role in a business function
000001
PartyID
Party. Identification
Party
Identification
Identifier
IdentifierType
1..1
Simple
a standard identification of an entity doing business as assigned by a standards agency.
LanguageDependent
Party. Languagedependency. Indicator
Party
Languagedependency
Indicator
IndicatorType
0..1
Simple
defines whether any data is language dependent or not
International
Party. Language
Party
Language
Language
LanguageType
0..1
Complex
used to provide information about the language which text relating to this party is written in
International
Name1
Party. Name
Party
Name
Name
TextType
1..1
Simple
contains the name of an entity
Name2, Name3
Party. Additionalname
Party
Additionalname
Text
TextType
0..n
Simple
contain additional names for the entity
NameAddress
Party. Address
Party
Address
Address
AddressType
0..1
Complex
ReceivingContact
Party. Recipient. Contact
Party
Recipient
Contact
Contact
ContactType
0..1
Complex
the means for contacting a person or department responsible for receiving of goods or services.
ShippingContac
Party. Shipping. Contact
Party
Shipping
Contact
Contact
ContactType
0..1
Complex
contains the means for contacting a person or department responsible for transporting goods
OrderContact
Party. Order. Contact
Party
Order
Contact
Contact
ContactType
0..1
Complex
contains the means for contacting a person or department responsible for managing orders
OtherContacts
Party. Contact
Party
Contact
Contact
ContactType
0..1
Complex
contains the means for contacting a person or department for other aspects of the Party
Buyer/SellerTaxInformation
Party. Tax. Taxscheme
Party
Tax
Taxscheme
TaxschemeType
0..1
Complex
describes the taxing information for the buying party.
Language
Language
used to provide information about the language which text is written in
LanguageCode
Language. Identification
Language
Identification
Code
CodeType
1..1
Simple
identifies the language using ISO standards
ISO 639-1998
Language. Name
Language
Name
Name
TextType
0..1
Simple
the common name of the language
LocaleCode
Language. Locale. Code
Language
Locale
Code
CodeType
0..1
Simple
identifies the locale/location where the language is spoken.
enumerated list in xCBL
Address
Address
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.
ExternalAddressID
Address. Identification
Address
Identification
Identifier
IdentifierType
0..1
Simple
a globaly unique value that is used for referencing the address when specifying specific user information ( unique within partner organization)
Address. House. Name
Address
House
Name
TextType
0..1
Simple
HouseNumber
Address. House. Value
Address
House
Value
NumericType
0..1
Simple
the house number or description that identifies the location of a building on a street
000026
POBox
Address. Pobox
Address
Pobox
Text
TextType
0..1
Simple
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
maybe this may be better expressed as a coded identifier
000033
Street
Address. Street. Name
Address
Street
Name
TextType
0..1
Simple
contains the name of the street.
StreetSupplement1, StreetSupplement2
Address. Street
Address
Street
Text
TextType
0..1
Simple
any additional information to identify the street.
We have combined the two xCBL elements
Building
Address. Building. Identifier
Address
Building
Identifier
IdentifierType
0..1
Simple
the name of the building or house
000035
RoomNumber
Address. Room. Identifier
Address
Room
Identifier
IdentifierType
0..1
Simple
the room identifier or the identification of a suite or apartment
considered synonomous with CC suite.identifier (000036)
000036
InhouseMail
Address. Inhousemail. Identifier
Address
Inhousemail
Identifier
IdentifierType
0..1
Simple
the inhouse mail identifier
Department
Address. Department. Name
Address
Department
Name
TextType
0..1
Simple
the department number or name
PostalCode
Address. Postalcode. Identifier
Address
Postalcode
Identifier
IdentifierType
0..1
Simple
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
this could be viewed as another code set
000031
County
Address. County. Name
Address
County
Name
TextType
0..1
Simple
the name of the county or a territorial division of some countries, forming the chief unit of local administration
000043
DistrictName
Address. District. Name
Address
District
Name
TextType
0..1
Simple
the name of the district or a part of a town or region
000028
Floor
Address. Floor. Identifier
Address
Floor
Identifier
IdentifierType
0..1
Simple
the name or number of the floor
City
Address. City. Name
Address
City
Name
TextType
0..1
Simple
the name of the city or a built up area with a name, defined boundaries and a local government
known as 'town.name' in CC (000029)
000029
AddressTypeCode
Address. Category. Identifier
Address
Category
Identifier
IdentifierType
0..1
Simple
the category or type of the address. for example, a business or home address. Not the Role of the address
EDIFACT 3035 (Party Function Code Qualifier)
000024
RegionCode
Address. Region. Identifier
Address
Region
Identifier
IdentifierType
0..1
Simple
the region within a country using a standard code list
derived from ISO 3166/1998 (Country code subdivision code, UN/LOCODE 2000)
we use the CC 'location.identification.code' (000061) as equivalent to this code
000061
CountryCode
Address. Country. Code
Address
Country
Code
CodeType
0..1
Simple
a country or a nation with its own government expressed as an ISO standard code
ISO 3166-1997
the CC defintion defines 'country' not 'countrycode'
000032
TimeZone
Address. Timezoneoffset. Measure
Address
Timezoneoffset
Measure
MeasureType
0..1
Simple
the value of the timezone. This is an offset from Greenwich Mean Time.
the xCBL enumerated list appears to hold 'times' offset from GMT. it is not the 'timezone' code
Contact
Contact
contains the means for contacting a person or department.
ContactName
Contact. Name
Contact
Name
Name
TextType
1..1
Simple
identifies the department or employee name
ContactID
Contact. Identification
Contact
Identification
Identifier
IdentifierType
0..1
Simple
holds the identifier of the department or employee
ContactNumber
Contact. Communication
Contact
Communication
Communication
CommunicationType
0..n
Complex
the channel and value of a communication point for the Contact
000050
Communication
Communication
the channel and value of a communication point or the information for one communication number or virtual address
000050
ContactNumberValue
Communication. Value
Communication
Value
Text
TextType
1..1
Simple
the value of the communication point or the number or virtual address of communication
this is a good example of name refinement
000055
ContactNumberTypeCode
Communication. Channel. Identifier
Communication
Channel
Identifier
IdentifierType
0..1
Simple
identifies the channel of communication or the way or manner in which the communication is made using a standard code set
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
Location
Location
identifies a place by its function and either an identifier, an identification assigned to an address, or an address
LocationIdentifier
Location. Identification
Location
Identification
Identifier
IdentifierType
0..1
Simple
contains the location identifier
Cannot show the exclusivity for LocationId/ExternalAddressId/NameaddressDetails
Name1
Location. Name
Location
Name
Name
TextType
1..1
Complex
contains the name of an entity
Name2, Name3
Location. Additionalname
Location
Additionalname
Text
TextType
0..n
Simple
contain additional names for the entity
NameAddress
Location. Address
Location
Address
Address
AddressType
0..1
Complex
GPSCooridinates
Location. Coordinates
Location
Coordinates
Coordinates
CoordinatesType
0..1
Complex
identifies the location by specific co-ordinates
Coordinates
Coordinates
Details geographic co-ordinates
GPSSystem
Coordinates. System. Identifier
Coordinates
System
Identifier
IdentifierType
1..1
Simple
identifies the co-ordinate measuring system (eg. GPS)
Latitude
Coordinates. Latitude. Measure
Coordinates
Latitude
Measure
MeasureType
1..1
Simple
specifies the latitude of the location
assume this is some kind of degree or radian. Is there a core component type for MeasureType?
Longitude
Coordinates. Longitude. Measure
Coordinates
Longitude
Measure
MeasureType
1..1
Simple
specifies the longitude of the location.
assume this is some kind of degree or radian. Is there a core component type for MeasureType?
Shipment
Shipment
Information pertaining to a stage of a shipment
TransportID
Shipment. Stage. Identifier
Shipment
Stage
Identifier
IdentifierType
1..1
Simple
a unique identifier for this stage of the shipment. Intended to be used as an internal reference for the document.
TransportMode
Shipment. Transportmode. Identifier
Shipment
Transportmode
Identifier
IdentifierType
0..1
Simple
specifies the method or type of transportation of this stage of the shipment. Typically this may be sea, air or road.
derived from EDIFACT Recommendation 19 (Mode of Transport) and X12 91 (Transportation Method/Type Code)
TransportMeans
Shipment. Transportmeans. Identifier
Shipment
Transportmeans
Identifier
IdentifierType
0..1
Simple
specifies the means of transportation for this stage of the shipment. Typically this may be by truck, sea- going vessel or aircraft.
derived from EDIFACT 8179(Transport Means Description Code) and X12 40 (Equipment Description Code)
CarrierID
Shipment. Carrier. Identifier
Shipment
Carrier
Identifier
IdentifierType
0..1
Simple
the identifier assigned by the agency to the carrier. This identifies the carrier being used for this stage of the shipment.
CustShippingContractNum
Shipment. Contract. Identifier
Shipment
Contract
Identifier
IdentifierType
0..1
Simple
provides a shipping contract reference to allow supplier to ship goods under specific freight conditions or the carrier to bill against a specific contract.
ServiceLevelCoded
Shipment. Servicelevel. Identifier
Shipment
Servicelevel
Identifier
IdentifierType
0..1
Simple
a code defining the level of service required.
derived from EDIFACT 4183 (Special condition code), 4219 (Transport priority coded), and 8335 (Movement type description code) and X12 284 (Service level code)
ShippingInstructions
Shipment. Instructions
Shipment
Instructions
Text
TextType
0..1
Simple
free form text for special shipping instructions.
ListOfTransportEquipment
Shipment. Container
Shipment
Container
Container
ContainerType
0..n
Complex
identifies and describes the equipment to be used for this stage of the shipment. e.g. container details
TransitDirectionCoded
Shipment. Direction. Identifier
Shipment
Direction
Identifier
IdentifierType
0..1
Simple
the transit direction for the shipment.
derived from EDIFACT 8101 (Transit direction indicator code) and X12 731 (Transit direction code)
TransitTime
Shipment. Transit. Period
Shipment
Transit
Period
PeriodType
0..1
Simple
the amount of transit time.
TransportNote
Shipment. Information
Shipment
Information
Text
TextType
0..1
Simple
any additonal text relating to the transport.
Container
Container
identifies and describes the equipment used in the transportation of goods (e.g. the container)
This is a rationalization of the xCBL TransportEquipment
EquipmentID
Container. Identification
Container
Identification
Identifier
IdentifierType
0..1
Simple
identifies the container for the purposes of referencing within the document domain.
EquipmentProviderCoded
Container. Providertype. Identifier
Container
Providertype
Identifier
IdentifierType
0..1
Simple
identifies the type of provider for the container
derived from EDIFACT 8077 (Equipment supplier code)
EquipmentOwnerCoded
Container. Ownership. Identifier
Container
Ownership
Identifier
IdentifierType
0..1
Simple
identifies the ownership relationship of the container
derived from X12 102 (Ownership code)
EquipmentSizeTypeCoded
Container. Sizetype. Code
Container
Sizetype
Code
CodeType
0..1
Simple
the size and type of the container
derived from EDIFACT 8155 (Equipment size and type description code) and X12 40 (Equipment description code)
these codes are incomplete
EquipmentStatusCoded
Container. Disposition. Identifier
Container
Disposition
Identifier
IdentifierType
0..1
Simple
describes the current disposition of the container
derived from EDIFACT 8249
FullIndicatorCoded
Container. Fillstatus. Identifier
Container
Fillstatus
Identifier
IdentifierType
0..1
Simple
describes whether the container already contains items.
derived from EDIFACT 8169 (Full/empty indicator, coded)
RefrigerationOn
Container. Refridgerationstatus. Indicator
Container
Refridgerationstatus
Indicator
IndicatorType
0..1
Simple
defines whether the refrigeration is on or off.
EquipmentNote
Container. Information
Container
Information
Text
TextType
0..1
Simple
holds free text information for the equipment.
ListOfSealInfo
Container. Seal
Container
Seal
Seal
SealType
0..n
Complex
provides the information regarding the seals affixed to the container
ListOfEquipmentMeasurements
Container. Measurement
Container
Measurement
Measurement
MeasurementType
0..n
Complex
lists measurement information on the container
Seal
Seal
provides the information regarding the seals affixed to any equipment. (e.g. a container)
SealNumber
Seal. Identification
Seal
Identification
Identifier
IdentifierType
1..1
Simple
identifies the seal number of the equipment.
SealIssuer
Seal. Issuer. Code
Seal
Issuer
Code
CodeType
0..1
Simple
provides information about the issuer of the seal for the equipment.
derived from EDIFACT 9303 (Sealing party coded)
SealStatusDescription
Seal. Information
Seal
Information
Text
TextType
0..1
Simple
provides information on the status of the seal.
Measurement
Measurement
a quantitative physical characteristic.
Needed to add min/max to repeated occurrences of QuantityType
MeasurementValue
Measurement. Value. Measure
Measurement
Value
Measure
MeasureType
0..1
Simple
the value of the measurement
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
MinimumValue
Measurement. Miminum. Measure
Measurement
Miminum
Measure
MeasureType
0..1
Simple
the minimum value of the range
MaximumValue
Measurement. Maximum. Measure
Measurement
Maximum
Measure
MeasureType
0..1
Simple
the maximum value of the range
Deliveryterms
Deliveryterms
defines the terms of delivery
TermsOfDeliveryFunctionCoded
Deliveryterms. Basis. Identifier
Deliveryterms
Basis
Identifier
IdentifierType
1..1
Simple
indicates whether the terms relate to e.g. price conditions, delivery conditions, transport conditions, or a combination of these.
derived from EDIFACT 4055 (Delivery or transport terms function code)
TransportTermsCoded
Deliveryterms. Identification
Deliveryterms
Identification
Identifier
IdentifierType
0..1
Simple
the terms of delivery or transport.
derived from INCOTERMS 1990
ShipmentMethodOfPaymentCoded
Deliveryterms. Paymentmethod. Identifier
Deliveryterms
Paymentmethod
Identifier
IdentifierType
1..1
Simple
the method of payment for transport charges
derived from EDIFACT 4215 (Transport charges payment method code) and X12 146 (Shipment method of payment)
Location
Deliveryterms. Relevant. Location
Deliveryterms
Relevant
Location
Location
LocationType
0..1
Complex
the location relevant to the terms of delivery specified.
TermsOfDeliveryDescription
Deliveryterms. Specialterms
Deliveryterms
Specialterms
Text
TextType
0..1
Simple
the text description on special conditions or notes on the delivery.
TransportDescription
Deliveryterms. Transportdescription
Deliveryterms
Transportdescription
Text
TextType
0..1
Simple
a description of transport.
example of the need for representation term = 'Description'
RiskOfLossCoded
Deliveryterms. Riskresponsibility. Identifier
Deliveryterms
Riskresponsibility
Identifier
IdentifierType
0..1
Simple
indicates the responsibility for risk of loss
derived from X12 54 (Risk of loss qualifier)
RiskOfLossDescription
Deliveryterms. Lossrisk
Deliveryterms
Lossrisk
Text
TextType
0..1
Simple
a text description of the risk of loss information.
Pricing
Pricing
the pricing scheme
UnitPriceValue
Pricing. Unitprice. Amount
Pricing
Unitprice
Amount
AmountType
1..1
Simple
contains the value of the unit price.
PriceBasisQuantity
Pricing. Basis. Quantity
Pricing
Basis
Quantity
QuantityType
0..1
Simple
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).
ValidityDates
Pricing. Validity. Period
Pricing
Validity
Period
Period
PeriodType
0..1
Complex
specifies the start and end date for the pricing if a range dates applies to the pricing scheme.
PriceQuantityRange
Pricing. Quantity
Pricing
Quantity
Quantity
QuantityType
0..1
Simple
contains a range of quantity over which the pricing information is applicable. This is commonly used for step pricing scenarios.
MinimumValue
Pricing. Minimum. Quantity
Pricing
Minimum
Quantity
QuantityType
0..1
Simple
specifies the minimum quantity in a range
MaximumValue
Pricing. Maximum. Quantity
Pricing
Maximum
Quantity
QuantityType
0..1
Simple
specifies the maximum quantity in a range
PriceMultiplierCode
Pricing. Multiplierreason. Identifier
Pricing
Multiplierreason
Identifier
IdentifierType
0..1
Simple
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.
derived from EDIFACT 5393 (Price Multiplier Qualifier) and X12 648 (Price Multiplier Qualifier)
Multiplier
Pricing. Multiplier. Value
Pricing
Multiplier
Value
ValueType
0..1
Simple
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 .
Paymentterms
Paymentterms
details about one payment condition, such as discount eligibility.
PaymentTermCode
Paymentterms. Identification
Paymentterms
Identification
Identifier
IdentifierType
1..1
Simple
contains details about one payment condition, such as discount eligibility.
derived from EDIFACT 4279 (Payment terms type code qulaifier) and X12 336 (Terms type code)
PaymentTermValue
Paymentterms. Value
Paymentterms
Value
Value
ValueType
0..1
Simple
specifies the value that pertains to the payment terms.
PaymentTermDetails
Paymentterms. Discount
Paymentterms
Discount
Discount
DiscountType
0..n
Complex
used to communicate any discounts that may be associated with the payment term.
Discount
Discount
holds discount information
DiscountPercent
Discount. Percent
Discount
Percent
Percent
PercentType
0..1
Simple
the percent discounted in the terms of the payment. If a discount percent is specified then DiscountAmount should not be used.
Cannot show rules that either DiscountAmount or DiscountPercent must be used.
DiscountAmount
Discount. Amount
Discount
Amount
Amount
AmountType
0..1
Simple
the amount to be discounted from the payment value. If a discount amount is specified then DiscountPercent should not be used.
DiscountDaysDue
Discount. Paymentdays. Value
Discount
Paymentdays
Value
ValueType
0..1
Simple
the number of days which the amount has to be paid by in order to receive the discount.
example of need for representation term = "Days"
only used in the case where the discount appies to a payment term.
DiscountDueDate
Discount. Payment. Date
Discount
Payment
Date
DateType
0..1
Simple
the date the amount has to paid by in order to receive the discount.
only used in the case where the discount appies to a payment term.
DiscountDateTimeRefCoded
Discount. Event. Identifier
Discount
Event
Identifier
IdentifierType
0..1
Simple
the event on which the discount terms are based from using a standard codelist.
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.
NetDaysDue
Discount. Fullpaymentdays. Value
Discount
Fullpaymentdays
Value
ValueType
0..1
Simple
the number of days the amount has to be paid in full by.
only used in the case where the discount appies to a payment term.
NetDueDate
Discount. Fullpayment. Date
Discount
Fullpayment
Date
DateType
0..1
Simple
the specific date that the payment is due in full.
only used in the case where the discount appies to a payment term.
NetDateTimeRefCoded
Discount. Fullpaymentevent. Identifier
Discount
Fullpaymentevent
Identifier
IdentifierType
0..1
Simple
the event on which the net days due are based from using a standard codelist.
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.
Paymentmeans
Paymentmeans
the specific manner in which a payment is to be made.
PaymentMeanCoded
Paymentmeans. Identification
Paymentmeans
Identification
Identifier
IdentifierType
1..1
Simple
a valid means of paying the debt.
derived from EDIFACT 4461 (payment means code) and X12 107 (payment method code).
PaymentMeanReference
Paymentmeans. Paymentidentification
Paymentmeans
Paymentidentification
Text
TextType
0..1
Simple
information relating to the specified payment mean. For example, if the selected payment mean were check, then PaymentMeanReference would be used to communicate the check number.
RefDate
Paymentmeans. Paymentidentification. Datetime
Paymentmeans
Paymentidentification
Datetime
DatetimeType
PaymentSystemCoded
Paymentmeans. System. Identifier
Paymentmeans
System
Identifier
IdentifierType
0..1
Simple
the system through which the payment is processed using a standard codelist.
derived from EDIFACT 4435 (Payment channel code).
OriginatingFIAccount
Paymentmeans. Payer. Account
Paymentmeans
Payer
Account
Account
AccountType
0..1
Complex
information for the financial institution and associated account details from which the funds are originating (Payer's bank details).
ReceivingFIAccount
Paymentmeans. Payee. Account
Paymentmeans
Payee
Account
Account
AccountType
0..1
Complex
information for the financial institution and associated account details to which the funds are being sent (Payee's bank details).
CardInfo
Paymentmeans. Creditcard
Paymentmeans
Creditcard
Creditcard
CreditcardType
0..1
Complex
the credit or debit card that is being used for the payment.
Account
Account
AccountID
Account. Identification
Account
Identification
Identifier
IdentifierType
0..1
Simple
the account number or identifier for the account.
not needed if only the Financial Institution is used.
FinancialInstitutionID
Account. Financialinstitution
Account
Financialinstitution
Financialinstitution
FinancialinstitutionType
1..1
Simple
the financial institution by code.
FIBranchID
Account. Financialinstitution. Branch
Account
Financialinstitution
Branch
Branch
BranchType
0..1
Simple
the branch of the institution
SecondaryAccountID
Account. Secondaryaccount. Identifier
Account
Secondaryaccount
Identifier
IdentifierType
0..1
Simple
a secondary account number to identify the account.
Needs more explanation of business function
AccountControlKey
Account. Control. Identifier
Account
Control
Identifier
IdentifierType
0..1
Simple
the control number to uniquely identify the account at the financial institution.
AccountTypeCoded
Account. Type. Identifier
Account
Type
Identifier
IdentifierType
1..1
Simple
a code qualifying the type of account.
derived from X12 569 (Account Number Qualifier)
AccountName1
Account. Account. Name
Account
Account
Name
NameType
1..1
Simple
the main account holder of the account.
AccountName2
Account. Secondaryaccount. Name
Account
Secondaryaccount
Name
NameType
0..1
Simple
a secondary name on the account.
Currency
Account. Currency. Code
Account
Currency
Code
CodeType
0..1
Complex
the currency that applies to the account.
derived from ISO recommendation no.9
AccountReferences
Account. Informationsource
Account
Informationsource
Informationsource
InformationsourceType
0..n
Complex
a list of coded references to specify an identifier or name associated with the account.
Financialinstitution
Financialinstitution
FinancialInstitutionID
Financialinstitution. Identification
Financialinstitution
Identification
Identifier
IdentifierType
1..1
Simple
the financial institution by code.
FinancialInstitutionName
Financialinstitution. Financialinstitution. Name
Financialinstitution
Financialinstitution
Name
NameType
0..1
Simple
the name of the financial institution.
FIBranchID
Financialinstitution. Branch
Financialinstitution
Branch
Branch
BranchType
0..n
Simple
the branches of this institution
Branch
Branch
FIBranchID
Branch. Identification
Branch
Identification
Identifier
IdentifierType
1..1
Simple
the identification of the branch
FIBranchName
Branch. Name
Branch
Name
Name
NameType
0..1
Simple
the name of the branch
FIBranchCity
Branch. City. Name
Branch
City
Name
NameType
0..1
Simple
the city where the branch is located.
FIBranchCountry
Branch. Country. Code
Branch
Country
Code
CodeType
0..1
Simple
the country where the branch is based.
derived from ISO 3166-1997
Informationsource
Informationsource
identifies the source of the information using a standard codelist.
ReferenceTypeCode
Informationsource. Codeset. Identifier
Informationsource
Codeset
Identifier
IdentifierType
1..1
Simple
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)
PrimaryReference
Informationsource. Primarylevel
Informationsource
Primarylevel
Text
TextType
1..1
Simple
the highest level of the associated instance to which the information source applies (e.g. this codeset applies to the entire Order)
SupportingReference
Informationsource. Secondarylevel
Informationsource
Secondarylevel
Text
TextType
0..1
Simple
the secondary level of the associated instance to which the information source applies (e.g. this codeset applies to the entire Lineitem)
SupportingSubReference
Informationsource. Lowestlevel
Informationsource
Lowestlevel
Text
TextType
0..1
Simple
the lowest level of the associated instance to which the information source applies (e.g. this codeset applies to a specific sub-structure)
ReferenceDescription
Informationsource. Description
Informationsource
Description
Text
TextType
0..1
Simple
used to describe a reference using free form text
Creditcard
Creditcard
details of a credit or debit card
CardNum
Creditcard. Identification
Creditcard
Identification
Identifier
IdentifierType
1..1
Simple
the identifying number of the credit or debit card.
CardAuthCode
Creditcard. Authorization
Creditcard
Authorization
Text
TextType
0..1
Simple
the authorization number of the card.
CardRefNum
Creditcard. Customer. Identifier
Creditcard
Customer
Identifier
IdentifierType
0..1
Simple
the customer reference number. This is used to enable transmission of customer specific information with the card.
CardExpirationDate
Creditcard. Expiry. Date
Creditcard
Expiry
Date
DateType
0..1
Simple
the date up to which the card is valid .
CardType
Creditcard. Issuer. Identifier
Creditcard
Issuer
Identifier
IdentifierType
0..1
Simple
the type of card used for payment
enumerated list in xCBL
CardHolderName
Creditcard. Holder. Name
Creditcard
Holder
Name
NameType
0..1
Simple
the name of the holder of the card.
Taxscheme
Taxscheme
describes the tax information for a party.
TaxIdentifier
Taxscheme. Identification
Taxscheme
Identification
Identifier
IdentifierType
0..1
Simple
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.
RegisteredName
Taxscheme. Registration. Name
Taxscheme
Registration
Name
NameType
0..1
Simple
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.
RegisteredOffice
Taxscheme. Registration. Address
Taxscheme
Registration
Address
AddressType
0..1
Complex
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.
TaxLocation
Taxscheme. Tax. Location
Taxscheme
Tax
Location
LocationType
0..1
Complex
TaxLocation holds the tax location.
CompanyRegistrationNumber
Taxscheme. Company. Identifier
Taxscheme
Company
Identifier
IdentifierType
0..1
Simple
CompanyRegistrationNumber is the company registration number of the party. This must be present if tax regulations require it.
Quote
Quote
QuoteReferencesType refers to a Quote ID or ShoppingCart ID.
RefNum
Quote. Identification
Quote
Identification
Identifier
IdentifierType
1..1
Simple
QuoteReferenceId is the reference characters which identify the Quote.
xCBL uses a generic reference component, we are using a context specific reference.
RefDate
Quote. Reference. Datetime
Quote
Reference
Datetime
DatetimeType
0..1
Simple
QuoteReferenceDatetime holds the date of the Quote.
Contract
Contract
Provides the details of an agreement between trading partners.
ContractID
Contract. Identification
Contract
Identification
Identifier
IdentifierType
1..1
Simple
ContractId is a unique identifier assigned to the contract.
None
ContractType
Contract. Type. Code
Contract
Type
Code
CodeType
0..1
Simple
ContractTypeCode identifies the type of contract.
X12 1166
ValidityDates
Contract. Validity. Period
Contract
Validity
Period
PeriodType
0..1
Complex
specifies the dates or duration for which the Contract is valid.
Period
Period
specifies the dates or duration for which an event is effective.
StartDate
Period. Start. Datetime
Period
Start
Datetime
DatetimeType
0..1
Simple
specifies the first point in time on which validity/effectivity occurs.
EndDate
Period. End. Datetime
Period
End
Datetime
DatetimeType
0..1
Simple
ValidityperiodEndDate specifies the last point in time for which a validity/effectivity occurs.
Period. Duration. Measure
Period
Duration
Measure
MeasureType
0..1
Simple
A duration of time expressed as a formal code. The Measure. Code inside the Measure. Type should be ISO 8601.
ISO 8601
Period. Description. Code
Period
Description
Code
CodeType
0..n
Simple
A code that describes the significance of the dates or the duration.
xCBL DateTimeRefCode
Perhaps a business event sets this off, or triggers something to happen.
Request
Request
information that can be used to find further information elsewhere.
RefNum
Request. Identification
Request
Identification
Identifier
IdentifierType
1..1
Simple
the reference characters which distinguish the source of information.
RefDate
Request. Datetime
Request
Datetime
Datetime
DatetimeType
0..1
Simple
the date of the reference information.
Exchangerate
Exchangerate
used if the exchange rate to another currency
ReferenceCurrency
Exchangerate. Reference. Currency. Code
Exchangerate
Reference
Currency
Code
CodeType
1..1
Simple
the reference currency of the rate of exchange. The currency from which the exchange is being made (CC Definition)
TargetCurrency
Exchangerate. Target. Currency. Code
Exchangerate
Target
Currency
Code
CodeType
1..1
Simple
the target currency of the rate of exchange. This is the currency to which the exchange is being made. (CC Definition)
Exchangerate. Exchangemarket. Identifier
Exchangerate
Exchangemarket
Identifier
IdentifierType
0..1
Simple
the currency market from which the exchange rate is taken
RateOfExchange
Exchangerate. Rate
Exchangerate
Rate
Rate
NumericType
1..1
Simple
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)
InverseRateOfExchange
Exchangerate. Inverse. Rate
Exchangerate
Inverse
Rate
RateType
0..1
Simple
the rate of exchange given as target currency : reference currency.
DateOfRateOfExchange
Exchangerate. Quotedate. Datetime
Exchangerate
Quotedate
Datetime
DatetimeType
0..1
Simple
the date the rate of exchange was quoted.
ListOfRateOfExchangeReference
Exchangerate. Exchange. Request
Exchangerate
Exchange
Request
RequestType
0..n
Complex
a reference to identify rate of exchange request.
Paymentvariation
Paymentvariation
identifies a service, promotion, allowance, or charge and specifies the amount or percentage for the service, promotion, allowance, or charge.
AllowanceOrChargeDescription
Paymentvariation. Service. Identifier
Paymentvariation
Service
Identifier
IdentifierType
1..1
Simple
description of the reference or charge usinga codelist
derived from X12 1300 (Service, promotion, allowance or charge code)
AllowanceOrChargeDescription
Paymentvariation. Service
Paymentvariation
Service
Text
TextType
1..1
Simple
description of the reference or charge using free text
IndicatorCoded
Paymentvariation. Condition. Identifier
Paymentvariation
Condition
Identifier
IdentifierType
1..1
Simple
identifies whether an allowance or a charge applies using a standard codelist. Allowances are considered to be discounts.
derived from EDIFACT 5463 (Allowance) and X12 248 (Allowance Or Charge Indicator)
BasisCoded
Paymentvariation. Basis. Identifier
Paymentvariation
Basis
Identifier
IdentifierType
0..1
Simple
the basis the allowance or charge is calculated using a standard codelist.
enumerated list in xCBL
MethodOfHandlingCoded
Paymentvariation. Settlement. Identifier
Paymentvariation
Settlement
Identifier
IdentifierType
1..1
Simple
how the allowance or charge will be settled using a standard codelist.
derived from X12 331 (Allowance or charge method of handling code)
ValidityDates
Paymentvariation. Validity. Period
Paymentvariation
Validity
Period
PeriodType
0..1
Complex
the dates between which the allowance or charge takes effect.
QuantityValue
Paymentvariation. Quantity
Paymentvariation
Quantity
Quantity
QuantityType
0..1
Simple
a specific value of a quantity over which the allowance or charge applies.
MinimumValue
Paymentvariation. Minimum. Quantity
Paymentvariation
Minimum
Quantity
QuantityType
0..1
Simple
a minimum quantity over which the allowance or charge applies.
MaximumValue
Paymentvariation. Maximum. Quantity
Paymentvariation
Maximum
Quantity
QuantityType
0..1
Simple
a maximum quantity over which the allowance or charge applies.
MonetaryLimitValue
Paymentvariation. Amount
Paymentvariation
Amount
Amount
AmountType
0..1
Simple
a number representing the monetary limit.
SignificanceCoded
Paymentvariation. Amountsignificance. Identifier
Paymentvariation
Amountsignificance
Identifier
IdentifierType
0..1
Simple
to specify whether the monetary limit value is a lower or upper limit.
MinimumMonetaryValue
Paymentvariation. Minimum. Amount
Paymentvariation
Minimum
Amount
AmountType
0..1
Simple
a minimum amount over which the allowance or charge applies.
MaximumMonetaryValue
Paymentvariation. Maximum. Amount
Paymentvariation
Maximum
Amount
AmountType
0..1
Simple
a maximum amount over which the allowance or charge applies.
Quantity
Paymentvariation. Quantitycalculation
Paymentvariation
Quantitycalculation
Quantitycalculation
QuantitycalculationType
0..1
Simple
the quantity where the calculation is based on quantity.
These could be another -reusable type/class. But included here for simplicity
PercentageAllowanceOrCharge
Paymentvariation. Percentcalculation
Paymentvariation
Percentcalculation
Percentcalculation
PercentcalculationType
0..1
Complex
the allowance or charge based on a percentage
MonetaryValue
Paymentvariation. Monetaryamount
Paymentvariation
Monetaryamount
Monetaryamount
MonetaryamountType
0..1
Complex
the monetary amount of the allowance or charge when charged as a lump sum
Tax
Paymentvariation. Tax
Paymentvariation
Tax
Tax
TaxType
0..n
Complex
any tax levies on the allowance or charge if applicable.
SeqNo
Paymentvariation. Sequence. Value
Paymentvariation
Sequence
Value
NumericType
1..1
Simple
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.
Quantitycalculation
Quantitycalculation
details of a calculation based on quantity.
Quantity
Quantitycalculation. Quantity
Quantitycalculation
Quantity
Quantity
QuantityType
1..1
Simple
the quantity where the calculation is based on quantity.
These could be another -reusable type/class. But included here for simplicity
Rate
Quantitycalculation. Rate
Quantitycalculation
Rate
Rate
RateType
1..1
Simple
the rate where the calculation is based on quantity.
These could be another -reusable type/class. But included here for simplicity
QuantityMonetaryValue
Quantitycalculation. Amount
Quantitycalculation
Amount
Amount
AmountType
0..1
Simple
the allowance or charge where the calculation is based on quantity.
These could be another -reusable type/class. But included here for simplicity
RateOfExchangeDetail
Quantitycalculation. Exchangerate
Quantitycalculation
Exchangerate
Exchangerate
ExchangerateType
0..1
Complex
the allowance or charge where the calculation is based on quantity.
These could be another -reusable type/class. But included here for simplicity
Percentcalculation
Percentcalculation
details of an amount calculated from a percentage
PercentQualifierCoded
Percentcalculation. Basis. Identifier
Percentcalculation
Basis
Identifier
IdentifierType
1..1
Simple
the percentage is calculated using a standard codelist.
derived from X12 378 (Allowance or Charge Percent Qualifier)
Percent
Percentcalculation. Percent
Percentcalculation
Percent
Percent
PercentType
1..1
Simple
the percentage value
PercentageMonetaryValue
Percentcalculation. Amount
Percentcalculation
Amount
Amount
AmountType
1..1
Simple
the value of the percentage allowance or charge.
RateOfExchangeDetail
Percentcalculation. Exchangerate
Percentcalculation
Exchangerate
Exchangerate
ExchangerateType
0..1
Complex
the exchange rate to another currency needs to be set for the monetary value expressed.
Monetaryamount
Monetaryamount
an amount when charged as a lump sum
needed to add exchange rate to AmountType
MonetaryAmount
Monetaryamount. Amount
Monetaryamount
Amount
Amount
AmountType
1..1
Simple
the value of the monetary amount.
RateOfExchangeDetail
Monetaryamount. Exchangerate
Monetaryamount
Exchangerate
Exchangerate
ExchangerateType
0..1
Complex
used if the exchange rate to another currency needs to be set for the monetary value expressed.
Tax
Tax
an amount when charged as a lump sum
TaxFunctionQualifierCoded
Tax. Function. Identifier
Tax
Function
Identifier
IdentifierType
1..1
Simple
the function of the Tax element, e.g. tax, customs duty.
derived from EDIFACT 5283 (Duty or tax or fee function code qualifier)
TaxCategoryCoded
Tax. Category. Identifier
Tax
Category
Identifier
IdentifierType
1..1
Simple
the category of the tax and, by implication, the tax rate that applies. The actual percentage is dependent on the tax jurisdiction.
derived from EDIFACT 5305(Duty or tax or fee category code) and X12 441 (Tax exempt code)
ReasonTaxExemptCoded
Tax. Reason. Identifier
Tax
Reason
Identifier
IdentifierType
0..1
Simple
explains why a TaxCategory is exempt.
derived from X12 441 (Tax exempt code)
TaxTypeCoded
Tax. Type. Identifier
Tax
Type
Identifier
IdentifierType
1..1
Simple
the type of the tax.
derived from EDIFACT 5153 (Duty or tax or fee type name code) and X12 963 (Tax type code)
TaxPercent
Tax. Rate. Percent
Tax
Rate
Percent
PercentType
0..1
Simple
the tax rate as a percentage.
TaxPaymentMethodCoded
Tax. Paymentmeans
Tax
Paymentmeans
Paymentmeans
PaymentmeansType
0..1
Complex
the method by which the tax will be paid.
TaxableAmount
Tax. Invoicecurrency. Taxamount
Tax
Invoicecurrency
Taxamount
Taxamount
TaxamountType
0..1
Complex
the taxable amount in the payment currency.
must use one of either tax amount.
TaxableAmount
Tax. Accountingcurrency. Taxamount
Tax
Accountingcurrency
Taxamount
Taxamount
TaxamountType
0..1
Complex
the taxable amount in the tax accounting currency.
TaxLocation
Tax. Location
Tax
Location
Location
LocationType
0..1
Complex
the location for which the tax applies.
Taxamount
Taxamount
components of the tax amounts
TaxAmount
Taxamount. Taxable. Amount
Taxamount
Taxable
Amount
AmountType
0..1
Simple
the taxable amount (ie what tax rate is applied to)
TaxAmountInTaxAccountingCurrency
Taxamount. Tax. Amount
Taxamount
Tax
Amount
AmountType
1..1
Simple
the tax amount
Note
Note
notes may include the message text, or this text may be referenced with an external identifier or a URL.
GeneralNote
Note. Text
Note
Text
Text
TextType
0..1
Simple
used to provide a note in text form if desired.
NoteID
Note. Identification
Note
Identification
Identifier
IdentifierType
0..1
Simple
an ID assigned to this note. Is an implied attribute.
NoteURL
Note. Universalresource. Identifier
Note
Universalresource
Identifier
IdentifierType
0..1
Simple
the URL that this note is referencing. Is an implied attribute.
Item
Item
identifies the line item for a product
BuyerPartNumber
Item. Buyer. Itemidentifier
Item
Buyer
Itemidentifier
Itemidentifier
ItemidentifierType
0..1
Complex
identification of a product or service as assigned by the buyer.
SellerPartNumber
Item. Seller. Itemidentifier
Item
Seller
Itemidentifier
Itemidentifier
ItemidentifierType
0..1
Complex
identification of a product or service as assigned by the seller of the product or service.
ManufacturerPartNumber
Item. Manufacturer. Itemidentifier
Item
Manufacturer
Itemidentifier
Itemidentifier
ItemidentifierType
0..1
Complex
the identifaction of the manufacturer as assigned by a standards agency.
StandardPartNumber
Item. Standard. Itemidentifier
Item
Standard
Itemidentifier
Itemidentifier
ItemidentifierType
0..1
Complex
the commonly accepted identification of a product or service that is assigend by a standards agency.
SubstitutePartNumbers
Item. Substitute. Itemidentifier
Item
Substitute
Itemidentifier
Itemidentifier
ItemidentifierType
0..n
Complex
a collection of identifications of products or services that are acceptable substitutions for the product of service identified.
OtherItemIdentifiers
Item. Itemidentifier
Item
Itemidentifier
Itemidentifier
ItemidentifierType
0..n
Complex
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
this is the 'context-free' case.
ItemDescription
Item. Description
Item
Description
Text
TextType
0..1
Simple
a free form field that can be used to give a text description of the item.
ListOfItemCharacteristic
Item. Physicalattribute
Item
Physicalattribute
Physicalattribute
PhysicalattributeType
0..n
Complex
a collection of physical attributes other than dimensions of an item.
CommodityCode
Item. Harmonized. Code
Item
Harmonized
Code
CodeType
0..1
Simple
classification of the type of goods using the Harmonized (HS) system code. This is the international notation to categorize individual commodities. These are also known as customs codes.
ListOfDimension
Item. Dimension
Item
Dimension
Dimension
DimensionType
0..n
one or more quantitative measurements of the item.
Quantity
Item. Quantity
Item
Quantity
Quantity
QuantityType
0..1
Complex
the total quantity of the item on this line
MinimumValue
Item. Minimum. Quantity
Item
Minimum
Quantity
QuantityType
0..1
Complex
the total quantity of the item on this line
MaximumValue
Item. Maximum. Quantity
Item
Maximum
Quantity
QuantityType
0..1
Complex
the total quantity of the item on this line
MaxBackOrderQuantity
Item. Maximumbackorder. Quantity
Item
Maximumbackorder
Quantity
QuantityType
0..1
Simple
the maximum quantity of an item that a customer will allow to be back ordered.
OffCatalogFlag
Item. Offcatalog. Indicator
Item
Offcatalog
Indicator
IndicatorType
0..1
Simple
a flag to denote whether the item was ordered from a catalog.
ListOfItemReferences
Item. Informationsource
Item
Informationsource
Informationsource
InformationsourceType
0..n
Complex
one or more references relating to the line item.
CountryOfOrigin
Item. Origincountry. Code
Item
Origincountry
Code
CodeType
0..1
Simple
the country code for the country in which the line item was manufactured.
CountryOfDestination
Item. Destinationcountry. Code
Item
Destinationcountry
Code
CodeType
0..1
Simple
the country code for the country in which the delivery is finally received.
FinalRecipient
Item. Finalrecipient. Party
Item
Finalrecipient
Party
PartyType
0..1
Complex
the person or organization who will ultimately receive the item or items.
ConditionsOfSale
Item. Salescondition
Item
Salescondition
Salescondition
SalesconditionType
0..1
Complex
the conditions of sale for the item
HazardousMaterials
Item. Hazardousgoods
Item
Hazardousgoods
Hazardousgoods
HazardousgoodsType
0..1
Complex
the hazardous information for the line item.
Salescondition
Salescondition
a complete identifiaction for a product or service.
SalesRequirement
Salescondition. Condition. Identifier
Salescondition
Condition
Identifier
IdentifierType
1..n
Simple
any specific sales information relating to the item.
derived from X12 563 (Sales requirement code)
SalesActionCoded
Salescondition. Action. Identifier
Salescondition
Action
Identifier
IdentifierType
0..1
Simple
what action should be undertaken in specific circumstances.
derived from X12 306 (Action code)
SalesActionValue
Salescondition. Value
Salescondition
Value
Text
TextType
0..1
Simple
the value associated with the action code.
Itemidentifier
Itemidentifier
a complete identifiaction for a product or service.
PartID
Itemidentifier. Identification
Itemidentifier
Identification
Identifier
IdentifierType
1..1
Simple
the basic identification for a product or service.
codeset ProductIdentifierQualifierCode used in xCBL3.0
PartIDExt
Itemidentifier. Extension
Itemidentifier
Extension
Text
TextType
0..1
Simple
additional identification for a product or service. An example of this would be a color code for a specific product.
Physicalattribute
Physicalattribute
the physical attributes other than dimensions of an item
ItemCharacteristicCoded
Physicalattribute. Identification
Physicalattribute
Identification
Identifier
IdentifierType
0..1
Simple
the characteristic being described using a standard codelist.
derived from EDIFACT 7081 (Item characteristic code)and X12 750 (Product/process characteristic code)
SurfaceLayerPositionCoded
Physicalattribute. Position. Identifier
Physicalattribute
Position
Identifier
IdentifierType
0..1
Simple
the surface layer or the position of the item using a standard codelist.
derived from EDIFACT 7383 (Surface layer code) and X12 752 (Surface/layer/position code)
ItemCharacteristicValue
Physicalattribute. Description
Physicalattribute
Description
Text
TextType
1..1
Simple
the value of the characteristic
UnitOfMeasurement
Physicalattribute. Unitofmeasure. Identifier
Physicalattribute
Unitofmeasure
Identifier
IdentifierType
0..1
Simple
the unit of measure for the value of the characteristic.
derived from UNECE Rec 20 and X12 355 (Unit or Basis for measurement code)
Harzardousgoods
Harzardousgoods
the hazardous information for the line item.
ListOfHazardousIdentifiers
Hazardousgoods. Hazardousgoodsidentification
Hazardousgoods
Hazardousgoodsidentification
Hazardousgoodsidentification
HazardousgoodsidentificationType
1..n
Complex
identifier of the hazardous material being described.
HazardClassCoded
Hazardousgoods. Class. Identifier
Hazardousgoods
Class
Identifier
IdentifierType
0..1
Simple
code qualifying hazardous class. Values are primary or secondary.
Hazardousgoods. Placardnotation
Hazardousgoods
Placardnotation
Text
TextType
0..1
Simple
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.
HazardousPlacardText
Hazardousgoods. Placardendorsement
Hazardousgoods
Placardendorsement
Text
TextType
0..1
Simple
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.
HazardousReferences
Hazardousgoods. Informationsource
Hazardousgoods
Informationsource
Informationsource
InformationsourceType
0..n
Complex
specific hazardous material reference numbers.
HazardousContact
Hazardousgoods. Contact
Hazardousgoods
Contact
Contact
ContactType
0..1
Complex
the seller's contact for more information on the hazardous information.
HazardNote
Hazardousgoods. Additionalinformation
Hazardousgoods
Additionalinformation
Text
TextType
0..1
Simple
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.).
UNDGNum
Hazardousgoods. Undg. Code
Hazardousgoods
Undg
Code
CodeType
0..1
Simple
a unique serial number assigned within the United Nations to substances and articles contained in a list of the dangerous goods most commonly carried.
UNDG
Flashpoint
Hazardousgoods. Flashpoint. Measure
Hazardousgoods
Flashpoint
Measure
MeasureType
0..1
Simple
the lowest temperature at which the vapor of a combustible liquid can be made to ignite momentarily in air.
Emergency
Hazardousgoods. Emergencytemperature. Measure
Hazardousgoods
Emergencytemperature
Measure
MeasureType
0..1
Simple
the temperature at which emergency procedures apply for the disposal of temperature-controlled goods.
Control
Hazardousgoods. Maximumtemperature. Measure
Hazardousgoods
Maximumtemperature
Measure
MeasureType
0..1
Simple
the maximum temperature at which certain products can be safely transported.
ListOfTemperatureCoded
Hazardousgoods. Temperature. Dimension
Hazardousgoods
Temperature
Dimension
DimensionType
0..n
Complex
a list of one or more temperatures.
HazardousShipmentInformation
Hazardousgoods. Hazardousshipment
Hazardousgoods
Hazardousshipment
Hazardousshipment
HazardousshipmentType
0..1
Complex
information related to the shipping and packaging of hazardous goods.
EMSNum
Hazardousgoods. Maritimeemergency. Identifier
Hazardousgoods
Maritimeemergency
Identifier
IdentifierType
0..1
Simple
a reference to the emergency procedures for ships carrying dangerous goods.
EMS
Mfag
Hazardousgoods. Firstaid. Identifier
Hazardousgoods
Firstaid
Identifier
IdentifierType
0..1
Simple
a reference to the medical first aid guide.
MFAG
Harzardousgoodsidentification
Harzardousgoodsidentification
identifier of the hazardous material being described.
HazardCode
Hazardousgoodsidentification. Hazardousgoods. Identifier
Hazardousgoodsidentification
Hazardousgoods
Identifier
IdentifierType
1..1
Simple
the value of the hazard code.
CodeExtension
Hazardousgoodsidentification. Extension
Hazardousgoodsidentification
Extension
Text
TextType
0..1
Simple
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.
TremCardNum
Hazardousgoodsidentification. Trem. Identifier
Hazardousgoodsidentification
Trem
Identifier
IdentifierType
0..1
Simple
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.
Canada?
Hazardousshipment
Hazardousshipment
information related to the shipping and packaging of hazardous goods.
HazardPackingCoded
Hazardousshipment. Packagingcriteria. Identifier
Hazardousshipment
Packagingcriteria
Identifier
IdentifierType
0..1
Simple
This code identifies the packing criteria for hazardous materials as assigned by IATA/IMDB/ADR/RID.
derived from EDIFACT 8339 (Packing group code)
HazardousShipmentCoded
Hazardousshipment. Regulations. Identifier
Hazardousshipment
Regulations
Identifier
IdentifierType
0..1
Simple
the type of information being passed so that a receiver may format a description of hazardous commodity movements that meets regulatory requirements.
derived from X12 808 (Hazardous material shipment information qualifier)
HazardousShipmentNote
Hazardousshipment. Regulations
Hazardousshipment
Regulations
Text
TextType
0..1
Simple
specific information required by law for hazardous material shipments or any free form text relating to hazardous shipments.
HazardousZoneCoded
Hazardousshipment. Inhalationzone. Identifier
Hazardousshipment
Inhalationzone
Identifier
IdentifierType
0..1
Simple
the Department of Transportation assigned zone designating the Inhalation Toxicity Hazard Zone.
derived from X12 1023 (Hazard zone code)
Delivery
Delivery
the scheduling information for a distinct set of ship from party, ship to party, and transport information
ShipToLocation
Delivery. Shipto. Location
Delivery
Shipto
Location
LocationType
0..1
Complex
the location to which the shipments are to be delivered.
ShipFromLocation
Delivery. Shipfrom. Location
Delivery
Shipfrom
Location
LocationType
0..1
Complex
the location from which the item is to be shipped from.
ListOfScheduleLine
Delivery. Deliveryschedule
Delivery
Deliveryschedule
Deliveryschedule
DeliveryscheduleType
0..n
Complex
a portion of the line item shipment to be sent on particular set of dates with a particular set of transport information.
ItemPackagingReference
Delivery. Reference. Details
Delivery
Reference
Details
PackageReferenceType
0..1
Complex
reference information when detailed packaging information contained in list of package detail is to be associated with the line item.
SimplePackageNote
Delivery. Packaging
Delivery
Packaging
Text
TextType
0..1
Simple
free form text relating to the packaging.
TermsOfDelivery
Delivery. Deliveryterms
Delivery
Deliveryterms
Deliveryterms
DeliverytermsType
0..1
Complex
the information related to delivery including shipment method payment and transport.
CargoClassification
Delivery. Goodsclassification
Delivery
Goodsclassification
Goodsclassification
GoodsclassificationType
0..1
Complex
different conventions for the classification and description of the goods being transported.
Deliveryschedule
Deliveryschedule
shipment to be sent on particular set of dates with a particular set of transport information.
ScheduleLineID
Deliveryschedule. Identification
Deliveryschedule
Identification
Identifier
IdentifierType
0..1
Simple
identifies the schedule line
Quantity
Deliveryschedule. Quantity
Deliveryschedule
Quantity
Quantity
QuantityType
0..1
Simple
the sub-quantity to be shipped on a particular set of dates.
Deliveryschedule. Minimum. Quantity
Deliveryschedule
Minimum
Quantity
QuantityType
0..1
Simple
the minimum sub-quantity to be shipped on a particular set of dates.
Deliveryschedule. Maximum. Quantity
Deliveryschedule
Maximum
Quantity
QuantityType
0..1
Simple
the maximum sub-quantity to be shipped on a particular set of dates.
RequestedDeliveryDate
Deliveryschedule. Requesteddelivery. Datetime
Deliveryschedule
Requesteddelivery
Datetime
DatetimeType
0..1
Simple
the date the buyer requested for delivery.
ListOfOtherDeliveryDate
Deliveryschedule. Delivery. Datetime
Deliveryschedule
Delivery
Datetime
DatetimeType
0..n
Simple
the dates revolving around delivery.This is used to express simple date information that is not tied to particular carriers, transport, etc.
Transport
Deliveryschedule. Shipment
Deliveryschedule
Shipment
Shipment
ShipmentType
0..n
Complex
contains carrier, equipment, and mode of transport information.
TransportReference
Deliveryschedule. Shipment. Identifier
Deliveryschedule
Shipment
Identifier
IdentifierType
0..1
Simple
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.
ListOfShipToSubInformation
Deliveryschedule. Splitlocation
Deliveryschedule
Splitlocation
Splitlocation
SplitlocationType
0..n
Complex
place and quantity information regarding the shipto sub-location.
Splitlocation
Splitlocation
the information for the locations and quantities of the goods for the schedule lines.
ShipToSubLocation
Splitlocation. Delivery. Location
Splitlocation
Delivery
Location
LocationType
1..1
Complex
places inside the ship to location where specific sub deliveries will be made. This is also called a mail stop.
ShipToSubQuantity
Splitlocation. Quantity
Splitlocation
Quantity
Quantity
QuantityType
1..1
Complex
the quantity associated with the ship to sub location.
SubLocationItemPackagingReference
Splitlocation. Package
Splitlocation
Package
Package
PackageType
0..1
Complex
Package
Package
to be used when specifying packaging details related to each shipment to a sub location.
PackageIDReference
Package. Identification
Package
Identification
Identifier
IdentifierType
1..1
Simple
the package ID of the package containing the item
Quantity
Package. Quantity
Package
Quantity
Quantity
QuantityType
0..1
Simple
the quantity should match the values in shipto sub quantity. These values override packaging references supplied at the delivery detail level.
PackageReference
Package. Composite. Package
Package
Composite
Package
Package
PackageType
0..1
Complex
provides a reference for the packaging of the item.
recursive structure
Goodsclassification
Goodsclassification
NatureOfGoods
Goodsclassification. Nature. Code
Goodsclassification
Nature
Code
CodeType
0..1
Simple
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).
OperationalTypeCoded
Goodsclassification. Classification. Identifier
Goodsclassification
Classification
Identifier
IdentifierType
0..1
Simple
the classification of the cargo using a standard codelist.
derived from EDIFACT 7085 (Cargo type classification code)
TypeOfCargo
Goodsclassification. Commodity. Identifier
Goodsclassification
Commodity
Identifier
IdentifierType
0..1
Simple
the commodity code that identifies at a high level what the items are. Set of understood description of goods.
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.