Position: 291
Loop: PO1 Mandatory Level: Detail
Usage: Optional
Max Use: 1
Purpose: To specify tax information
Syntax Notes: 1 At least one of TXI02 TXI03 or TXI06 is required.
2 If either TXI04 or TXI05 is present, then the other is required. 3 If TXI08 is present, then TXI03 is required.
Semantic Notes: 1 TXI02 is the monetary amount of the tax. 2 TXI03 is the tax percent expressed as a decimal.
3 TXI07 is a code indicating the relationship of the price or amount to the associated segment.
Comments:
Usage Notes:
Used/Optional
Notes:
Example: TXI*TX*27.18~
cXML supplies tax information with an amount and a description. Ariba sends the tax amount here. Taxes can be present at both the header and line item levels. Taxes at the line item level are used to show a per line item breakdown.
If specific tax information is not present, then suppliers are expected to calculate and apply required taxes. If buyers are specifying tax amounts, then they have done this calculation on their side, and an error might result in an acknowledgment either recalculating this properly or non-fulfillment pending correction.
<OrderRequest> <ItemOut> <Tax>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
TXI01 963 Tax Type Code M ID 2/2 M
Code specifying the type of tax
TX All Taxes
Total of all applicable taxes
TXI02 782 Monetary Amount X R 1/18 M
Segment:
N9
Reference Identification - URL Position: 330 Loop: N9 Optional Level: Detail Usage: Optional Max Use: 1Purpose: To transmit identifying information as specified by the Reference Identification Qualifier Syntax Notes: 1 At least one of N902 or N903 is required.
2 If N906 is present, then N905 is required.
3 If either C04003 or C04004 is present, then the other is required. 4 If either C04005 or C04006 is present, then the other is required. Semantic Notes: 1 N906 reflects the time zone which the time reflects.
2 N907 contains data relating to the value cited in N902. Comments:
Usage Notes:
Used/Optional
Notes:
Example: N9*URL*URL*Catalog Entry~
If ItemDetail is supplied, there is one optional URL the Buyer can send to reference the item. What the URL refers to, if specified, is mapped in N903. The URL itself is mapped to the MSG segment.
<OrderRequest> <ItemOut> <ItemDetail> <URL>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
N901 128 Reference Identification Qualifier M ID 2/3 M
Code qualifying the Reference Identification
URL Uniform Resource Locator
N902 127 Reference Identification X AN 1/30 M
Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier
Ariba writes constant "URL" here because either element 2 or 3 is required, and our data for element 3 is optional. This is to prevent an X12 compliance error.
Application Value List: URL
N903 369 Free-form Description X AN 1/45 O
Free-form descriptive text "name" attribute value, if present.
<URL>
Copyright (c) 2000 - 2003 Ariba, Inc. 62 Revision 6, June 2003
Segment:
MSG
Message TextPosition: 340
Loop: N9 Optional Level: Detail Usage: Optional Max Use: 1000
Purpose: To provide a free-form format that allows the transmission of text information Syntax Notes: 1 If MSG03 is present, then MSG02 is required.
Semantic Notes: 1 MSG03 is the number of lines to advance before printing.
Comments: 1 MSG02 is not related to the specific characteristics of a printer, but identifies top of page, advance a line, etc.
2 If MSG02 is "AA - Advance the specified number of lines before print" then MSG03 is required.
Usage Notes:
Used/Optional
Notes:
Example: MSG*http://www.thesupplier.com/catalog?itemid=26409~
<OrderRequest> <ItemOut> <ItemDetail> <URL> #PCDATA
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
MSG01 933 Free-Form Message Text M AN 1/264 M
Free-form message text URL data value
Segment:
N9
Reference Identification - Comments Position: 330 Loop: N9 Optional Level: Detail Usage: Optional Max Use: 1Purpose: To transmit identifying information as specified by the Reference Identification Qualifier Syntax Notes: 1 At least one of N902 or N903 is required.
2 If N906 is present, then N905 is required.
3 If either C04003 or C04004 is present, then the other is required. 4 If either C04005 or C04006 is present, then the other is required. Semantic Notes: 1 N906 reflects the time zone which the time reflects.
2 N907 contains data relating to the value cited in N902. Comments:
Usage Notes:
Used/Optional
Notes:
Example: N9*L1*Comment*en~
cXML provides one block of comments at the header level, which is mapped here. cXML also has the ability to include an attachment here, but attachments are not mapped to X12
<OrderRequest> <ItemOut> <Comments>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
N901 128 Reference Identification Qualifier M ID 2/3 M
Code qualifying the Reference Identification
L1 Letters or Notes
N902 127 Reference Identification X AN 1/30 O
Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier
Always set to "Comment". Ariba writes a constant here because X12 requires that either N902 or N903 is used, and the description is optional in cXML. By writing a constant, Ariba avoids any compliance issues with X12.
Application Value List: Comment
N903 369 Free-form Description X AN 1/45 O
Free-form descriptive text
This is the language code attribute sent by cXML to describe the language used for the comment. The code is ISO 639 compliant. Note that this code is optional and can be supplied in lower case.
<Comments>
Copyright (c) 2000 - 2003 Ariba, Inc. 64 Revision 6, June 2003
Segment:
MSG
Message TextPosition: 340
Loop: N9 Optional Level: Detail Usage: Optional Max Use: 1000
Purpose: To provide a free-form format that allows the transmission of text information Syntax Notes: 1 If MSG03 is present, then MSG02 is required.
Semantic Notes: 1 MSG03 is the number of lines to advance before printing.
Comments: 1 MSG02 is not related to the specific characteristics of a printer, but identifies top of page, advance a line, etc.
2 If MSG02 is "AA - Advance the specified number of lines before print" then MSG03 is required.
Usage Notes:
Used/Optional Notes:
Example:
MSG*Do not wrap with adhesive tape;~ MSG*It leaves a sticky residue*LC~
(LC was shown here for demonstration. It wouldn't actually be used on two short lines, but only when a line exceeds the 264 char limit of MSG01.)
The actual comment text. The X12 mapping will try to preserve the line breaks from the cXML as best it can. Each line break will automatically incur a new MSG segment, with the exception of a blank line. If one line goes over the capacity of MSG01 then the line is word-broken and a new MSG segment is created to continue the line. If the number of lines exceed the occurrence limit of MSG, then the remainder of the comment text will be truncated.
Any imbedded Attachments will be dropped. However, Ariba might include a text representation that it is present. For example:
MSG*See the attached word document. [Attachment "specs.doc"]~
<OrderRequest> <ItemOut> <Comments>
#PCDATA .. <Attachment>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
MSG01 933 Free-Form Message Text M AN 1/264 M
Free-form message text
MSG02 934 Printer Carriage Control Code X ID 2/2 O
A field to be used for the control of the line feed of the receiving printer
If a line was broken by the limitation of MSG01, and a new segment is created for continuation, then MSG02="LC", otherwise it is not used.
Segment:
N9
Reference Identification - Extrinsics Position: 330 Loop: N9 Optional Level: Detail Usage: Optional Max Use: 1Purpose: To transmit identifying information as specified by the Reference Identification Qualifier Syntax Notes: 1 At least one of N902 or N903 is required.
2 If N906 is present, then N905 is required.
3 If either C04003 or C04004 is present, then the other is required. 4 If either C04005 or C04006 is present, then the other is required. Semantic Notes: 1 N906 reflects the time zone which the time reflects.
2 N907 contains data relating to the value cited in N902. Comments:
Usage Notes:
Used/Optional
Notes:
Example: N9*ZZ**Size Information~
Extrinsic information is well-formed XML provided by the buyer to define extra
information outside the scope of cXML's specifications. The content here is user-defined, and in X12 should be regarded as comment information.
There are three rules to consider when looking at extrinsic information:
1. It is defined by the specific implementation of the Buyer and the Buyer's ERP system to any Ariba B2B Procurement Platform. Two different Buyers might send the same information in two distinct ways at this level. You cannot depend on the precise format. 2. Neither Ariba nor cXML control the exact content and formatting of Extrinsics. The implementation is user-defined, and popular implementations thereof often migrate their way into future versions of cXML. Treat this as comment information.
3. While every effort is made to preserve the integrity of Extrinsic information in the X12 implementation, it simply cannot be guaranteed. Non-printable characters cannot be transported and any occurrences of our X12 control characters (i.e.. SegTerm, ElemSep, CompSep) MUST BE TRANSLATED. Supplier side EDI Implement ors should make their respective departments aware of this.
<OrderRequest> <ItemOut> <ItemDetail> <Extrinsic>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
N901 128 Reference Identification Qualifier M ID 2/3 M
Code qualifying the Reference Identification
ZZ Mutually Defined
N903 369 Free-form Description X AN 1/45 O
Copyright (c) 2000 - 2003 Ariba, Inc. 66 Revision 6, June 2003
Segment:
MSG
Message TextPosition: 340
Loop: N9 Optional Level: Detail
Usage: Optional (Must Use) Max Use: 1000
Purpose: To provide a free-form format that allows the transmission of text information Syntax Notes: 1 If MSG03 is present, then MSG02 is required.
Semantic Notes: 1 MSG03 is the number of lines to advance before printing.
Comments: 1 MSG02 is not related to the specific characteristics of a printer, but identifies top of page, advance a line, etc.
2 If MSG02 is "AA - Advance the specified number of lines before print" then MSG03 is required.
Usage Notes:
Mandatory Notes:
Example: MSG*<Size UnitOfMeasure="cm">~ MSG* <Height>14</Height>~ MSG* <Width>23</Width>~ MSG* <Depth>12.4</Depth>~ MSG*</Size>~
MSG carries the actual Extrinsic data as accurately as possible. Where new lines are started in cXML, new MSG segments are created (except for blank lines) in order to preserve its integrity. If a line exceeds the capacity of MSG01, then a new MSG segment is created and the Extrinsic text continues.
<OrderRequest> <ItemOut> <ItemDetail> <Extrinsic> ANY
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
MSG01 933 Free-Form Message Text M AN 1/264 M
Free-form message text
MSG02 934 Printer Carriage Control Code X ID 2/2 O
A field to be used for the control of the line feed of the receiving printer
If a line from cXML is broken by MSG01's limitation, a new MSG segment is created with MSG02="LC"
Segment:
N1
Ship-To Name Position: 350 Loop: N1 Optional Level: Detail Usage: Optional Max Use: 1Purpose: To identify a party by type of organization, name, and code Syntax Notes: 1 At least one of N102 or N103 is required.
2 If either N103 or N104 is present, then the other is required. Semantic Notes:
Comments: 1 This segment, used alone, provides the most efficient method of providing organizational identification. To obtain this efficiency the "ID Code" (N104) must provide a key to the table maintained by the transaction processing party.
2 N105 and N106 further define the type of entity in N101. Usage Notes:
Used/Optional
Notes:
Example: N1*ST*San Jose Office*92*152~ Line Item Level Ship-To Address Information
This is optional at the line item level. Ariba will send ShipTo Information either at the header OR at the line item level, but not both. If it is absent here then it is required at the header level.
<OrderRequest> <ItemOut> <ShipTo>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
N101 98 Entity Identifier Code M ID 2/3 M
Code identifying an organizational entity, a physical location, property or an individual
ST Ship To
N102 93 Name X AN 1/60 O
Free-form name
N103 66 Identification Code Qualifier X ID 1/2 O
Code designating the system/method of code structure used for Identification Code (67)
92 Assigned by Buyer or Buyer's Agent
N104 67 Identification Code X AN 2/80 O
Copyright (c) 2000 - 2003 Ariba, Inc. 68 Revision 6, June 2003 Segment:
N2
Additional Name InformationPosition: 360
Loop: N1 Optional Level: Detail Usage: Optional
Max Use: 2
Purpose: To specify additional names or those longer than 35 characters in length Syntax Notes:
Semantic Notes: Comments:
Usage Notes:
Used/Optional Notes:
Example:
N2*Maria Valenzuela*B1-2462~ N2*The Buyer, Inc.~
In a PostalAddress, cXML considers DeliverTo to be optional, but can send many. Ariba SN implements up to the first four here: two Name elements across two N2 segments. The first two iterations of DeliverTo will occupy the first N2 segment and the third and fourth iterations, if present, will occupy the second N2. Any further DeliverTo iterations will be ignored.
<ShipTo> <Address>
<PostalAddress> <DeliverTo>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
N201 93 Name M AN 1/60 M
Free-form name
N202 93 Name O AN 1/60 O
Segment:
N3
Address Information Position: 370 Loop: N1 Optional Level: Detail Usage: Optional Max Use: 2Purpose: To specify the location of the named party Syntax Notes:
Semantic Notes: Comments:
Usage Notes:
Used/Optional Notes:
N3*1500 Buyer Way~
Street address information.
cXML requires one <Street> tag but can send many. Like the N2 above, AribaSN implements up to the first four: two elements across two segments.
<ShipTo> <Address>
<PostalAddress> <Street>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
N301 166 Address Information M AN 1/55 M
Address information
N302 166 Address Information O AN 1/55 O
Copyright (c) 2000 - 2003 Ariba, Inc. 70 Revision 6, June 2003
Segment:
N4
Geographic LocationPosition: 380
Loop: N1 Optional Level: Detail Usage: Optional
Max Use: 1
Purpose: To specify the geographic place of the named party Syntax Notes: 1 If N406 is present, then N405 is required. Semantic Notes:
Comments: 1 A combination of either N401 through N404, or N405 and N406 may be adequate to specify a location.
2 N402 is required only if city name (N401) is in the U.S. or Canada. Usage Notes:
Used/Optional
Notes:
Example: N4*San Jose*CA*95110*US~ Geographic information from the PostalAddress
cXML guarantees a City and Country. The State or Province code and the Postal Code are optional.
<ShipTo> <Address>
<PostalAddress>
<City> .. <State> .. <PostalCode> .. <Country>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
N401 19 City Name O AN 2/30 M
Free-form text for city name
<PostalAddress> <City>
N402 156 State or Province Code O ID 2/2 O
Code (Standard State/Province) as defined by appropriate government agency http://www.usps.gov/ncsc/lookups/abbr_state.txt
http://www.canadapost.ca/CPC2/addrm/addrguide/prov_symbols.html
<PostalAddress> <State>
N403 116 Postal Code O ID 3/15 O
Code defining international postal zone code excluding punctuation and blanks (zip code for United States)
A US Zip Code can be five or nine digits. There will not be a separator present if the full nine digit code is sent. A Canadian Postal Code is always formatted "A9A9A9". There will not be a separator in the middle.
<PostalAddress> <PostalCode>
N404 26 Country Code O ID 2/3 M
Code identifying the country
Country code is ISO-3166 compliant. You can see a list here along with their respective currency codes:
http://www.unece.org/trade/rec/rec09en.htm
<PostalAddress> <Country>
Segment:
PER
Administrative Communications Contact Position: 400 Loop: N1 Optional Level: Detail Usage: Optional Max Use: 3Purpose: To identify a person or office to whom administrative communications should be directed Syntax Notes: 1 If either PER03 or PER04 is present, then the other is required.
2 If either PER05 or PER06 is present, then the other is required. 3 If either PER07 or PER08 is present, then the other is required. Semantic Notes:
Comments:
Usage Notes:
Used/Optional
Notes:
Example: PER*RE*Maria -
Primary*TE*14085551824*FX*14085552001*EM*[email protected]~ Contact information of Telephone, Fax, Email, and URL. cXML requires none, and only one of each is allowed.
Each contact tag carries a name to identify itself. Where possible, Ariba SN groups those with the same name together. If all four pieces are supplied, or if they carry distinct names, then multiple PER segments are required.
The telephone number supplied with either Phone or Fax is broken down by components by cXML. The number will be formatted appropriately here.
Note that a URL will be limited to the maximum length of the Communication Number element.
<ShipTo> <Address>
<Phone> .. <Fax> .. <Email> .. <URL>
Data Element Summary
Ref. Data Base User
Des. Element Name Attributes Attributes
PER01 366 Contact Function Code M ID 2/2 M
Code identifying the major duty or responsibility of the person or group named
RE Receiving Contact
PER02 93 Name O AN 1/60 O
Free-form name
PER03 365 Communication Number Qualifier X ID 2/2 O
Code identifying the type of communication number
EM Electronic Mail
FX Facsimile
TE Telephone
UR Uniform Resource Locator (URL)
Copyright (c) 2000 - 2003 Ariba, Inc. 72 Revision 6, June 2003
PER07 365 Communication Number Qualifier X ID 2/2 O
Code identifying the type of communication number
EM Electronic Mail
FX Facsimile
TE Telephone
UR Uniform Resource Locator (URL)
PER08 364 Communication Number X AN 1/80 O
Segment: