Party
Party
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.
defines whether any data is language dependent or not
used to provide information about the language which text relating to this party is written in
contains the name of an entity
contain additional names for the entity
the means for contacting a person or department responsible for receiving of goods or services.
contains the means for contacting a person or department responsible for transporting goods
contains the means for contacting a person or department responsible for managing orders
contains the means for contacting a person or department for other aspects of the Party
describes the taxing information for the buying party.
Language
Language
used to provide information about the language which text is written in
identifies the language using ISO standards
the common name of the language
identifies the locale/location where the language is spoken.
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.
a globaly unique value that is used for referencing the address when specifying specific user information ( unique within partner organization)
the house number or description that identifies the location of a building on a street
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
contains the name of the street.
any additional information to identify the street.
the name of the building or house
the room identifier or the identification of a suite or apartment
the inhouse mail identifier
the department number or name
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
the name of the county or a territorial division of some countries, forming the chief unit of local administration
the name of the district or a part of a town or region
the name or number of the floor
the name of the city or a built up area with a name, defined boundaries and a local government
the category or type of the address. for example, a business or home address. Not the Role of the address
the region within a country using a standard code list
a country or a nation with its own government expressed as an ISO standard code
the value of the timezone. This is an offset from Greenwich Mean Time.
Contact
Contact
contains the means for contacting a person or department.
identifies the department or employee name
holds the identifier of the department or employee
the channel and value of a communication point for the Contact
Communication
Communication
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
identifies the channel of communication or the way or manner in which the communication is made using a standard code set
Location
Location
identifies a place by its function and either an identifier, an identification assigned to an address, or an address
contains the location identifier
contains the name of an entity
contain additional names for the entity
identifies the location by specific co-ordinates
Coordinates
Coordinates
Details geographic co-ordinates
identifies the co-ordinate measuring system (eg. GPS)
specifies the latitude of the location
specifies the longitude of the location.
Shipment
Shipment
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.
specifies the method or type of transportation of this stage of the shipment. Typically this may be sea, air or road.
specifies the means of transportation for this stage of the shipment. Typically this may be by truck, sea- going vessel or aircraft.
the identifier assigned by the agency to the carrier. This identifies the carrier being used for this stage of the shipment.
provides a shipping contract reference to allow supplier to ship goods under specific freight conditions or the carrier to bill against a specific contract.
a code defining the level of service required.
free form text for special shipping instructions.
identifies and describes the equipment to be used for this stage of the shipment. e.g. container details
the transit direction for the shipment.
the amount of transit time.
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
identifies the container for the purposes of referencing within the document domain.
identifies the type of provider for the container
identifies the ownership relationship of the container
the size and type of the container
describes the current disposition of the container
describes whether the container already contains items.
defines whether the refrigeration is on or off.
holds free text information for the equipment.
provides the information regarding the seals affixed to the container
lists measurement information on the container
Seal
Seal
provides the information regarding the seals affixed to any equipment. (e.g. a container)
identifies the seal number of the equipment.
provides information about the issuer of the seal for the equipment.
provides information on the status of the seal.
Measurement
Measurement
a quantitative physical characteristic.
Needed to add min/max to repeated occurrences of QuantityType
the value of the measurement
the minimum value of the range
the maximum value of the range
Deliveryterms
Deliveryterms
defines the terms of delivery
indicates whether the terms relate to e.g. price conditions, delivery conditions, transport conditions, or a combination of these.
the terms of delivery or transport.
the method of payment for transport charges
the location relevant to the terms of delivery specified.
the text description on special conditions or notes on the delivery.
a description of transport.
indicates the responsibility for risk of loss
a text description of the risk of loss information.
Pricing
Pricing
the pricing scheme
contains the value of the unit price.
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).
specifies the start and end date for the pricing if a range dates applies to the pricing scheme.
contains a range of quantity over which the pricing information is applicable. This is commonly used for step pricing scenarios.
specifies the minimum quantity in a range
specifies the maximum quantity in a range
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.
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.
contains details about one payment condition, such as discount eligibility.
specifies the value that pertains to the payment terms.
used to communicate any discounts that may be associated with the payment term.
Discount
Discount
holds discount information
the percent discounted in the terms of the payment. If a discount percent is specified then DiscountAmount should not be used.
the amount to be discounted from the payment value. If a discount amount is specified then DiscountPercent should not be used.
the number of days which the amount has to be paid by in order to receive the discount.
the date the amount has to paid by in order to receive the discount.
the event on which the discount terms are based from using a standard codelist.
the number of days the amount has to be paid in full by.
the specific date that the payment is due in full.
the event on which the net days due are based from using a standard codelist.
Paymentmeans
Paymentmeans
the specific manner in which a payment is to be made.
a valid means of paying the debt.
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.
the system through which the payment is processed using a standard codelist.
information for the financial institution and associated account details from which the funds are originating (Payer's bank details).
information for the financial institution and associated account details to which the funds are being sent (Payee's bank details).
the credit or debit card that is being used for the payment.
Account
Account
the account number or identifier for the account.
the financial institution by code.
the branch of the institution
a secondary account number to identify the account.
the control number to uniquely identify the account at the financial institution.
a code qualifying the type of account.
the main account holder of the account.
a secondary name on the account.
the currency that applies to the account.
a list of coded references to specify an identifier or name associated with the account.
Financialinstitution
Financialinstitution
the financial institution by code.
the name of the financial institution.
the branches of this institution
Branch
Branch
the identification of the branch
the name of the branch
the city where the branch is located.
the country where the branch is based.
Informationsource
Informationsource
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)
the highest level of the associated instance to which the information source applies (e.g. this codeset applies to the entire Order)
the secondary level of the associated instance to which the information source applies (e.g. this codeset applies to the entire Lineitem)
the lowest level of the associated instance to which the information source applies (e.g. this codeset applies to a specific sub-structure)
used to describe a reference using free form text
Creditcard
Creditcard
details of a credit or debit card
the identifying number of the credit or debit card.
the authorization number of the card.
the customer reference number. This is used to enable transmission of customer specific information with the card.
the date up to which the card is valid .
the type of card used for payment
the name of the holder of the card.
Taxscheme
Taxscheme
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.
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.
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 holds the tax location.
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.
QuoteReferenceId is the reference characters which identify the Quote.
QuoteReferenceDatetime holds the date of the Quote.
Contract
Contract
Provides the details of an agreement between trading partners.
ContractId is a unique identifier assigned to the contract.
ContractTypeCode identifies the type of contract.
specifies the dates or duration for which the Contract is valid.
Period
Period
specifies the dates or duration for which an event is effective.
specifies the first point in time on which validity/effectivity occurs.
ValidityperiodEndDate specifies the last point in time for which a validity/effectivity occurs.
A duration of time expressed as a formal code. The Measure. Code inside the Measure. Type should be ISO 8601.
A code that describes the significance of the dates or the duration.
Request
Request
information that can be used to find further information elsewhere.
the reference characters which distinguish the source of information.
the date of the reference information.
Exchangerate
Exchangerate
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)
the target currency of the rate of exchange. This is the currency to which the exchange is being made. (CC Definition)
the currency market from which the exchange rate is taken
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)
the rate of exchange given as target currency : reference currency.
the date the rate of exchange was quoted.
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.
description of the reference or charge usinga codelist
description of the reference or charge using free text
identifies whether an allowance or a charge applies using a standard codelist. Allowances are considered to be discounts.
the basis the allowance or charge is calculated using a standard codelist.
how the allowance or charge will be settled using a standard codelist.
the dates between which the allowance or charge takes effect.
a specific value of a quantity over which the allowance or charge applies.
a minimum quantity over which the allowance or charge applies.
a maximum quantity over which the allowance or charge applies.
a number representing the monetary limit.
to specify whether the monetary limit value is a lower or upper limit.
a minimum amount over which the allowance or charge applies.
a maximum amount over which the allowance or charge applies.
the quantity where the calculation is based on quantity.
the allowance or charge based on a percentage
the monetary amount of the allowance or charge when charged as a lump sum
any tax levies on the allowance or charge if applicable.
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.
the quantity where the calculation is based on quantity.
the rate where the calculation is based on quantity.
the allowance or charge where the calculation is based on quantity.
the allowance or charge where the calculation is based on quantity.
Percentcalculation
Percentcalculation
details of an amount calculated from a percentage
the percentage is calculated using a standard codelist.
the percentage value
the value of the percentage allowance or charge.
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
the value of the monetary amount.
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
the function of the Tax element, e.g. tax, customs duty.
the category of the tax and, by implication, the tax rate that applies. The actual percentage is dependent on the tax jurisdiction.
explains why a TaxCategory is exempt.
the type of the tax.
the tax rate as a percentage.
the method by which the tax will be paid.
the taxable amount in the payment currency.
the taxable amount in the tax accounting currency.
the location for which the tax applies.
Taxamount
Taxamount
components of the tax amounts
the taxable amount (ie what tax rate is applied to)
the tax amount
Note
Note
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.
an ID assigned to this note. Is an implied attribute.
the URL that this note is referencing. Is an implied attribute.
Item
Item
identifies the line item for a product
identification of a product or service as assigned by the buyer.
identification of a product or service as assigned by the seller of the product or service.
the identifaction of the manufacturer as assigned by a standards agency.
the commonly accepted identification of a product or service that is assigend by a standards agency.
a collection of identifications of products or services that are acceptable substitutions for the product of service identified.
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
a free form field that can be used to give a text description of the item.
a collection of physical attributes other than dimensions of an item.
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.
one or more quantitative measurements of the item.
the total quantity of the item on this line
the total quantity of the item on this line
the total quantity of the item on this line
the maximum quantity of an item that a customer will allow to be back ordered.
a flag to denote whether the item was ordered from a catalog.
one or more references relating to the line item.
the country code for the country in which the line item was manufactured.
the country code for the country in which the delivery is finally received.
the person or organization who will ultimately receive the item or items.
the conditions of sale for the item
the hazardous information for the line item.
Salescondition
Salescondition
a complete identifiaction for a product or service.
any specific sales information relating to the item.
what action should be undertaken in specific circumstances.
the value associated with the action code.
Itemidentifier
Itemidentifier
a complete identifiaction for a product or service.
the basic identification for a product or service.
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
the characteristic being described using a standard codelist.
the surface layer or the position of the item using a standard codelist.
the value of the characteristic
the unit of measure for the value of the characteristic.
Harzardousgoods
Harzardousgoods
the hazardous information for the line item.
identifier of the hazardous material being described.
code qualifying hazardous class. Values are primary or secondary.
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.
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.
specific hazardous material reference numbers.
the seller's contact for more information on the hazardous information.
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.).
a unique serial number assigned within the United Nations to substances and articles contained in a list of the dangerous goods most commonly carried.
the lowest temperature at which the vapor of a combustible liquid can be made to ignite momentarily in air.
the temperature at which emergency procedures apply for the disposal of temperature-controlled goods.
the maximum temperature at which certain products can be safely transported.
a list of one or more temperatures.
information related to the shipping and packaging of hazardous goods.
a reference to the emergency procedures for ships carrying dangerous goods.
a reference to the medical first aid guide.
Harzardousgoodsidentification
Harzardousgoodsidentification
identifier of the hazardous material being described.
the value of the hazard code.
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.
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.
Hazardousshipment
Hazardousshipment
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.
the type of information being passed so that a receiver may format a description of hazardous commodity movements that meets regulatory requirements.
specific information required by law for hazardous material shipments or any free form text relating to hazardous shipments.
the Department of Transportation assigned zone designating the Inhalation Toxicity Hazard Zone.
Delivery
Delivery
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.
the location from which the item is to be shipped from.
a portion of the line item shipment to be sent on particular set of dates with a particular set of transport information.
reference information when detailed packaging information contained in list of package detail is to be associated with the line item.
free form text relating to the packaging.
the information related to delivery including shipment method payment and transport.
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.
identifies the schedule line
the sub-quantity to be shipped on a particular set of dates.
the minimum sub-quantity to be shipped on a particular set of dates.
the maximum sub-quantity to be shipped on a particular set of dates.
the date the buyer requested for delivery.
the dates revolving around delivery.This is used to express simple date information that is not tied to particular carriers, transport, etc.
contains carrier, equipment, and mode of transport information.
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.
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.
places inside the ship to location where specific sub deliveries will be made. This is also called a mail stop.
the quantity associated with the ship to sub location.
Package
Package
to be used when specifying packaging details related to each shipment to a sub location.
the package ID of the package containing the item
the quantity should match the values in shipto sub quantity. These values override packaging references supplied at the delivery detail level.
provides a reference for the packaging of the item.
Goodsclassification
Goodsclassification
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).
the classification of the cargo using a standard codelist.
the commodity code that identifies at a high level what the items are. Set of understood description of goods.