Aggregate Business Information Entities (ABIE)

Table of Contents

UpAddress

Definition A class to define common information related to an address.
XML Structure
  • 0..1Postbox
  • 0..1Floor
  • 0..1StreetName
  • 0..1BuildingName
  • 0..1CityName
  • 0..1PostalZone
  • 0..1Country

Data element spesifications

Element name Postbox
Based on Text
Max length 9
Definition A post office box number registered for postal delivery by a postal service provider.
Element name Floor
Based on Text
Max length 6
Definition An identifiable floor of a building.
Element name StreetName
Based on Name
Definition The name of the street, road, avenue, way, etc. to which the number of the building is attached.
Element name BuildingName
Based on Name
Definition The name of a building.
Element name CityName
Based on Name
Max length 35
Definition The name of a city, town, or village.
Element name PostalZone
Based on Text
Max length 9
Definition The postal identifier for this address according to the relevant national postal service, such as a ZIP code or Post Code.

Aggregate element spesifications

Element name Country
Based on Country
Definition The country in which this address is situated.

UpAllowance Charge

Definition A class to describe information about a charge or discount as applied to a price component.
XML Structure
  • 1ChargeIndicator
  • 0..1AllowanceChargeReasonCode
  • 0..1MultiplierFactorNumeric
  • 1Amount
  • 0..1BaseAmount

Data element spesifications

Element name ChargeIndicator
Based on Indicator
Max length 5
Definition An indicator that this AllowanceCharge describes a charge (true) or a discount (false).
Usage note true => Charge, false => Allowance
Element name AllowanceChargeReasonCode
Based on Allowance Charge Reason Code (External codelist)
Max length 3
Definition A mutually agreed code signifying the reason for this allowance or charge.
Usage note Reason for an allowance or a charge based on UN/ECE 4465 code list.
Subset enumeration

Content restriction

Code stating a reason for an allowance or a charge according to UN/ECE 4465 codelist.
Code Name
19 Trade discount
94 Freight charge
ZZZ Mutually defined
Element name MultiplierFactorNumeric
Based on Numeric
Definition A number by which the base amount is multiplied to calculate the actual amount of this allowance or charge.
Usage note Informative data, which may be stated in addition to an allowance/charge amount.
Element name Amount
Based on Amount
Max length 18
Definition The monetary amount of this allowance or charge to be applied.
Element name BaseAmount
Based on Amount
Max length 18
Definition The monetary amount to which the multiplier factor is applied in calculating the amount of this allowance or charge.
Usage note Informative data, which may be stated in addition to an allowance/charge amount.

UpAttachment

Definition A class to describe an attached document. An attachment can refer to an external document or be included with the document being exchanged.
Usage note

Attachment may not contain both EmbeddedDocumentBinaryObject and ExternReference.

XML Structure

Data element spesifications

Element name EmbeddedDocumentBinaryObject
Based on Binary Object
Definition A binary large object containing an attached document.
Subset enumeration

Attribute: mimeCode

Code stating a MIME media type according to IANA (Internet Assigned Numbers Authority) codelist. Full list of codes found from: http://www.iana.org/assignments/media-types/media-types.xhtml
Code Name
image/vnd.dwg DWG (AutoCAD)
image/vnd.dxf DXF (AutoCAD)
application/pdf PDF (Portable Document Format)

Attribute: encodingCode

Code stating a document encoding.
Code Name
Base 64 Base 64

Aggregate element spesifications

Element name ExternalReference
Based on External Reference
Definition A reference to an attached document that is external to the document(s) being exchanged.
Usage note URL reference to external document.

UpContact

Definition A class to describe a contactable person or department in an organization.
XML Structure
  • 0..1ID
  • 0..1Name
  • 0..1Telephone
  • 0..1ElectronicMail

Data element spesifications

Element name ID
Based on Identifier
Definition An identifier for this contact.
Usage note Mandatory for BuyerContact of BuyerCustomerParty.
Element name Name
Based on Name
Max length 35
Definition The name of this contact. It is recommended that this be used for a functional name and not a personal name.
Element name Telephone
Based on Text
Max length 25
Definition The primary telephone number of this contact.
Element name ElectronicMail
Based on Text
Max length 48
Definition The primary email address of this contact.

UpContract

Definition A class to describe a contract.
XML Structure
  • 1ID

Data element spesifications

Element name ID
Based on Identifier
Max length 35
Definition An identifier for this contract.

UpCountry

Definition A class to describe a country.
XML Structure
  • 1IdentificationCode
  • 0..1Name

Data element spesifications

Element name IdentificationCode
Based on Country Identification Code (External codelist)
Max length 2
Definition A code signifying this country.
Usage note Country identification using ISO 3166 2-letter codes.
Element name Name
Based on Name
Definition The name of this country.

UpCustomer Party

Definition A class to describe a customer party.
XML Structure

Aggregate element spesifications

Element name Party
Based on Party
Definition The customer party itself.
Element name DeliveryContact
Based on Contact
Definition A customer contact for deliveries.
Usage note Allowed for BuyerCustomerParty.
Element name AccountingContact
Based on Contact
Definition A customer contact for accounting.
Usage note Allowed for BuyerCustomerParty and AccountingCustomerParty only.
Element name BuyerContact
Based on Contact
Definition A customer contact for purchasing.
Usage note Allowed for BuyerCustomerParty only. Mandatory for BuyerCustomerParty.

UpDelivery

Definition A class to describe a delivery.
XML Structure

Data element spesifications

Element name Quantity
Based on Quantity
Max length 15
Definition The quantity of items, child consignments, shipments in this delivery.
Usage note Stated only on a line level.Requested delivery quantity. Must be stated when an order line will be split to multiple deliveries.
Subset enumeration

Attribute: unitCode

Code stating a a quantity unit according to UN/ECE rec 20.
Code Name
C62 One, former "PCE"
MTR Meter
MTK Square Meter
KGM Kilogram
LH Hour

Aggregate element spesifications

Element name DeliveryLocation
Based on Location
Definition The delivery location.
Element name RequestedDeliveryPeriod
Based on Period
Definition The period requested for delivery.
Usage note Stated only on a line level.
Element name DeliveryParty
Based on Party
Definition The party to whom the goods are delivered.
Usage note Stated on a header level if only one delivery recipient exists, otherwise stated on a line level.

UpDelivery Terms

Definition A class for describing the terms and conditions applying to the delivery of goods.
XML Structure

Data element spesifications

Element name ID
Based on Identifier
Definition An identifier for this description of delivery terms.
Usage note Delivery Terms identified by INCOTERMS 2010.
Subset enumeration

Attribute: schemeID

Identification of a codelist used for Delivery Terms.
Code Name Definition
INCOTERMS 2010 INCOTERM 2010 Delivery Terms spesified by ICC:n (International Chambers of Commerce) for International Trade.

Aggregate element spesifications

Element name DeliveryLocation
Based on Location
Definition The location for the contracted delivery.
Usage note Delivery location stated as DeliveryLocation/Description.

UpDocument Reference

Definition A class to define a reference to a document.
XML Structure
  • 1ID
  • 0..1IssueDate
  • 0..1DocumentTypeCode
  • 0..1VersionID
  • 0..1Attachment

Data element spesifications

Element name ID
Based on Identifier
Max length 35
Definition An identifier for the referenced document.
Element name IssueDate
Based on Date
Max length 10
Definition The date, assigned by the sender of the referenced document, on which the document was issued.
Element name DocumentTypeCode
Based on Code
Max length 3
Definition The type of document being referenced, expressed as a code.
Usage note Required when context doesn't explicitly define reference type.
Subset enumeration

Content restriction

The document type, expressed as a code.
Code Name Definition
315 Contract (based on UN/ECE 1001) Document/message evidencing an agreement between the seller and the buyer for the supply of goods or services. USAGE NOTE: Use only if explicit element for contract does not exist.
174 Drawing (based on UN/ECE 1001) The document or message is a drawing.

Attribute: listID

Identification of a codelist used for identifying a type of a document or a reference.
Code Name
UN/ECE 1001 UN/ECE 1001 (Document name code)
UN/ECE 1153 UN/ECE 1153 (Reference code qualifier)
Element name VersionID
Based on Identifier
Definition An identifier for the current version of the referenced document.
Usage note Document version / revision

Aggregate element spesifications

Element name Attachment
Based on Attachment
Definition The referenced document as an attachment to the document from which it is referenced.
Usage note Allowed for ItemSpecificationDocumentReference only.

UpExternal Reference

Definition A class to describe an external object, such as a document stored at a remote location.
XML Structure
  • 1URI
  • 0..1MimeCode
  • 0..1FileName

Data element spesifications

Element name URI
Based on Identifier
Definition The Uniform Resource Identifier (URI) that identifies the external object as an Internet resource.
Usage note URL pointing to an external document
Element name MimeCode
Based on Code
Definition A code signifying the mime type of the external object.
Element name FileName
Based on Name
Definition The file name of the external object.

UpItem

Business Term(s) article, product, goods item
Definition A class to describe an item of trade. It includes a generic description applicable to all examples of the item together with optional subsidiary descriptions of any number of actual instances of the type.
Usage note

Item must have atleast one Identifier.

XML Structure

Data element spesifications

Element name Description
Based on Text
Max length 70
Definition Text describing this item.
Element name Name
Based on Name
Definition A short name optionally given to this item, such as a name from a catalogue, as distinct from a description.

Aggregate element spesifications

Element name BuyersItemIdentification
Based on Item Identification
Definition Identifying information for this item, assigned by the buyer.
Element name SellersItemIdentification
Based on Item Identification
Definition Identifying information for this item, assigned by the seller.
Element name ItemSpecificationDocumentReference
Based on Document Reference
Definition A reference to a specification document for this item.
Element name ClassifiedTaxCategory
Based on Tax Category
Definition A tax category applicable to this item.
Element name ItemInstance
Based on Item Instance
Definition A trackable, unique instantiation of this item.

UpItem Identification

Definition A class for assigning identifying information to an item.
XML Structure
  • 1ID
  • 0..1ExtendedID

Data element spesifications

Element name ID
Based on Identifier
Max length 35
Definition An identifier for the item.
Usage note schemeID attribute must be stated for StandardItemIdentification.
Element name ExtendedID
Based on Identifier
Definition An extended identifier for the item that identifies the item with specific properties, e.g., Item 123 = Chair / Item 123 Ext 45 = brown chair. Two chairs can have the same item number, but one is brown. The other is white.
Usage note item revision, e.g. "A", "B", "C"

UpItem Instance

Definition A class to describe a specific, trackable instance of an item.
XML Structure
  • 0..1SerialID

Data element spesifications

Element name SerialID
Based on Identifier
Definition The serial number of this item instance.

UpLine Item

Definition A class to describe a line item.
XML Structure

Data element spesifications

Element name ID
Based on Identifier
Max length 6
Definition An identifier for this line item, assigned by the buyer.
Element name LineStatusCode
Based on Line Status Code (External codelist)
Definition A code signifying the status of this line item with respect to its original state.
Usage note Based on UBL codelist. Supported for LineItem, not for SubLineItem.
Subset enumeration

Content restriction

