e-Forestry Industry Data Standards Schema
Draft V1.1.0
13 Aug 2008
Specification URIs:
This Version:
http://docs.oasis-open.org/forest/[additional path/filename].html
http://docs.oasis-open.org/forest/[additional path/filename].pdf
Previous Version:
http://docs.oasis-open.org/forest/[additional path/filename].html
http://docs.oasis-open.org/forest/[additional path/filename].pdf
Latest Version:e
http://docs.oasis-open.org/forest/[additional path/filename].html
http://docs.oasis-open.org/forest/[additional path/filename].pdf
Latest Approved Version:
http://docs.oasis-open.org/forest/[additional path/filename].html
http://docs.oasis-open.org/forest/[additional path/filename].pdf
Technical Committee:
Chair(s):
Chris Inglis, Confederation of Forest
Industries (UK) Ltd <chris.inglis@confor.org.uk>
Editor(s):
Ian Logan <ian.logan@straker.com>
Related Work:
This specification replaces or supercedes the eFIDS Trading Schema V3.1.5
Declared XML Namespace(s):
[list namespaces here]
[list namespaces here]
Abstract:
This specification defines the e-Forestry Industry Data Standards (eFIDS) V1.0, which is used to faciliate electronic trading within the forestry sector. It describes the core elements used within the schema and how they relate to each other.
Status:
This document was last revised or approved by the Forest Industry TC on the above date. The level of approval is also listed above. Check the "Latest Version" or "Latest Approved Version" location noted above for possible later revisions of this document.
Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at OASIS Forest Industries TC.
For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http://www.oasis-open.org/committees/forest/ipr.php).
The non-normative errata page for this specification is located at http://www.oasis-open.org/committees/[specific location].
Notices
Copyright © OASIS® 2007. All Rights Reserved.
All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.
OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.
The name "OASIS" is the trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance.
Table of Contents
1.0 Introduction
1.1 Terminology
2.0 Background
3.2 Electronic Document Structure
4.0 Implementation
4.2 Examples
4.2.1 Delivery Notes
4.2.2 Invoices
5.0 eFIDS Schema
5.2 Structured Segment and Element Descriptions
5.2.1 TRADING
5.2.2 DOCUMENT
5.2.3 UNB Segment
5.2.4 UNH Segment
5.2.5 BGM Segment
5.2.6 DTM Segment
5.2.7 FTX Segment
5.2.8 SG01 Segment
5.2.9 SG04 Segment
5.2.10 SG08 Segment
5.2.11 SG10 Segment
5.2.12 SG50 Segment
5.2.13 UNS Segment
5.2.14 CNT Segment
5.2.15 SG71 Segment
5.2.16 SG72 Segment
5.2.17 CUX Segment
5.2.18 UNT Segment
5.3.1 RFF Element
5.3.2 TAX Element
5.3.3 PAT Element
5.3.4 PCD Element
5.3.5 MOA Element
5.3.6 NAD Element
5.3.7 CTA Element
5.3.8 COM Element
5.3.9 TDT Element
5.3.10 LOC Element
5.3.11 LIN Element
5.3.12 PIA Element
5.3.13 IMD Element
5.3.14 MEA Element
5.3.15 QTY Element
5.3.16 ALI Element
5.3.17 GIN Element
5.3.18 PRI Element
5.3.19 DGS Element
5.3.20 PAC Element
5.3.21 PCI Element
5.3.22 DOC Element
5.3.23 QVA Element
5.3.24 ALC Element
5.3.25 RNG Element
5.3.26 RTE Element
5.3.27 SCC Element
5.3.28 FII Element
5.4 Schema Map
6.0 Code Lists
The Electronic Forestry Industry Data Standard (eFIDS) is designed to facilitate electronic trading within the forestry industry. The schema provides an XML framework that allows a variety of different trading documents to be used between various parties, for example: Delivery Notes, Invoices, Self-Bill Invoices, Advice Notes. The schema does not define the documents themselves but simply provides the framework for the documents and their corresponding data. Hence there is no XML element called "Delivery Note" but there is an element whose function is to contain the descriptor for a Delivery Note.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” are to be interpreted as described in [RFC2119].
S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.
The forestry industry in the UK has been working on electronic trading since the 1990s. It was recognised in the early stages that without an agreed data standard, that suited the particular trading conditions, it would be difficult to achieve widespread adoption of electronic trading across the industry. It was therefore agreed that a number of leading organisations in both the Public Sector (Forestry Commission, Scottish Enterprise) and Private Sector (BSW Timber, Norbord, UPM) should collaborate to identify the main aspects of the supply chain through an eBusiness Forum (EBF). It was concluded that the main transactional areas were in the timber despatch and invoicing areas. In order to speed up the development of a standard it was decided to use an existing specification which was originally based upon United Nations-EDIFACT standards and this suited the future development of eFIDS.
The eFIDS standard is designed for use across the complete supply chain from forest to processor to re-seller. It provides the basis for implementation of a range of e-business applications and a number of developments were soon implemented. In order to increase the global appeal of eFIDS it was decided to host them under the OASIS banner and this process was completed in 2005. Within the OASIS Forest Industries Technical Committee the development of the standard has continued. At the same time there has been an increasing number of collaborations using eFIDS in a wider range of circumstances.
Although eFIDS has been developed within the UK, it has always been the intention from the beginning that the standard should be capable of being used across international trading partners.
The main Trading Document types that are typically used in the forestry industry are the Advice Note (or Delivery Note) and the Invoice.
Advice Note
An Advice Note, which may also be known as a Despatch Note, Delivery Note, Consignment Note or similar term, is the documentation that accompanies a load of round or sawn timber. The documentation is usually serially numbered and the number is used as a unique reference within information systems for both Seller and Buyer. Any loads that are weighed will normally generate a Weighbridge Ticket which is referenced to the Advice Note. The Advice Note normally contains details of the product being weighed/transported, the forest it originated from, the carrier that transported it, the Gross weight of the vehicle and the Tare weight of the vehicle.
In the Forestry Industry an Advice Note typically contains details of just one product but occasionally more than one product is transported and this is referred to as a Split Load. In such cases there are either two lines on the Advice Note or two separate Advice Notes (the actual arrangement is by mutual agreement between Buyer and Seller).
In electronic terms the Advice Note record holds the data pertinent to a specific Advice Note.
Invoice
The Invoice or Bill is a commercial document normally issued by a Seller to a Buyer. At a Header Level an Invoice will include the Name & Address of the Seller and their VAT reference, the Name and Address of the Buyer, the Date of Invoice and Tax Point, the Due Date for payment and the totals sums due showing Net Amounts, VAT Codes, VAT Amounts and Total Values. At a lower level, the Line Items, the Invoice will also show the individual transactions that make up the Invoice Total. The individual transactions are normally Advice Notes entries (link to above) showing the Contract, Advice Note reference, Weight and/or Volume, Conversion Factors, Unit Price, Net Value, VAT Code, VAT Value and Total Value of each transaction.
From the point of view of a Seller, an Invoice is a Sales Invoice. From the point of view of a Buyer, an Invoice is a Purchase Invoice.
Within the Forest Industry it is commonplace for Self-billing Invoice systems to operate. In these circumstances the Buyer will provide the Seller with details of what has been received usually because the quantities to be invoiced are determined by the Buyer's Weighbridge. For example, timber will be cut in the Seller's forest, transported to the Buyer's sawmill and weighed on the Buyer's Weighbridge.
Whether conventional invoicing or self-billing invoice operates the information is the same as this is a legal requirement in most countries.
In electronic terms the Invoice record holds all of the data at both Header and transaction level. There is no distinction between a conventional or Self-Billing Invoice as this will be determined by the parties involved in the data exchange.
Other Documents
The eFIDS standard allows the use of many other types of document, for example a Stock List or a Quotation. As long as the document structure contains a Header and Detail Lines, as per 3.2 below, then the document can be accomodated by the eFIDS standard.
3.2 Electronic Document Structure
A typical Trading Document contains both a Header section and a Detail Lines section, as described below. In addition, however, these sections require to be wrapped in further Control sections for the purposes of electronic trading. These Control sections perform functions such as:
* Describing the document type, for example Invoice or Delivery Note
* Providing the facility to contain multiple documents within one XML file
* Error checking
* Recipient and Sender details
The Root element in the Trading Document is called TRADING and the TRADING element will contain one or more DOCUMENT elements. These elements are described in more detail in Section 5, but the outline structure of each DOCUMENT element is as follows:
DOCUMENT Header Outline
The DOCUMENT header contains the following information:
* The document type, for example Invoice
* Sender and Recipient codes
* Date and time of the message
* Trading Document header details, for example: Delivery Note Number, Contract Number, Weighbridge Number
* Payment Terms, if any
* Name and Address details of all parties involved
* Transport details
DOCUMENT Details Outline
Each DOCUMENT contains a section with the details of every Line within the DOCUMENT. This section is capable of handling multiple Lines and does not contain any header information. The details section contains the following information:
* The Line Item number
* Description of the product
* Size and quantity
* Pricing details
* Any additional information
DOCUMENT Trailer Outline
The trailer section contains the following:
* Check sums
* Grand totals
* Currency details
* End of DOCUMENT marker
In addition, within the header and the details sections there is also an element that allows free text to be entered. This could be used by mutual agreement between the parties involved.
4. Implementation
The XML files, resulting from the implementation of the eFIDS schema, can be used in place of existing paper documents with little change to existing business processes. In practice, it has been found that the implementation of the eFIDS schema involves the following:
* Changes to the invoice creation procedures to allow for the option of paper or electronic invoices
* Changes to the input of invoice/delivery notes to allow for electronic batch input
* Additional checking routines to validate the data thus inputted
* Procedures to implement the transferring of XML files from Sender to Recipient (whether via Email, FTP, etc)
* Procedures to check for duplicate/missing XML files
The following are examples of typical delivery notes using the eFIDS Schema.
A single delivery note within the TRADING document:
TODO - add URL
Multiple delivery notes within the TRADING document:
TODO - add URL
The following are examples of typical invoices using the eFIDS Schema.
A single invoice within the TRADING document:
TODO - add URL
Multiple invoices within the TRADING document:
TODO - add URL
TODO List of those elements that are mandatory...
Please note that although several elements are mandatory and so must be included in the final XML document that these elements do not require to contain any data i.e. they will simply be empty elements.
This section contains a detailed description of each element within the schema.
Element: TRADING
Description: Root Element
| Element | Attribute | Condition | Type | Value | Codelist |
| TRADING | xmlns:xsi | Mandatory | Data | http://www.w3.org/2001/XMLSchema-instance | n/a |
| xsi:noNamespaceSchemaLocation | Mandatory | Data | eFIDStradingSchema.XSD | n/a |
Example:
<TRADING
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="eFIDStradingSchema.XSD >
</TRADING>
Comments:
This is the Root element which can have multiple DOCUMENT elements. Hence one TRADING document could contain several Despatch Advice DOCUMENTS and an Invoice DOCUMENT.
5.2.2 DOCUMENT
Element: DOCUMENT
Description: Describes the type of document being used
| Element | Attribute | Condition | Type | Value | Codelist |
| DOCUMENT | DocNumber | Mandatory | Data | Unique | n/a |
| DOCUMENT | DocType | Mandatory | Data |
Each DOCUMENT element contains the following segments:
S.UNB.InterchangeHeader
S.UNH.MessageHeader
S.BGM.BeginningOfMessage
S.DTM.DateTimePeriod
S.FTX.Text
S.SG01 (Header Details)
S.SG04 (Payment Terms)
S.SG08 (Name and Address Details)
S.SG10 (Transport Details)
S.SG50 (Group for all Line Details)
S.UNS.SectionControl
S.CNT.ControlTotal
S.SG71
S.SG72
S.CUX.Currency
S.UNT.MessageTrailer
Example:
<DOCUMENT DocNumber="1" DocType="Despatch Advice">
</DOCUMENT>
Comments:
Each DOCUMENT contains only one type of trading document, for example: Despatch Advice; Invoice. The DocNumber must be unique within each trading document and is typically sequentially numbered from 1 upwards.
5.2.3 UNB Segment
Element: S.UNB.InterchangeHeader
Description: Message Header specifying the sender and intended receiver of this document
| Element | Attribute | Condition | Type | Value | Codelist |
| S.UNB.InterchangeHeader | E.0020.InterchangeControlReference.D | Mandatory | Data | ??? | n/a |
| C.S002.InterchangeSender | E.0004.SenderIdentification.D | Mandatory | Data | ||
| E.0007.PartnerIdentificationCode.Q | Mandatory | Data | ZZZ | ||
| E.0008.AddressForReverseRouting.D | Mandatory | Data | 1000 | ||
| C.S003.InterchangeRecipient | E.0007.PartnerIdentificationCode.Q | Mandatory | Data | ZZZ | |
| E.0010.RecipientIdentification.D | Mandatory | Data | |||
| E.0014.RoutingAddress.D | Mandatory | Data | 2000 |
Example:
<S.UNB.InterchangeHeader
E.0020.InterchangeControlReference.D="???">
<C.S002.InterchangeSender E.0004.SenderIdentification.D="UPMTLF001"
E.0007.PartnerIdentificationCode.Q="ZZZ"
E.0008.AddressForReverseRouting.D="1000" />
<C.S003.InterchangeRecipient E.0010.RecipientIdentification.D="BSWT001"
E.0007.PartnerIdentificationCode.Q="ZZZ" E.0014.RoutingAddress.D="2000"
/>
</S.UNB.InterchangeHeader>
Comments:
Specifies the sender and intended receiver of this document. The SenderIdentification and the RecipientIdentification uniquely identify each party in the transaction. For example, the identification code for the UK Forestry Commission is FORCOM01.
5.2.4 UNH Segment
Element: S.UNH.MessageHeader
Description: Message Header with unique document reference
| Element | Attribute | Condition | Type | Value | Codelist |
| S.UNH.MessageHeader | E.0062.MessageReferenceNo.D | Mandatory | Data | Unique | n/a |
| E.0068.CommonAccessReference.D | Conditional | Date | n/a | ||
| C.S009.MessageIdentifier | E.0065.MessageTypeIdentifier.C | Mandatory | Code | n/a | |
| E.0052.MessageTypeVersionNumber.D | Mandatory | Data | D | ||
| E.0054.MessageTypeReleaseNumber.D | Mandatory | Data | 99A | ||
| E.0051.ControllingAgency.D | Mandatory | Data | UN | ||
| E.0057.AssociationAssigned.C | Conditional | Code | n/a |
Example:
<S.UNH.MessageHeader
E.0062.MessageReferenceNumber.D="65553">
<C.S009.MessageIdentifier E.0065.MessageTypeIdentifier.C="DESPADV"
E.0052.MessageTypeVersionNumber.D="D"
E.0054.MessageTypeReleaseNumber.D="92.1" E.0051.ControllingAgency.D="UN"
E.0057.AssociationAssigned.C="CITD11" />
</S.UNH.MessageHeader>
Comments:
The data contained within the UNH object is predominantly static in that it is common to all invoice messages. The Message Reference Number is dynamic and each invoice will need to be allocated a unique value.
5.2.5 BGM Segment
Element: S.BGM.BeginningOfMessage
Description: Beginning of message indicator specifying the document name
| Element | Attribute | Condition | Type | Value | Codelist |
| S.BGM.BeginningOfMessage | E.1004.DocumentNumber.D | Mandatory | Date | Unique | n/a |
| E.1225.MessageFunction.C | Mandatory | Code | 9 (Original) | 1225 | |
| E.4343.ResponseType.C | Mandatory | Code | 4343 | ||
| C.C002.DocumentName | E.1001.DocumentName.C | Mandatory | Code | 1001 | |
| E.1131.CodeList.Q | Mandatory | Code | ZZZ | 1131 | |
| E.3055.CodeListAgency.C | Mandatory | Code | 6 | 3055 | |
| E.1000.DocumentName.C | Conditional | Code | n/a |
Example:
<S.BGM.BeginingOfMessage E.1004.DocumentNumber.D="1"
E.1225.MessageFunction.C="9" E.4343.ResponseType.C="NA">
<C.C002.DocumentName E.1001.DocumentName.C="INVOIC"
E.1131.CodeList.Q="ZZZ" E.3055.CodeListAgency.C="6" E.1000.DocumentName.C=""
/>
</S.BGM.BeginingOfMessage>
Comments:
Like the UNH segment the BGM segment contains static data with the exception of the Document Number value which needs to be unique.
5.2.6 DTM Segment
Element: S.DTM.DateTimePeriod
Description: Date and Time
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C507.DateTimePeriod | E.2005.DateTimePeriod.Q | Mandatory | Code | 2005 | |
| E.2380.DateTimePeriod.D | Conditional | Data | n/a | ||
| E.2379.DateTimePeriodFormat.Q | Conditional | Code | 2379 |
Example:
<S.DTM.DateTimePeriod>
<C.C507.DateTimePeriod E.2005.DateTimePeriod.Q="137"
E.2380.DateTimePeriod.D="20061024164832" E.2379.DateTimePeriodFormat.Q="204"
/>
</S.DTM.DateTimePeriod>
Comments:
Used to store a variety of dates, for instance Invoice Date, Invoice Due Date, and Message Date. As many as 35 date values can be included in header DTM objects. Alternatively the Document Line DTM object can also be used to specify date values.
This segment exists in the following segments:
S.SG01 Document Level References
S.SG05 Part of SG04 Payment Terms
S.SG50 Line Item Group
S.SG51 Line Item Pricing
S.SG52 Line Item References
S.SG57 Part of SG56 Call-Off Quantities
S.SG62 Quantity Variances
S.SG64 Scheduling Conditions
S.SG71 Grand Totals
Element: S.TTX.Text
Description: To provide free form or coded text information
| Element | Attribute | Condition | Type | Value | Codelist |
| S.TTX.Text | E.4451.TextSubject.Q | Mandatory | Code | 4451 | |
| E.4453.TextFunction.C | Conditional | Code | 3 | 4453 | |
| C.C107.TextReference | E.4441.Text.C | Conditional | Code | ||
| C.C108.Text | E.4440.Text.D | Conditional | Data | n/a | |
| E.4440.Text | Conditional | Data | n/a |
Example:
<S.FTX.Text E.4451.TextSubject.Q="DEL"
E.4453.TextFunction.C="3">
<C.C107.TextReference E.4441.Text.C="DSD" />
<C.C108.Text E.4440.Text.D="Some forest name">
<E.4440.Text Line="" />
</C.C108.Text>
</S.FTX.Text>
Comments:
Used to record additiional text. The element E4441.C must be pre-agreed between sending/receiving parties before use.
Element: S.SG01
Description: Document level references
| Element | Attribute | Condition | Type | Value | Codelist |
| S.RFF.Reference | Conditional | Element | n/a | ||
| S.DTMDateTimePeriod | Conditional | Element | n/a |
Example:
<S.SG01>
<S.RFF.Reference>
<C.C506.Reference E.1153.Reference.Q="IV" E.1154.ReferenceNumber.D="65553"
/>
</S.RFF.Reference>
</S.SG01>
Comments:
This segment allows several header related items to be incorporated using the RFF Segment, for example Invoice Number, Vehicle Registration Number, Weighbridge Ticket Number.
Element: S.SG04
Description: Payment Terms
| Element | Attribute | Condition | Type | Value | Codelist |
| S.PAT.TermsOfPayment | Mandatory | Data | n/a | ||
| S.SG05 | Conditional | n/a |
Example:
<S.SG04>
<S.PAT.TermsOfPaymentBasis E.4279.TermsOfPaymentType.Q="ZZZ">
<C.C110.TermsOfPayment E.4277.TermsOfPaymentIdentification.D=""
E.4276.TermsOfPayment.D="" />
<C.C112.TimeAndTermsInformation E.2475.TermsOfPaymentReference.C="ZZZ"
E.2009.TimeRelation.C="" E.2151.TimePeriodType.C=""
E.2152.NumberOfPeriods.D="" />
</S.PAT.TermsOfPaymentBasis>
<S.SG05>
<S.SG06>
<S.PCD.Percentage>
<C.C501.Percentage />
</S.PCD.Percentage>
</S.SG06>
</S.SG05>
</S.SG04>
Comments:
Element: S.SG08
Description: Name and Address details of parties involved in this DOCUMENT i.e. Customer, Supplier, Delivery Agent, etc
| Element | Attribute | Condition | Type | Value | Codelist |
| S.NAD.NameAndAddress | Mandatory | Data | n/a | ||
| S.RFF.Reference | Conditional | ||||
| S.SG09 | Conditional | ||||
| S.LOC.LocationIdentification | Conditional | ||||
| S.FII.FinancialInstitutionInformation | Conditional |
Example:
<S.SG08>
<S.NAD.NameAndAddress E.3035.Party.Q="BY">
<S.RFF.Reference>
<C.C506.Reference E.1153.Reference.Q="VA" E.1154.ReferenceNumber.D="370
6695 30" />
</S.RFF.Reference>
<C.C082.PartyIdentification E.3039.PartyIdentification.D="UPMTLF001"
E.3055.CodeListRespAgency.C="06" />
<C.C058.NameAndAddress E.3124.NameAndAddress.D="Tilhill Forestry" />
<C.C059.Street E.3042.StreetNumberAndName.D="Kings Park House, Laurelhill"
E.3164.CityOrTown.D="Stirling" E.nnnn.County.D="Stirlingshire"
E.3251.PostCode.D="FK7 9NS" E.3207.Country.C="GB" />
</S.NAD.NameAndAddress>
<S.SG09>
<S.CTA.ContactInformation>
<C.C056.DepartmentOrEmployee />
</S.CTA.ContactInformation>
</S.SG09>
<S.LOC.LocationIdentification/>
<S.FII.FinancialInstitutionInformation/>
</S.SG08>
Comments:
This also contains the SG09 segment which is a group
to store contact names and multiple communication methods i.e. Phone, Mobile,
Fax, eMail, etc.
The LOC segment can repeat up to 10 times while the FII segment can repeat up
to 5 times.
Element: S.SG10
Description: Group to store modes of transport and, where required, specific locations for this transport mode
| Element | Attribute | Condition | Type | Value | Codelist |
| S.TDT.Transport | Mandatory | Data | n/a | ||
| S.LOC.LocationIdentification | Conditional |
Example:
S.SG10>
<S.TDT.Transport E.8051.Stage.Q="1"
E.8028.ConveyanceReferenceNumber.D="">
<C.C220.ModeOfTransport E.8067.Mode.C="3" />
<C.C228.MeansOfTransport E.8179.MeansOfTransportIdentification.C="31"
/>
<C.C040.TransportCarrier E.3127.CarrierIdentification.D=""
E.3128.CarrierName.D="A haulage company" E.3055.CodeListAgency.C="6" />
</S.TDT.Transport>
</S.SG10>
Comments:
The NAD element is usually used in place of the LOC element.
Element: S.SG50
Description: Group containing all other groups and elements per Line Item
| Element | Attribute | Condition | Type | Value | Codelist |
| S.LIN.LineItem | Mandatory | n/a | |||
| S.PIA.AdditionalProductIdentification | Conditional | ||||
| S.IMD.ItemDescription | Mandatory | ||||
| S.MEA.Measurement | Conditional | ||||
| S.QTY.Quantity | Mandatory | ||||
| S.ALI.AdditionalInformation | Conditional | ||||
| S.DTM.DateTimePeriod | Conditional | ||||
| S.GIN.GoodsIdentityNumber | Conditional | ||||
| S.FTX.Text | Conditional | ||||
| S.MOA.MonetaryAmount | Mandatory | ||||
| S.SG51 | Conditional | ||||
| S.SG52 | Conditional |
Example:
Please see each individual segment for examples
Comments:
This is the segment that repeats for every Item Line in the DOCUMENT.
Element: S.UNS.SectionControl
Description: Service section used to separate the SG50 Line Items segment from the trailer sections
| Element | Attribute | Condition | Type | Value | Codelist |
| S.UNS.SectionControl | E.0081.SectionIdentification.D | Mandatory | Data | S | 0081 |
Example:
<S.UNS.SectionControl E.0081.SectionIdentification.D="S" />
Comments:
This object specifies a break between message sections. The code list does not specify the actual codes used but these are:
D - Header/detail section separation
S - Detail/summary section separation
Element: S.CNT.ControlTotal
Description: Checks sum totals to verify that this document is complete
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C270.Control | E.6069.Control.Q | Mandatory | Code | 6069 | |
| E.6066.Control.D | Mandatory | Data | n/a | ||
| E.6411.UnitOfMeasurement.Q | Conditional |
Example:
<S.CNT.ControlTotal>
<C.C270.Control />
</S.CNT.ControlTotal>
Comments:
Typically not used.
Element: S.SG71
Description: Grand totals for the DOCUMENT
| Element | Attribute | Condition | Type | Value | Codelist |
| S.MOA.MonetaryAmount | Mandatory | ||||
| S.RFF.Reference | Conditional | ||||
| S.DTM.DateAndTime | Conditional |
Example:
<S.SG71>
<S.MOA.MonetaryAmount>
<C.C516.MonetaryAmount E.5025.MonetaryAmountType.Q="39"
E.5004.MonetaryAmount.D="1234.50" E.4405.Status.C="45" />
</S.MOA.MonetaryAmount>
<S.RFF.Reference>
<C.C506.Reference E.1153.Reference.Q="" E.1154.ReferenceNumber.D=""
/>
</S.RFF.Reference>
<S.DTM.DateTimePeriod>
<C.C507.DateTimePeriod E.2005.DateTimePeriod.Q=""
E.2380.DateTimePeriod.D="" E.2379.DateTimePeriodFormat.Q="" />
</S.DTM.DateTimePeriod>
</S.SG71>
Comments:
This section allows for the summary totals including and excluding Sales Tax (VAT).
Element: S.SG72
Description: Grand totals of Sales Tax (VAT) for this DOCUMENT
| Element | Attribute | Condition | Type | Value | Codelist |
| S.TAX.DutyTaxFee | Conditional | ||||
| S.MOA.MonetaryAmount | Conditional |
Example:
<S.SG72>
<S.TAX.DutyTaxFee E.5283.DutyTaxFeeFunction.Q="9">
<C.C241.DutyTaxFeeType E.5153.DutyTaxFeeType.C="VAT" />
<C.C243.DutyTaxFee E.5278.DutyTaxFeeRate.D="17.5"
E.5305.DutyTaxFeeCategory.C="S" />
</S.TAX.DutyTaxFee>
<S.MOA.MonetaryAmount>
<C.C516.MonetaryAmount E.5025.MonetaryAmountType.Q="39"
E.5004.MonetaryAmount.D="2266.71" E.4405.Status.C="45" />
<C.C516.MonetaryAmount E.5025.MonetaryAmountType.Q="1"
E.5004.MonetaryAmount.D="396.68" E.4405.Status.C="45" />
<C.C516.MonetaryAmount E.5025.MonetaryAmountType.Q="9"
E.5004.MonetaryAmount.D="2663.39" E.4405.Status.C="45" />
</S.MOA.MonetaryAmount>
</S.SG72>
Comments:
This section allows for the summary totals of Sales Tax (VAT).
Element: S.CUX.Currency
Description: Default Currency unless specified at line level
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C504.CurrencyDetails | E.6347.CurrencyDetail.Q | Mandatory | Code | 1 | 6347 |
| E.6345.Currency.C | Conditional | Data | ISO 4217 | ||
| E.6343.Currency.Q | Conditional | Code | 4 | 6343 | |
| E.6348.CurrencyRateBase.D | Conditional | Data | n/a | ||
| E.5402.RateOfExchange.D | Conditional | Data | n/a | ||
| E.6341.CurrencyMarketExchange.C | Conditional | Code | LNF | 6341 |
Example:
<S.CUX.Currency>
<C.C504.CurrencyDetails E.6347.CurrencyDetail.Q="1"
E.6345.Currency.C="GBP" E.6343.Currency.Q="4" E.6348.CurrencyRateBase.D=""
E.5402.RateOfExchange.D="" E.6341.CurrencyMarketExchange.C="" />
</S.CUX.Currency>
Comments:
The last three attributes are typically not used.
This segment exists in the following segments:
S.SG51 Line Item Pricing
Element: S.UNT.MessageTrailer
Description: End of DOCUMENT trailer
| Element | Attribute | Condition | Type | Value | Codelist |
| S.UNT.MessageTrailer | E.0074.TotalSegmentCount.D | Mandatory | Data | n/a | |
| E.0062.MessageReferenceNumber.D | Mandatory | Data | Unique |
Example:
<S.UNT.MessageTrailer E.0074.TotalSegmentCount.D="31"
E.0062.MessageReferenceNumber.D="135988" />
Comments:
This segment specifies the total number of segments used within the message (i.e. the DOCUMENT), inclusive of the UNH and UNT segments. The MessageReferenceNumber should be the same as the reference number used in the UNH segment.
Element: S.RFF.Reference
Description: Reference
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C506.Reference | E.1153.Reference.Q | Mandatory | Code | 1153 | |
| E.1154.ReferenceNumber.D | Conditional | Data | n/a |
Example:
<S.RFF.Reference>
<C.C506.Reference E.1153.Reference.Q="IV" E.1154.ReferenceNumber.D="65553"
/>
</S.RFF.Reference>
Comments:
Used to store a wide variety of reference data, the RFF object can have a maximum of 10 instances – code list 1153 contains a huge list of potential descriptors and ZZZ can be used to denote a mutually defined reference value. Several additional forestry reference codes have been agreed on:
ZFP - FSC Percentage
ZCC - Chain of Custody Reference Number
ZCF - Conversion Factor
ZML - Measured Load Indicator
ZCY - Certification Indicator
ZRF - Reject Flag
ZRR - Reject Reason
ZOI - Original Invoice Number
This segment exists in the following segments:
S.SG01 Document Header
S.NAD Name and Address
S.SG52 Line Item
S.SG71 Document Footer
Element: S.TAX.DutyTaxFee
Description: Sales or Duty Tax Amount
| Element | Attribute | Condition | Type | Value | Codelist |
| S.TAX.DutyTaxFee | E.5283.DutyTaxFeeFunction.Q | Mandatory | Data | 9 | 5283 |
| C.C241.DutyTaxFeeType | E.5153.DutyTaxFeeType.C | Conditional | Code | VAT | 5253 |
| C.C243.DutyTaxFee | E.5278.DutyTaxFeeRate.D | Conditional | Data | n/a | |
| E.5305.DutyTaxFeeCategory.C | Conditional | Code | S | 5305 |
Example:
<S.TAX.DutyTaxFee E.5283.DutyTaxFeeFunction.Q="9">
<C.C241.DutyTaxFeeType E.5153.DutyTaxFeeType.C="VAT" />
<C.C243.DutyTaxFee E.5278.DutyTaxFeeRate.D="17.5"
E.5305.DutyTaxFeeCategory.C="S" />
</S.TAX.DutyTaxFee>
Comments:
Object to be used to stote the Value Added Tax (VAT) or similar Sales or Duty Tax parameters for the DOCUMENT. To show that different Item Lines have different Tax rates then use DutyTaxFeeCategory "A" - Mixed Rate Tax.
This segment exists in the following segments:
S.SG18 Tax Allowance/Charge
S.SG58 Line Item Tax
S.SG72 Summary Tax
Element: S.PAT.TermsOfPaymentBasis
Description: Terms of payment
| Element | Attribute | Condition | Type | Value | Codelist |
| S.PAT.TermsOfPaymentBasis | E.4279.TermsOfPaymentType.Q | Mandatory | Code | 4279 | |
| C.C110.TermsOfPayment | E.4277.TermsOfPaymentIdentification.D | Mandatory | Data | UN/ECE 17 | |
| E.4276.TermsOfPayment.D | Conditional | Data | |||
| C.C112.TimeAndTermsInformation | E.2475.TermsOfPaymentReference.C | Mandatory | Code | 2475 | |
| E.2009.TimeRelation.C | Conditional | Code | 2009 | ||
| E.2151.TimePeriodType.C | Conditional | Code | 2151 | ||
| E.2152.NumberOfPeriods.D | Conditional | Data |
Example:
<S.PAT.TermsOfPaymentBasis
E.4279.TermsOfPaymentType.Q="ZZZ">
<C.C110.TermsOfPayment E.4277.TermsOfPaymentIdentification.D=""
E.4276.TermsOfPayment.D="" />
<C.C112.TimeAndTermsInformation E.2475.TermsOfPaymentReference.C="ZZZ"
E.2009.TimeRelation.C="" E.2151.TimePeriodType.C=""
E.2152.NumberOfPeriods.D="" />
</S.PAT.TermsOfPaymentBasis>
Comments:
.
This segment exists in the following segments:
SG04 Payment Terms
Element: S.PCD.Percentage
Description: Percentage Details
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C501.Percentage | E.5245.Percentage.Q | Mandatory | Code | 5245 | |
| E.5482.Percentage.D | Conditional | Data | n/a |
Example:
<S.PCD.Percentage>
<C.C501.Percentage E.5245.Percentage.Q="2"E.5482.Percentage.D="5" />
</S.PCD.Percentage>
Comments:
Used if Allowance or Charge is to be expressed as a percentage.
This segment exists in the following segments:
SG06 Part of SG04 Payment Terms
SG15 Part of SG63 Allowance Charges
Element: S.MOA.Amount
Description: Monetary Amount
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C516.MonetaryAmount | E.5025.MonetaryAmountType.Q | Mandatory | Code | 5025 | |
| E.5004.MonetaryAmount.D | Mandatory | Data | n/a | ||
| E.4405.Status.C | Mandatory | Code | 45 | 4405 |
Example:
<S.MOA.MonetaryAmount>
<C.C516.MonetaryAmount E.5025.MonetaryAmountType.Q="38"
E.5004.MonetaryAmount.D="111.99" E.4405.Status.C="45" />
<C.C516.MonetaryAmount E.5025.MonetaryAmountType.Q="1"
E.5004.MonetaryAmount.D="19.6" E.4405.Status.C="45" />
<C.C516.MonetaryAmount E.5025.MonetaryAmountType.Q="39"
E.5004.MonetaryAmount.D="131.59" E.4405.Status.C="45" />
</S.MOA.MonetaryAmount>
Comments:
Used to store monetary amounts. Can be used in the Header, Line Items and Trailer.
This segment exists in the following segments:
SG06 Part of SG04 Payment Terms
SG58 Line Item Tax
SG16 Part of SG63 Allowance Charges
SG18 Part of SG63 Allowance Charges
SG71 Summary Amounts
SG72 Summary Tax Amounts
Element: S.NAD.NameAndAddress
Description: Name and Address
| Element | Attribute | Condition | Type | Value | Codelist |
| S.NAD.NameAndAddress | E.3035.Party.Q | Mandatory | Code | 3035 | |
| S.RFF.Reference | Conditional | ||||
| C.C082.PartyIdentification | E.3039.PartyIdentification.D | Mandatory | Data | n/a | |
| E.1131.CodeList.Q | Conditional | Code | ZZZ | 1131 | |
| E.3055.CodeListRespAgency.C | Conditional | Code | 6 | 3055 | |
| C.C058.NameAndAddress | E.3124.NameAndAddress.D | Mandatory | Data | n/a | |
| C.C059.Street | E.3042.StreetNumberAndName.D | Conditional | Data | n/a | |
| E.3164.CityOrTown.D | Conditional | Data | n/a | ||
| E.3229.County.D | Conditional | Data | n/a | ||
| E.3251.PostCode.D | Conditional | Data | n/a | ||
| E.3207.Country.C | Conditional | Code | ISO 3166 |
Example:
<S.NAD.NameAndAddress E.3035.Party.Q="SU">
<S.RFF.Reference>
<C.C506.Reference E.1153.Reference.Q="VA" E.1154.ReferenceNumber.D="GD305"
/>
</S.RFF.Reference>
<C.C082.PartyIdentification E.3039.PartyIdentification.D="FORCOM001"
E.1131.CodeList.Q="ZZZ" E.3055.CodeListRespAgency.C="06" />
<C.C058.NameAndAddress E.3124.NameAndAddress.D="FORESTRY COMMISSION"
/>
<C.C059.Street E.3042.StreetNumberAndName.D="WALES REGION"
E.3164.CityOrTown.D="EDINBURGH" E.3229.County.D="" E.3251.PostCode.D="EH12
7YF" E.3207.Country.C="GB" />
</S.NAD.NameAndAddress>
Comments:
This segment is used to store the details of Supplier, Customer, Invoice Address, Delivery Point, etc.
This segment exists in the following segments:
SG08 Header section
SG59 Part of SG50 Line Item
Element: S.CTA.ContactInformation
Description: Contact Details
| Element | Attribute | Condition | Type | Value | Codelist |
| S.CTA.ContactInformation | E.3139.ContactFunction.C | Conditional | Code | 3139 | |
| C.C506.DepartmentOrEmployee | E.3413.DepartmentOrEmployeeIdentification.Q | Conditional | Code | Internal ID | |
| E.3412.DepartmentOrEmployee.D | Conditional | Data | n/a |
Example:
<S.CTA.ContactInformation
E.3139.ContactFunction.C="SA">
<C.C056.DepartmentOrEmployee
E.3413.DepartmentOrEmployeeIdentification.Q=""
E.3412.DepartmentOrEmployee.D = "John Brown"/>
</S.CTA.ContactInformation>
Comments:
Although this object is mandatory the fields are not. It would be useful to include a technical contact's details to act as an immediate point of contact regarding the message. The E.3413.DepartmentOrEmployeeIdentification.Q Internal ID of the contact would not normally be known out-with an organisation.
This segment exists in the following segments:
SG09 Group to store contact details
Element: S.COM.CommunicationContact
Description: Communication methods e.g. Phone, Fax, Mobile, eMail, etc.
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C076.CommunicationContact | E.3148.CommunicationNumber.D | Conditional | Data | n/a | |
| E.3155.CommunicationChannel.Q | Conditional | Code | 3155 |
Example:
<C.C076.CommunicationContact
E.3148.CommunicationNumber.D="123 456 7890"
E.3155.CommunicationChannel.Q="TE"
C.C076.CommunicationContact/>
Comments:
This element can be repeated up to 5 times.
This segment exists in the following segments:
SG09 Group to store contact details
Element: S.TDT.Transport
Description: Mode of Transport
| Element | Attribute | Condition | Type | Value | Codelist |
| S.TDT.Transport | E.8051.Stage.Q | Mandatory | Code | 1 | 8051 |
| E.8028.ConveyanceReferenceNumber.D | Conditional | Data | n/a | ||
| C.C220.ModeOfTransport | E.8067.Mode.C | Conditional | Code | 3 | UN/ECE 19 |
| C.C228.MeansOfTransport | E.8179.MeansOfTransportIdentification.C | Conditional | Code | 31 | 8179 |
| C.C040.TransportCarrier | E.3127.CarrierIdentification.D | Conditional | Data | n/a | |
| E.3128.CarrierName.D | Conditional | Data | n/a | ||
| E.3055.CodeListAgency.C | Conditional | Code | 6 | 3055 |
Example:
- <S.TDT.Transport E.8051.Stage.Q="1"
E.8028.ConveyanceReferenceNumber.D="">
<C.C220.ModeOfTransport E.8067.Mode.C="3" />
<C.C228.MeansOfTransport E.8179.MeansOfTransportIdentification.C="31"
/>
<C.C040.TransportCarrier E.3127.CarrierIdentification.D=""
E.3128.CarrierName.D="John Brown and Company" E.3055.CodeListAgency.C="6"
/>
</S.TDT.Transport>
Comments:
Describes the transportation of goods between the parties.
This segment exists in the following segments:
SG10 Transport Segment
Element: S.LOC.LocationIdentification
Description: Location Information
| Element | Attribute | Condition | Type | Value | Codelist |
| S.LOC.LocationIdentification | E.3227.Location.Q | Mandatory | Code | 3227 | |
| C.C517.LocationIdentification | E.3225.LocationIdentification.D | Conditional | Data | n/a | |
| E.3055.CodeListAgency.C | Conditional | Code | 6 | 3055 | |
| E.3224.Location.D | Conditional | Data | n/a |
Example:
<S.LOC.LocationIdentification
E.3227.Location.Q="88">
<C.C517.LocationIdentification
E.3225.LocationIdentification.D="Weighbridge"
E.3055.CodeListAgency.C="6" E.3224.Location.D="ABC sawmill" />
</S.LOC.LocationIdentification>
Comments:
Although this is a Mandatory object, all location information will normally be stored in the NAD segment.
This segment exists in the following segments:
SG08 Name and Address
SG10 Transport Segment
Element: S.LIN.LineItem
Description: Line Item
| Element | Attribute | Condition | Type | Value | Codelist |
| S.LIN.LineItem | E.1082.LineItemNumber.D | Conditional | Data | n/a | |
| E.1229.ActionRequest.C | Conditional | Code | 4 | 1229 | |
| C.C212.ItemNumberIdentification | E.7140.ItemNumber.D | Conditional | Data | n/a | |
| E.5495.SubLineIndicator.C | Conditional | Code | 1 | 5495 | |
| E.1222.ConfigurationLevel.D | Conditional | Data | n/a | ||
| E.7083.Configuration.C | Conditional | Code | A | 7083 | |
| E.7143.ItemNumberType.C | Conditional | Code | 7143 |
Example:
<S.LIN.LineItem E.1082.LineItemNumber.D="1"
E.1229.ActionRequest.C="4">
<C.C212.ItemNumberIdentification E.7140.ItemNumber.D=""
E.5495.SubLineIndicator.C="1"
E.1222.ConfigurationLevel.D="" E.7083.Configuration.C="A"
E.7143.ItemNumberType.C="SA" />
</S.LIN.LineItem>
Comments:
Used to uniquely identify the line item.
This segment exists in the following segments:
SG50 Line Item Group
Element: S.PIA.AdditionalProductIdentification
Description: Additional Product Identification
| Element | Attribute | Condition | Type | Value | Codelist |
| S.PIA.AdditionalProductIdentification | E.4347.ProductIdentificationFunction.Q | Conditional | Code | 1 | 4347 |
| C.C212.ItemNumberIdentification | E.7140.ItemNumber.D | Conditional | Data | n/a | |
| E.5495.SubLineIndicator.C | Conditional | Code | 1 | 5495 | |
| E.1222.ConfigurationLevel.D | Conditional | Data | n/a | ||
| E.7083.Configuration.C | Conditional | Code | A | 7083 | |
| E.7143.ItemNumberType.C | Conditional | Code | 7143 |
Example:
<S.PIA.AdditionalProductIdentification
E.4347.ProductIdentificationFunction.Q="1"><C.C212.ItemNumberIdentification
E.7140.ItemNumber.D="LOGPOLE" E.5495.SubLineIndicator.C="1"
E.1222.ConfigurationLevel.D="" E.7083.Configuration.C="A"
E.7143.ItemNumberType.C="BP" />
</S.PIA.AdditionalProductIdentification>
Comments:
This segment can be repeated up to 25 times. It can be used for additional details on the Line Item if the LIN segment or the IMD segments are not adequate.
This segment exists in the following segments:
SG50 Line Item Group
Element: S.IMD.ItemDescription
Description: Item Description
| Element | Attribute | Condition | Type | Value | Codelist |
| S.IMD.ItemDescription | E.7077.ItemDescriptionType.C | Conditional | Code | A | 7077 |
| E.7081.ItemCharacteristics.C | Conditional | Code | 8 | 7081 | |
| C.C273.ItemDescription | E.7009.ItemDescriptionIdentification.C | Conditional | Code | 4 | 7009 |
| E.7008.ItemDescription.D | Conditional | Data | n/a |
Example:
<S.IMD.ItemDescription E.7077.ItemDescriptionType.C="A"
E.7081.ItemCharacteristics.C="8">
<C.C273.ItemDescription E.7009.ItemDescriptionIdentification.C="4"
E.7008.ItemDescription.D="SS, GRN SHORT BAR, 2.40 M, 14 CM" />
</S.IMD.ItemDescription>
Comments:
This segment can be repeated up to 10 times. It can be used to describe the item in a free text format. The code list 7081 needs to be used on this segment to qualify the description in E.7008.ItemDescription.D.
This segment exists in the following segments:
SG50 Line Item Group
Element: S.MEA.Measurement
Description: Measurement
| Element | Attribute | Condition | Type | Value | Codelist |
| S.MEA.Measurement | E.6311.MeasurementApplication.Q | Mandatory | Code | AAA | 6311 |
| C.C502.Measurement | E.6313.MeasurementDimension.C | Mandatory | Code | 6313 | |
| C.C174.ValueRange | E.6411.UnitOfMeasurement.Q | Conditional | Code | TNE | UN/ECE 20 |
| E.6162.RangeMinimum.D | Conditional | Data | n/a | ||
| E.6152.RangeMaximum.D | Conditional | Data | n/a | ||
| E.6314.Measurement.D | Conditional | Data | n/a |
Example:
<S.MEA.Measurement
E.6311.MeasurementApplication.Q="AAA">
<C.C502.Measurement E.6313.MeasurementDimension.C="N" />
<C.C174.ValueRange E.6411.UnitOfMeasurement.Q="TNE"
E.6162.RangeMinimum.D="0" E.6152.RangeMaximum.D="9999999"
E.6314.Measurement.D="25.66" />
</S.MEA.Measurement>
Comments:
This segment can be repeated up to 5 times. It allows for the use of various measures like Net, Gross, Max Vehicle Weight, Moisture Content, Tonne, Metre, Metre Cubed, etc.
This segment exists in the following segments:
SG50 Line Item Group
SG55 part of SG54 Packaging Instructions
SG60 Package
Element: S.QTY.Quantity
Description: Quantity
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C186.Quantity | E.6063.Quantity.Q | Mandatory | Code | 6063 | |
| E.6060.Quantity.D | Mandatory | Data | n/a | ||
| E.6411.UnitOfMeasurement.Q | Conditional | Code | UN/ECE 20 |
Example:
<S.QTY.Quantity>
<C.C186.Quantity E.6063.Quantity.Q="47" E.6060.Quantity.D="25.66"
E.6411.UnitOfMeasurement.Q="TNE" />
</S.QTY.Quantity>
Comments:
This segment can be repeated up to 5 times. To express what the allowance, delivery, charge, etc quantity is. This quantity must be expressed in the unit of measure specified in element E.6411.UnitOfMeasurement.Q.
This segment exists in the following segments:
SG50 Line Item Group
SG57 Actual Quantity Delivered, Part of SG56 Call-Off Quanties
SG14 part of SG63 Allowance Charge
SG64 Scheduling
Element: S.ALI.AdditionalInformation
Description: Additional Information
| Element | Attribute | Condition | Type | Value | Codelist |
| S.ALI.AdditionalInformation | E.3239.CountryOfOrigin.C | Conditional | Code | ISO 3166 | |
| E.9213.TypeOfDutyRegime.C | Conditional | Code | 9213 | ||
| E.4183.SpecialConditions.C | Conditional | Code | 4183 |
Example:
<S.ALI.AdditionalInformation E.3239.CountryOfOrigin.C="UK"
E.9213.TypeOfDutyRegime.C="3"
E.4183.SpecialConditions.C="66"
</S.ALI.AdditionalInformation>
Comments:
This segment can be repeated up to 5 times. To indicate that special conditions due to the origin, customs preference, fiscal or commercial factors are applicable.
This segment exists in the following segments:
SG50 Line Item Group
Element: S.GIN.GoodsIdentityNumber
Description: Goods Identity Number
| Element | Attribute | Condition | Type | Value | Codelist |
| S.GIN.GoodsIdentityNumber | E.7405.IdentityNumber.Q | Mandatory | Code | AP | 7405 |
| C.C208.IdenityNumberRange | E.7402.IdentityNumber.D | Mandatory | Data |
Example:
<S.GIN.GoodsIdentityNumber E.7405.IdentityNumber.Q="AP"
<C.C208.IdenityNumberRange E.7402.IdentityNumber.D="123456" />
</S.GIN.GoodsIdentityNumber>
Comments:
Used to store a goods identity number appropriate to the identification of the package.
This segment exists in the following segments:
SG50 Line Item Group
SG61 Packaging Information
Element: S.PRI.Price
Description: Price Information
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C509.PriceInformation | E.5125.Price.Q | Conditional | Code | 5125 | |
| E.5118.Price.D | Conditional | Data | n/a | ||
| E.5284.UnitPriceBasis.C | Conditional | Code | ??? | 5284 | |
| E.5387.PriceType.Q | Conditional | Code | 5387 | ||
| E.6411.UnitOfMeasurement.Q | Conditional | Code | UN/ECE 20 |
Example:
<S.PRI.Price>
<C.C509.PriceInformation E.5125.Price.Q="INV" E.5118.Price.D="38.5"
E.5284.UnitPriceBasis.C="?" E.5387.PriceType.Q="CON"
E.6411.UnitOfMeasurement.Q="TNE" />br;
</S.PRI.Price>
Comments:
Item pricing detail stored in this group. Multiple prices can be stored against an item.
This segment exists in the following segments:
SG51 Part of SG50 Line Item Group
Element: S.DGS.DangerousGoods
Description: Dangerous Goods Details
| Element | Attribute | Condition | Type | Value | Codelist |
| S.DGS.DangerousGoods | E.8273.DangerousGoodsRegulations.C | Conditional | Code | 8273 | |
| C.C205.HazardCode | E.8351.HazardIdentification.C | Mandatory | Code | 8351 | |
| E.8078.HazardSubstanceItemPageNumber.D | Conditional | Data | n/a | ||
| E.8092.HazardCodeVersionNumber.D | Conditional | Data | n/a | ||
| C.C234.UNDGInformation | E.7124.UNDGNumber.D | Conditional | Data | n/a | |
| E.7088.DangerousGoodsFlashPoint.D | Conditional | Data | n/a | ||
| C.C223.DangerousGoodsShipmentFlashPoint | E.7106.ShipmentFlashPoint.D | Conditional | Data | n/a | |
| E.7088.DangerousGoodsFlashPoint.D | Conditional | Data | n/a | ||
| E.6411.UnitOfMeasurement.Q | Conditional | Data | n/a | ||
| E.8339.PackingGroup.C | Conditional | Code | 8339 | ||
| E.8364.EMSNumber.D | Conditional | Data | n/a | ||
| E.8410.MFAG.D | Conditional | Data | n/a | ||
| E.8126.TREMCardNumber.D | Conditional | Data | n/a | ||
| C.C235.HazardIdentification | E.8158.HazardIdentificationNumberUpperPart.D | Conditional | Data | n/a | |
| E.8186.SubstanceIdentificationNumberLowerPart.D | Conditional | Data | n/a | ||
| E.7088.DangerousGoodsFlashPoint.D | Conditional | Data | n/a | ||
| C.C236.DangerousGoodsLabel | E.8246.DangerousGoodsLabelMarking.D | Conditional | Data | n/a | |
| E.8255.PackingInstruction.C | Conditional | Data | n/a | ||
| E.8325.CategoryOfMeansOfTransport.C | Conditional | Code | 8325 | ||
| E.8211.PermissionForTransport.C | Conditional | Code | 8211 |
Example:
<S.DGS.DangerousGoods
E.8273.DangerousGoodsRegulations.C="ADR">
<C.C205.HazardCode E.8351.HazardIdentification.C=""
E.8078.HazardSubstanceItemPageNumber.D="" E.8092.HazardCodeVersionNumber.D=""
/>
<C.C234.UNDGInformation
E.7124.UNDGNumber.D=""E.7088.DangerousGoodsFlashPoint.D="" />
<C.C223.DangerousGoodsShipmentFlashPoint E.7106.ShipmentFlashPoint.D=""
E.7088.DangerousGoodsFlashPoint.D=""
E.6411.UnitOfMeasurement.Q=""E.8339.PackingGroup.C="3" E.8364.EMSNumber.D=""
E.8410.MFAG.D=""E.8126.TREMCardNumber.D="" />
<C.C235.HazardIdentification
E.8158.HazardIdentificationNumberUpperPart.D=""
E.8186.SubstanceIdentificationNumberLowerPart.D=""
E.7088.DangerousGoodsFlashPoint.D="" />
<C.C236.DangerousGoodsLabelE.8246.DangerousGoodsLabelMarking.D=""E.8255.PackingInstruction.C=""
E.8325.CategoryOfMeansOfTransport.C="1" E.8211.PermissionForTransport.C=""
/>
</S.DGS.DangerousGoods>
Comments:
This segment is used to describe any dangerous goods or ingredients contained in the product. The segment is mandatory but almost all elements are optional..
This segment exists in the following segments:
SG53 Dangerous Goods, Part of SG50 Line Item Group
Element: S.PAC.Package
Description: Package Identification
| Element | Attribute | Condition | Type | Value | Codelist |
| S.PAC.Package | E.7224.NumberOfPackages.D | Mandatory | Data | n/a | |
| C.C531.Packaging | E.7075.PackagingLevel.C | Mandatory | Code | 7075 | |
| E.7073.PackagingTermsAndConditions.C | Mandatory | Data | 7073 | ||
| C.C202.Packageref | E.7065.PackageTypeIdentification.C | Mandatory | Code | UN/ECE 21 | |
| C.C532.ReturnablePackage | E.8395.ReturnablePackageFreightPaymentResponsibility.C | Mandatory | Code | 8395 |
Example:
<S.PAC.Package E.7224.NumberOfPackages.D="1" >
<C.C531.PackagingE.7075.PackagingLevel.C="4"
E.7073.PackagingTermsAndConditions.C="8" />
<C.C202.Packageref E.7065.PackageTypeIdentification.C="SP" />
<C.C532.ReturnablePackageE.8395.ReturnablePackageFreightPaymentResponsibility.C="1"
/>
</S.PAC.Package>
Comments:
This segment is used to describe any packaging applied to the item. The segment is mandatory but the elements are typically empty.
This segment exists in the following segments:
SG54 Packaging Instructions, part of SG50 Line Item Group
SG60 Package
Element: S.PCI.PackageIdentification
Description: Package Identification
| Element | Attribute | Condition | Type | Value | Codelist |
| S.PCI.PackageIdentification | E.4233.MarkingInstructions.C | Mandatory | Code | 4233 | |
| C.C210.MarksAndLabels | E.7102.ShippingMarks.D | Mandatory | Data | n/a |
Example:
<S.PCI.PackageIdentification
E.4233.MarkingInstructions.C="20">
<C.C210.MarksAndLabels E.7102.ShippingMarks.D=""/>
</S.PCI.PackageIdentification>
Comments:
To identify markings visible on packaged goods.
This segment exists in the following segments:
SG55 part of SG54 Packaging Instructions
SG61 Packaging
Element: S.DOC.Document
Description: Document
| Element | Attribute | Condition | Type | Value | Codelist |
| S.DOC.Document | E.DocumentNumber.D | Mandatory | Data | n/a | |
| C.C002.DocumentName | E.1001.DocumentName.C | Mandatory | Code | 1001 | |
| E.1131.CodeList.Q | Mandatory | Code | 1131 | ||
| E.3055.CodeListAgency.C | Mandatory | Code | 3055 | ||
| Mandatory | Data |
Example:
<S.DOC.Document E.DocumentNumber.D="" >
<C.C002.DocumentName E.1001.DocumentName.C="" E.1131.CodeList.Q=""
E.3055.CodeListAgency.C="" E.1000.DocumentName.D="" />
</S.DOC.Document >
Comments:
This Segment is Mandatory but is not used, in other words it contains no data.
This segment exists in the following segments:
SG59 Name and Address
Element: S.QVA.QuantityVariances
Description: Quantity Variances
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C279.QuantityDifferenceInformation | E.6064.QuantityDifference.D | Mandatory | Data | n/a | |
| E.6063.Quantity.Q | Mandatory | Code | 6063 | ||
| E.4221.Discrepancy.C | Mandatory | Code | 4221 | ||
| C.C262.ReasonForChange | E.4295.ReasonForChange.C | Mandatory | Code | 4295 | |
| E.4294.ReasonForChange.D | Mandatory | Data | n/a |
Example:
<S.QVA.QuantityVariances >
<C.C279.QuantityDifferenceInformationE.6064.QuantityDifference.D="15"
E.6063.Quantity.Q=""E.4221.Discrepancy.C="ZZZ" />
<C.C262.ReasonForChange E.4295.ReasonForChange.C="MC"
E.4294.ReasonForChange.D="Logs lost in transit" />
</S.QVA.QuantityVariances>
Comments:
This segment is used to show where an actual quantity varies from the expected quantity. Typical examples are Goods Lost in Transit, or Reject Timber. This segment is Mandatory but is typically not used as the quantities are specified in the Line Item Group.
This segment exists in the following segments:
SG62 Quantity Variance
Element: S.ALC.AllowanceCharge
Description: Allowance Charge
| Element | Attribute | Condition | Type | Value | Codelist |
| S.ALC.AllowanceCharge | E.5463.AllowanceCharge.Q | Mandatory | Code | 5463 | |
| C.C552.AllowanceChargeInformation | E.1227.CalculationSequenceIndicator.C | Conditional | Code | 1227 | |
| C.C214.SpecialServicesIdentification | E.7161.SpecialServices.C | Conditional | Code | 7161 |
Example:
<S.ALC.AllowanceCharge E.5463.AllowanceCharge.Q="A">
<C.C552.AllowanceChargeInformation
E.1227.CalculationSequenceIndicator.C="1" />
<C.C214.SpecialServicesIdentification
E.7161.SpecialServices.C="DL"/>
</S.ALC.AllowanceCharge>
Comments:
The Line Item ALC segment is used to record any alloowances/charges/discounts appropriate to the Line Item (not the whole DOCUMENT). THE ALC segment can be repeated up to 15 times, but for each repetition, only one of the segments PCD, MOA or RTE can be used.
This segment exists in the following segments:
SG63 Line Item Allowances
Element: S.RNG.Range
Description: Range
| Element | Attribute | Condition | Type | Value | Codelist |
| S.RNG.Range | E.6167.RangeType.Q | Conditional | Code | 6167 | |
| C.280.Range | E.6162.RangeMinimum.D | Conditional | Data | ||
| E.6152.RangeMaximum.D | Conditional | Data | |||
| E.6411.UnitOfMeasurement.Q | Mandatory | Code | UN/ECE 20 |
Example:
<S.RNG.Range E.6167.RangeType.Q="1">
<C.280.Range E.6162.RangeMinimum.D="" E.6152.RangeMaximum.D=""
E.6411.UnitOfMeasurement.Q="" />
</S.RNG.Range>
Comments:
This segment is not Mandatory.
This segment exists in the following segments:
SG14, SG15, SG16 & SG17 All part of SG63 Allowance Charges
Element: S.RTE.Rate
Description: Rate
| Element | Attribute | Condition | Type | Value | Codelist |
| C.C128.Rate | E.5419.RateType.Q | Mandatory | Code | 5419 | |
| E.5420.RatePerUnit.D | Mandatory | Data | |||
| E.5284.UnitPriceBasis.C | Code | 5284 | |||
| E.6411.UnitOfMeasurement.Q | Code | UN/ECE 20 |
Example:
<C.C128.Rate E.5419.RateType.Q="1"
E.5420.RatePerUnit.D="24.67" E.5284.UnitPriceBasis.C=""
E.6411.UnitOfMeasurement.Q="TNE" />
Comments:
This segment is used if Allowance or Charge is to be represented as a rate per unit.
This segment exists in the following segments:
SG17 Part of SG63 Allowance Charges
Element: S.SCC.SchedulingConditions
Description: Scheduling Conditions
| Element | Attribute | Condition | Type | Value | Codelist |
| S.SCC.SchedulingConditions | E.4017.DeliveryPlanStatus.C | Mandatory | Code | 4017 | |
| E.4493.DeliveryRequirements.C | Conditional | Code | 4493 | ||
| C.C329.PatternDescription | E.2013.Frequency.C | Conditional | Code | 2013 | |
| E.2015.DespatchPattern.C | Conditional | Code | 2015 | ||
| E.2017.DespatchPatternTiming.C | Conditional | Code | 2017 |
Example:
<S.SCC.SchedulingConditions
E.4017.DeliveryPlanStatus.C="1" E.4493.DeliveryRequirements.C="P2"
<C.C329.PatternDescription E.2013.Frequency.C="ZZZ"
E.2015.DespatchPattern.C="ZZZ"E.2017.DespatchPatternTiming.C="ZZZ" />
<S.SCC.SchedulingConditions/>
Comments:
This segment can be used to describe .
This segment exists in the following segments:
SG64 Scheduling Conditions
Element: S.FII.FinancialInstitutionInformation
Description: Financial Institution Information
| Element | Attribute | Condition | Type | Value | Codelist |
| S.FII.FinancialInstitutionInformation | E.3035.Party.Q | Mandatory | Code | 3035 | |
| E.3207.Country.C | Conditional | Code | ISO 3166 | ||
| C.C078.AccountIdentification | E.3194.AccountHolderNumber.D | Conditional | Data | n/a | |
| E.3192.AccountHolderName.D | Conditional | Data | n/a | ||
| E.6345.Currency.C | Conditional | Code | ISO 4217 | ||
| C.C088.InstitutionIdentification | E.3433.InstitutionNameIdentification.C | Conditional | Code | n/a | |
| E.3434.InstitutionBranchNumber.D | Conditional | Data | n/a | ||
| E.3432.InstitutionName.D | Conditional | Data | n/a | ||
| E.3436.InstitutionBranchPlace.D | Conditional | Data | n/a |
Example:
<S.FII.FinancialInstitutionInformation E.3035.Party.Q="BB"
E.3207.Country.C="GB"
<C.C078.AccountIdentification E.3194.AccountHolderNumber.D="123456789"
E.3192.AccountHolderName.D="JM Forestry Ltd" E.6345.Currency.C="GBP" />
<C.C088.InstitutionIdentification
E.3433.InstitutionNameIdentification.C="RBS001"
E.3434.InstitutionBranchNumber.D="12-34-56" E.3432.InstitutionName.D="Royal
Bank of Scotland" E.3436.InstitutionBranchPlace.D="Glasgow" />
</S.FII.FinancialInstitutionInformation>
Comments:
Not used.
This segment exists in the following segments:
SG08 Name and Address
This is a map of the elements in the schema and how they are related to each other. Several elements are used in various locations, for example the DTM Date and Time element.
| Trading | DOCUMENT | UNB | Sender/Receiver | |||
| UNH | Message Header | |||||
| BGM | Beginning of Message | |||||
| DTM | Date and Time | |||||
| FTX | Free Text | |||||
| SG01 | RFF | Header Details | ||||
| DTM | Date and Time | |||||
| SG04 | PAT | Payment Terms | ||||
| SG05 | DTM | |||||
| SG06 | PCD | |||||
| MOA | ||||||
| SG08 | NAD | Name and Address | ||||
| RFF | ||||||
| SG09 | CTA | Contact Details | ||||
| COM | ||||||
| LOC | ||||||
| FII | ||||||
| SG10 | TDT | Transport Details | ||||
| LOC | ||||||
| SG50 | LIN | Line Details | ||||
| PIA | Additional Product Information | |||||
| IMD | Item Description | |||||
| MEA | Measurement | |||||
| QTY | Quantity | |||||
| ALI | Additional Information | |||||
| DTM | Date and Time | |||||
| GIN | Goods Identity Number | |||||
| FTX | Free Text | |||||
| MOA | Monetary Amount | |||||
| SG51 | PRI | Price | ||||
| CUX | ||||||
| DTM | ||||||
| SG52 | RFF | Line References | ||||
| DTM | ||||||
| SG53 | DGS | Dangerous Goods | ||||
| SG54 | PAC | Packaging Instructions | ||||
| SG55 | MEA | |||||
| PCI | ||||||
| SG56 | SG57 | QTY | Call-off Quantities | |||
| DTM | ||||||
| SG58 | TAX | Tax | ||||
| MOA | ||||||
| SG59 | NAD | Name and Address | ||||
| DOC | ||||||
| SG60 | PAC | Packaging | ||||
| MEA | ||||||
| SG61 | PCI | Package Identification | ||||
| GIN | ||||||
| SG62 | QVA | Quantity Variance | ||||
| DTM | ||||||
| SG63 | ALC | Allowance Charge | ||||
| SG14 | QTY | |||||
| RNG | ||||||
| SG15 | PCD | |||||
| RNG | ||||||
| SG16 | MOA | |||||
| RNG | ||||||
| SG17 | RTE | |||||
| RNG | ||||||
| SG18 | TAX | |||||
| MOA | ||||||
| SG64 | SCC | Scheduling Conditions | ||||
| QTY | ||||||
| DTM | ||||||
| UNS | Trailer | |||||
| CNT | Check Sums | |||||
| SG71 | MOA | Monetary Amount | ||||
| RFF | ||||||
| DTM | ||||||
| SG72 | TAX | Summary Amounts | ||||
| MOA | ||||||
| CUX | Currency | |||||
| UNT | End of DOCUMENT flag |
The various lookup codes that are used by the schema are listed here. Some of the codes in the schema are simply descriptive and describe the purpose of the code whilst others are proper lookup codes with defined values. The list here is principally of the lookup codes. The full list of United Nations Trade Codes can be found at: http://www.unece.org/etrades/iso7372/tded/tdedi1.htm
Appendix A. Acknowledgements
The following individuals have participated in the creation of this specification and are gratefully acknowledged:
Participants:
[list of acknowledgements as determined by Technical Committee chair(s)]