Definition | A class to define common information related to an address. |
---|
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. |
Element name | Country |
---|---|
Based on | Country |
Definition | The country in which this address is situated. |
Definition | A class to describe information about a charge or discount as applied to a price component. |
---|
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 restrictionCode stating a reason for an allowance or a charge according to UN/ECE 4465 codelist.
|
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. |
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. |
Element name | EmbeddedDocumentBinaryObject | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Based on | Binary Object | ||||||||||||
Definition | A binary large object containing an attached document. | ||||||||||||
Subset enumeration |
Attribute: mimeCodeCode 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
Attribute: encodingCodeCode stating a document encoding.
|
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. |
Definition | A class to describe a contactable person or department in an organization. |
---|
Element name | ID |
---|---|
Based on | Identifier |
Definition | An identifier for this contact. |
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. |
Definition | A class to describe a contract. |
---|
Element name | ID |
---|---|
Based on | Identifier |
Max length | 35 |
Definition | An identifier for this contract. |
Definition | A class to describe a country. |
---|
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. |
Definition | A class to describe a customer party. |
---|
Element name | Party |
---|---|
Based on | Party |
Definition | The customer party itself. |
Definition | A class to describe a delivery. |
---|
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.Confirmed delivery quantity. Must be stated when an order line will be split to multiple deliveries. | ||||||||||||
Subset enumeration |
Attribute: unitCodeCode stating a a quantity unit according to UN/ECE rec 20.
|
Element name | DeliveryLocation |
---|---|
Based on | Location |
Definition | The delivery location. |
Element name | PromisedDeliveryPeriod |
---|---|
Based on | Period |
Definition | The period promised 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. |
Definition | A class for describing the terms and conditions applying to the delivery of goods. |
---|
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: schemeIDIdentification of a codelist used for Delivery Terms.
|
Element name | DeliveryLocation |
---|---|
Based on | Location |
Definition | The location for the contracted delivery. |
Usage note | Delivery location stated as DeliveryLocation/Description. |
Definition | A class to define a reference to a document. |
---|
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 restrictionThe document type, expressed as a code.
Attribute: listIDIdentification of a codelist used for identifying a type of a document or a reference.
|
Element name | VersionID |
---|---|
Based on | Identifier |
Definition | An identifier for the current version of the referenced document. |
Usage note | Document version / revision |
Element name | Attachment |
---|---|
Based on | Attachment |
Definition | The referenced document as an attachment to the document from which it is referenced. |
Definition | A class to describe an external object, such as a document stored at a remote location. |
---|
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. |
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. |
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. |
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. |
Definition | A class for assigning identifying information to an item. |
---|
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" |
Definition | A class to describe a specific, trackable instance of an item. |
---|
Element name | SerialID |
---|---|
Based on | Identifier |
Definition | The serial number of this item instance. |
Definition | A class to describe a line item. |
---|
Element name | ID |
---|---|
Based on | Identifier |
Max length | 6 |
Definition | An identifier for this line item, assigned by the buyer. |
Element name | SalesOrderID |
---|---|
Based on | Identifier |
Max length | 6 |
Definition | An identifier for this line item, assigned by the seller. |
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 restrictionCode stating a status of a line according to UBL codelist.
|
Element name | Quantity | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Based on | Quantity | ||||||||||||
Max length | 15 | ||||||||||||
Definition | The quantity of items associated with this line item. | ||||||||||||
Usage note | Confirmed Quantity | ||||||||||||
Subset enumeration |
Attribute: unitCodeCode stating a a quantity unit according to UN/ECE rec 20.
|
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. |
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. |
Definition | A class to describe a location. |
---|---|
Usage note |
Must state atleast description or address. |
Element name | Description |
---|---|
Based on | Text |
Definition | Text describing this location. |
Usage note | Used as a part of DeliveryTerms to state a delivery location. |
Element name | Address |
---|---|
Based on | Address |
Definition | The address of this location. |
Usage note | Not used as a part of DeliveryTerms. |
Definition | A class to define a line in an order document (e.g., Order, Order Change, or Order Response) describing an item being ordered. |
---|
Element name | Note |
---|---|
Based on | Text |
Definition | Free-form text conveying information that is not contained explicitly in other structures. |
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. |
Definition | A class to define a reference to an Order. |
---|
Element name | ID |
---|---|
Based on | Identifier |
Max length | 35 |
Definition | An identifier for this order reference, assigned by the buyer. |
Element name | IssueDate |
---|---|
Based on | Date |
Max length | 10 |
Definition | The date on which the referenced Order was issued. |
Definition | A class to describe an organization, sub-organization, or individual fulfilling a role in a business process. |
---|
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. |
Element name | PartyLegalEntity |
---|---|
Based on | Party Legal Entity |
Definition | A description of this party as a legal entity. |
Element name | Contact |
---|---|
Based on | Contact |
Definition | The primary contact for this party. |
Definition | A class to define an identifier for a party. |
---|
Element name | ID | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Based on | Identifier | |||||||||
Max length | 17 | |||||||||
Definition | An identifier for the party. | |||||||||
Subset enumeration |
Attribute: schemeAgencyIDIdentification of an agency maintaining a party identification scheme according to UN/ECE 3055 codelist.
|
Definition | A class to describe a party as a legal entity. |
---|
Element name | CompanyID |
---|---|
Based on | Identifier |
Max length | 17 |
Definition | An identifier for the party as registered within a company registration scheme. |
Definition | A class for defining the name of a party. |
---|
Element name | Name |
---|---|
Based on | Name |
Definition | The name of the party. |
Definition | A class to describe a taxation scheme applying to a party. |
---|
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" |
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. |
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 restrictionCode stating a a reference event according to UN/ECE 2475 codelist.
|
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. |
Element name | SettlementPeriod |
---|---|
Based on | Period |
Definition | The period during which settlement may occur. |
Definition | A class to describe a period of time. |
---|
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 | Mandatory as a part of PromisedDeliveryPeriod. |
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. |
Definition | A class to describe a price, expressed in a data structure containing multiple properties (compare with UnstructuredPrice). |
---|
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: unitCodeCode stating a a quantity unit according to UN/ECE rec 20.
|
Definition | A class to describe a supplier party. |
---|
Element name | Party |
---|---|
Based on | Party |
Definition | The supplier party itself. |
Element name | DespatchContact |
---|---|
Based on | Contact |
Definition | A contact at this supplier party for despatches (pickups). |
Element name | AccountingContact |
---|---|
Based on | Contact |
Definition | A contact at this supplier party for accounting. |
Element name | SellerContact |
---|---|
Based on | Contact |
Definition | The primary contact for this supplier party. |
Definition | A class to describe one of the tax categories within a taxation scheme (e.g., High Rate VAT, Low Rate VAT). |
---|
Element name | ID | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Based on | Identifier | ||||||||||||
Definition | An identifier for this tax category. | ||||||||||||
Subset enumeration |
Content restrictionCode stating a tax category according to UN/ECE 5305 codelist.
Attribute: schemeIDIdentification of a codelist used for identifying a tax category.
|
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". |
Element name | TaxScheme |
---|---|
Based on | Tax Scheme |
Definition | The taxation scheme within which this tax category is defined. |
Definition | A class to describe a taxation scheme (e.g., VAT, State tax, County tax). |
---|
Element name | ID | ||||||||
---|---|---|---|---|---|---|---|---|---|
Based on | Identifier | ||||||||
Definition | An identifier for this taxation scheme. | ||||||||
Subset enumeration |
Content restrictionIdentification of a tax scheme according to UN/ECE 5153 codelist.
Attribute: schemeIDIdentification of a codelist used for identifying a tax scheme.
|