Code stating a status of a line according to UBL codelist.
Code Name Definition
Added Added Line has been added.
Cancelled Cancelled Line has been cancelled.
Revised Revised / Changed Line has been revised.
NoStatus Not changed Line has no status (hasn't been changed)
Element name Quantity
Based on Quantity
Max length 15
Definition The quantity of items associated with this line item.
Usage note Ordered Quantity
Subset enumeration

Attribute: unitCode

Code stating a a quantity unit according to UN/ECE rec 20.
Code Name
C62 One, former "PCE"
MTR Meter
MTK Square Meter
KGM Kilogram
LH Hour
Element name LineExtensionAmount
Based on Amount
Max length 18
Definition The total amount for this line item, including allowance charges but net of taxes.
Usage note Line net amount. Line amount after allowances and charges excluding VAT.
Element name PartialDeliveryIndicator
Based on Indicator
Definition An indicator that a partial delivery is allowed (true) or not (false).
Usage note By default partial delivery is allowed. Allowed for LineItem, not for SubLineItem.
Element name AccountingCost
Based on Text
Definition The buyer's accounting cost centre for this line item, expressed as text.
Usage note Accounting reference passed on an order and received on an invoice. Allowed for LineItem, not for SubLineItem.

Aggregate element spesifications

Element name Delivery
Based on Delivery
Definition A delivery associated with this line item.
Usage note In case of multiple deliveries, there must be a same delivery location. Allowed for LineItem, not for SubLineItem.
Element name DeliveryTerms
Based on Delivery Terms
Definition Terms and conditions of the delivery associated with this line item.
Usage note DeliveryTerms spesific to this line item. Supported for LineItem, not for SubLineItem.
Element name AllowanceCharge
Based on Allowance Charge
Definition An allowance or charge associated with this line item.
Usage note Allowances and charges spesific to this line item.
Element name Price
Based on Price
Definition The price of the item of trade associated with this line item.
Element name Item
Based on Item
Definition The item of trade associated with this line item.
Element name SubLineItem
Based on Line Item
Definition The subsidiary line items that constitute the main line item, such as in a bill of materials.

UpLocation

Definition A class to describe a location.
Usage note

Must state atleast description or address.

XML Structure

Data element spesifications

Element name Description
Based on Text
Definition Text describing this location.
Usage note Used as a part of DeliveryTerms to state a delivery location.

Aggregate element spesifications

Element name Address
Based on Address
Definition The address of this location.
Usage note Not used as a part of DeliveryTerms.

UpOrder Line

Definition A class to define a line in an order document (e.g., Order, Order Change, or Order Response) describing an item being ordered.
XML Structure

Data element spesifications

Element name Note
Based on Text
Definition Free-form text conveying information that is not contained explicitly in other structures.

Aggregate element spesifications

Element name LineItem
Based on Line Item
Definition The line item itself.
Element name DocumentReference
Based on Document Reference
Definition A reference to a document associated with this order line.
Usage note Additional reference specific to a line item, e.g. a contract number. DocumentTypeCode must be specified to identify document's type.

UpParty

Definition A class to describe an organization, sub-organization, or individual fulfilling a role in a business process.
XML Structure

Aggregate element spesifications

Element name PartyIdentification
Based on Party Identification
Definition An identifier for this party.
Element name PartyName
Based on Party Name
Definition A name for this party.
Element name PostalAddress
Based on Address
Definition The party's postal address.
Element name PartyTaxScheme
Based on Party Tax Scheme
Definition A tax scheme applying to this party.
Usage note Stated for SellerSupplierParty.
Element name PartyLegalEntity
Based on Party Legal Entity
Definition A description of this party as a legal entity.
Usage note Stated for SellerSupplierParty.
Element name Contact
Based on Contact
Definition The primary contact for this party.
Usage note Used with DeliveryParty only.

UpParty Identification

Definition A class to define an identifier for a party.
XML Structure
  • 1ID

Data element spesifications

Element name ID
Based on Identifier
Max length 17
Definition An identifier for the party.
Subset enumeration

Attribute: schemeAgencyID

Identification of an agency maintaining a party identification scheme according to UN/ECE 3055 codelist.
Code Name Definition
91 Assigned by seller Codes and identifiers assigned by a seller or seller's agent.
92 Assigned by buyer Codes and identifiers assigned by a buyer or buyer's agent.

UpParty Legal Entity

Definition A class to describe a party as a legal entity.
XML Structure
  • 1CompanyID

Data element spesifications

Element name CompanyID
Based on Identifier
Max length 17
Definition An identifier for the party as registered within a company registration scheme.

UpParty Name

Definition A class for defining the name of a party.
XML Structure
  • 1Name

Data element spesifications

Element name Name
Based on Name
Definition The name of the party.

UpParty Tax Scheme

Definition A class to describe a taxation scheme applying to a party.
XML Structure
  • 1CompanyID

Data element spesifications

Element name CompanyID
Based on Identifier
Max length 17
Definition An identifier for the party assigned for tax purposes by the taxation authority.
Usage note VAT identifier e.g. "FI12345678"

UpPayment Terms

Definition A class to describe a set of payment terms.
Usage note

Each settlement discount and penalty surcharge is stated as a separate PaymentTerms aggregate.

XML Structure
  • 0..1ID
  • 0..1Note
  • 0..1ReferenceEventCode
  • 0..1SettlementDiscountPercent
  • 0..1Amount
  • 0..1SettlementPeriod

Data element spesifications

Element name ID
Based on Identifier
Definition An identifier for this set of payment terms.
Element name Note
Based on Text
Definition Free-form text conveying information that is not contained explicitly in other structures.
Element name ReferenceEventCode
Based on Code
Max length 3
Definition A code signifying the event during which these terms are offered.
Usage note When exact due date is not known, use this element to specify the event used as a baseline date for calculating the due date. Specify the number of days added to baseline date to form the due date using SettlementPeriod/DurationMeasure.
Subset enumeration

Content restriction

Code stating a a reference event according to UN/ECE 2475 codelist.
Code Name Definition
5 Date of Invoice Date when Invoice was issued.
Element name SettlementDiscountPercent
Based on Percent
Max length 17
Definition The percentage for the settlement discount that is offered for payment under these payment terms.
Element name Amount
Based on Amount
Definition The monetary amount covered by these payment terms.

Aggregate element spesifications

Element name SettlementPeriod
Based on Period
Definition The period during which settlement may occur.

UpPeriod

Definition A class to describe a period of time.
XML Structure
  • 0..1StartDate
  • 0..1EndDate
  • 0..1DurationMeasure

Data element spesifications

Element name StartDate
Based on Date
Max length 10
Definition The date on which this period begins.
Element name EndDate
Based on Date
Max length 10
Definition The date on which this period ends.
Usage note Required as a part of RequestedDeliveryPeriod.
Element name DurationMeasure
Based on Measure
Definition The duration of this period, expressed as an ISO 8601 code.
Usage note Used only with PaymentTerms / ReferenceEventCode to specify the time span (days) from the baseline date to the due date.

UpPrice

Definition A class to describe a price, expressed in a data structure containing multiple properties (compare with UnstructuredPrice).
XML Structure
  • 1PriceAmount
  • 0..1BaseQuantity

Data element spesifications

Element name PriceAmount
Based on Amount
Max length 15
Definition The amount of the price.
Element name BaseQuantity
Based on Quantity
Max length 9
Definition The quantity at which this price applies.
Usage note If BaseQuantity doesn't exists, the default quantity is "1" and default unit of measure "C62" (former "PCE").
Subset enumeration

Attribute: unitCode

Code stating a a quantity unit according to UN/ECE rec 20.
Code Name
C62 One, former "PCE"
MTR Meter
MTK Square Meter
KGM Kilogram
LH Hour

UpProject Reference

Definition A class to define a reference to a procurement project.
XML Structure
  • 1ID

Data element spesifications

Element name ID
Based on Identifier
Definition An identifier for the referenced project.

UpSupplier Party

Definition A class to describe a supplier party.
XML Structure

Aggregate element spesifications

Element name Party
Based on Party
Definition The supplier party itself.

UpTax Category

Definition A class to describe one of the tax categories within a taxation scheme (e.g., High Rate VAT, Low Rate VAT).
XML Structure

Data element spesifications

Element name ID
Based on Identifier
Definition An identifier for this tax category.
Subset enumeration

Content restriction

Code stating a tax category according to UN/ECE 5305 codelist.
Code Name
S Standard rate
Z Zero rated goods
G Free export item, tax not charged

Attribute: schemeID

Identification of a codelist used for identifying a tax category.
Code Name
UN/ECE 5305 UN/ECE 5305 (Duty/Tax/Fee Category Code)
Element name Percent
Based on Percent
Max length 17
Definition The tax rate for this category, expressed as a percentage.
Usage note For example "22%" is presented as "22".

Aggregate element spesifications

Element name TaxScheme
Based on Tax Scheme
Definition The taxation scheme within which this tax category is defined.

UpTax Scheme

Definition A class to describe a taxation scheme (e.g., VAT, State tax, County tax).
XML Structure
  • 1ID

Data element spesifications

Element name ID
Based on Identifier
Definition An identifier for this taxation scheme.
Subset enumeration

Content restriction

Identification of a tax scheme according to UN/ECE 5153 codelist.
Code Name
VAT Value Added Tax

Attribute: schemeID

Identification of a codelist used for identifying a tax scheme.
Code Name
UN/ECE 5153 UN/ECE 5153 (Duty or tax or fee type name code)