X12 824 Application Advice

X12 Release 4010

This Draft Standard for Trial Use contains the format and establishes the data contents of the Application Advice Transaction Set (824) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used to provide the ability to report the results of an application system's data content edits of transaction sets. The results of editing transaction sets can be reported at the functional group and transaction set level, in either coded or free-form format. It is designed to accommodate the business need of reporting the acceptance, rejection or acceptance with change of any transaction set. The Application Advice should not be used in place of a transaction set designed as a specific response to another transaction set (e.g., purchase order acknowledgment sent in response to a purchase order).

Delimiters

• ~ Segment
• * Element
• > Component

ISA

Interchange Control Header

RequiredMax use 1

To start and identify an interchange of zero or more functional groups and interchange-related control segments

ISA-01 · I01 · Authorization Information Qualifier · Required · Code to identify the type of information in the Authorization Information · 00 No Authorization Information Present (No Meaningful Information in I02)

ISA-02 · I02 · Authorization Information · Required Min 10 Max 10 · Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01)

ISA-03 · I03 · Security Information Qualifier · Required · Code to identify the type of information in the Security Information · 00 No Security Information Present (No Meaningful Information in I04)

ISA-04 · I04 · Security Information · Required Min 10 Max 10 · This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03)

ISA-05 · I05 · Interchange ID Qualifier · Required Min 2 Max 2 · Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified · Codes 01 Duns (Dun & Bradstreet) 02 SCAC (Standard Carrier Alpha Code) 03 FMC (Federal Maritime Commission) 04 IATA (International Air Transport Association) 08 UCC EDI Communications ID (Comm ID) 09 X.121 (CCITT) 10 Department of Defense (DoD) Activity Address Code 11 DEA (Drug Enforcement Administration) 12 Phone (Telephone Companies) 13 UCS Code (The UCS Code is a Code Used for UCS Transmissions; it includes the Area Code and Telephone Number of a Modem; it Does Not Include Punctuation, Blanks or Access Code) 14 Duns Plus Suffix 15 Petroleum Accountants Society of Canada Company Code 16 Duns Number With 4-Character Suffix 17 American Bankers Association (ABA) Transit Routing Number (Including Check Digit, 9 Digit) 18 Association of American Railroads (AAR) Standard Distribution Code 19 EDI Council of Australia (EDICA) Communications ID Number (COMM ID) 20 Health Industry Number (HIN) 21 Integrated Postsecondary Education Data System, or (IPEDS) 22 Federal Interagency Commission on Education, or FICE 23 National Center for Education Statistics Common Core of Data 12-Digit Number for Pre-K-Grade 12 Institutes, or NCES 24 The College Board's Admission Testing Program 4-Digit Code of Postsecondary Institutes, or ATP 25 American College Testing Program 4-Digit Code of Postsecondary Institutions, or ACT 26 Statistics of Canada List of Postsecondary Institutions 27 Carrier Identification Number as assigned by Health Care Financing Administration (HCFA) 28 Fiscal Intermediary Identification Number as assigned by Health Care Financing Administration (HCFA) 29 Medicare Provider and Supplier Identification Number as assigned by Health Care Financing Administration (HCFA) 30 U.S. Federal Tax Identification Number 31 Jurisdiction Identification Number Plus 4 as assigned by the International Association of Industrial Accident Boards and Commissions (IAIABC) 32 U.S. Federal Employer Identification Number (FEIN) 33 National Association of Insurance Commissioners Company Code (NAIC) 34 Medicaid Provider and Supplier Identification Number as assigned by individual State Medicaid Agencies in conjunction with Health Care Financing Administration (HCFA) 35 Statistics Canada Canadian College Student Information System Institution Codes 36 Statistics Canada University Student Information System Institution Codes 37 Society of Property Information Compilers and Analysts AM Association Mexicana del Codigo de Producto (AMECOP) Communication ID NR National Retail Merchants Association (NRMA) - Assigned SN Standard Address Number ZZ Mutually Defined

ISA-06 · I06 · Interchange Sender ID · Required Min 15 Max 15 · Identification code published by the sender for other parties to use as the receiver ID to route data to them; the sender always codes this value in the sender ID element

ISA-07 · I05 · Interchange ID Qualifier · Required Min 2 Max 2 · Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified · Codes 01 Duns (Dun & Bradstreet) 02 SCAC (Standard Carrier Alpha Code) 03 FMC (Federal Maritime Commission) 04 IATA (International Air Transport Association) 08 UCC EDI Communications ID (Comm ID) 09 X.121 (CCITT) 10 Department of Defense (DoD) Activity Address Code 11 DEA (Drug Enforcement Administration) 12 Phone (Telephone Companies) 13 UCS Code (The UCS Code is a Code Used for UCS Transmissions; it includes the Area Code and Telephone Number of a Modem; it Does Not Include Punctuation, Blanks or Access Code) 14 Duns Plus Suffix 15 Petroleum Accountants Society of Canada Company Code 16 Duns Number With 4-Character Suffix 17 American Bankers Association (ABA) Transit Routing Number (Including Check Digit, 9 Digit) 18 Association of American Railroads (AAR) Standard Distribution Code 19 EDI Council of Australia (EDICA) Communications ID Number (COMM ID) 20 Health Industry Number (HIN) 21 Integrated Postsecondary Education Data System, or (IPEDS) 22 Federal Interagency Commission on Education, or FICE 23 National Center for Education Statistics Common Core of Data 12-Digit Number for Pre-K-Grade 12 Institutes, or NCES 24 The College Board's Admission Testing Program 4-Digit Code of Postsecondary Institutes, or ATP 25 American College Testing Program 4-Digit Code of Postsecondary Institutions, or ACT 26 Statistics of Canada List of Postsecondary Institutions 27 Carrier Identification Number as assigned by Health Care Financing Administration (HCFA) 28 Fiscal Intermediary Identification Number as assigned by Health Care Financing Administration (HCFA) 29 Medicare Provider and Supplier Identification Number as assigned by Health Care Financing Administration (HCFA) 30 U.S. Federal Tax Identification Number 31 Jurisdiction Identification Number Plus 4 as assigned by the International Association of Industrial Accident Boards and Commissions (IAIABC) 32 U.S. Federal Employer Identification Number (FEIN) 33 National Association of Insurance Commissioners Company Code (NAIC) 34 Medicaid Provider and Supplier Identification Number as assigned by individual State Medicaid Agencies in conjunction with Health Care Financing Administration (HCFA) 35 Statistics Canada Canadian College Student Information System Institution Codes 36 Statistics Canada University Student Information System Institution Codes 37 Society of Property Information Compilers and Analysts AM Association Mexicana del Codigo de Producto (AMECOP) Communication ID NR National Retail Merchants Association (NRMA) - Assigned SN Standard Address Number ZZ Mutually Defined

ISA-08 · I07 · Interchange Receiver ID · Required Min 15 Max 15 · Identification code published by the receiver of the data; When sending, it is used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to route data to them

ISA-09 · I08 · Interchange Date · Required YYMMDD format · Date of the interchange

ISA-10 · I09 · Interchange Time · Required HHMM format · Time of the interchange

ISA-11 · I10 · Interchange Control Standards Identifier · Required · Code to identify the agency responsible for the control standard used by the message that is enclosed by the interchange header and trailer · U U.S. EDI Community of ASC X12, TDCC, and UCS

ISA-12 · I11 · Interchange Control Version Number · Required · This version number covers the interchange control segments · 00401 Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1997

ISA-13 · I12 · Interchange Control Number · Required Min 9 Max 9 · A control number assigned by the interchange sender

ISA-14 · I13 · Acknowledgment Requested · Required Min 1 Max 1 · Code sent by the sender to request an interchange acknowledgment (TA1) · 0 No Acknowledgment Requested 1 Interchange Acknowledgment Requested

ISA-15 · I14 · Usage Indicator · Required Min 1 Max 1 · Code to indicate whether data enclosed by this interchange envelope is test, production or information · I Information P Production Data T Test Data

ISA-16 · I15 · Component Element Separator · Required Min 1 Max 1 · Type is not applicable; the component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator · > Component Element Separator

GS

Functional Group Header

RequiredMax use 1

To indicate the beginning of a functional group and to provide control information

GS-01 · 479 · Functional Identifier Code · Required · Code identifying a group of application related transaction sets · AG Application Advice (824)

GS-02 · 142 · Application Sender's Code · Required Min 2 Max 15 · Code identifying party sending transmission; codes agreed to by trading partners

GS-03 · 124 · Application Receiver's Code · Required Min 2 Max 15 · Code identifying party receiving transmission. Codes agreed to by trading partners

GS-04 · 373 · Date · Required CCYYMMDD format · Date expressed as CCYYMMDD

GS-05 · 337 · Time · Required HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format · Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99)

GS-06 · 28 · Group Control Number · Required Min 1 Max 9 · Assigned number originated and maintained by the sender

GS-07 · 455 · Responsible Agency Code · Required Min 1 Max 2 · Code used in conjunction with Data Element 480 to identify the issuer of the standard · T Transportation Data Coordinating Committee (TDCC) X Accredited Standards Committee X12

GS-08 · 480 · Version / Release / Industry Identifier Code · Required · Code indicating the version, release, subrelease, and industry identifier of the EDI standard being used, including the GS and GE segments; if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and subrelease, level of the version; and positions 7-12 are the industry or trade association identifiers (optionally assigned by user); if code in DE455 in GS segment is T, then other formats are allowed · 004010 Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1997

Heading

ST

010

Transaction Set Header

RequiredMax use 1

To indicate the start of a transaction set and to assign a control number

ST-01 · 143 · Transaction Set Identifier Code · Required · Code uniquely identifying a Transaction Set The transaction set identifier (ST01) used by the translation routines of the interchange partners to select the appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set). · 824 Application Advice

ST-02 · 329 · Transaction Set Control Number · Required Min 4 Max 9 · Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set

BGN

020

Beginning Segment

RequiredMax use 1

To indicate the beginning of a transaction set

BGN-01 · 353 · Transaction Set Purpose Code · Required · Code identifying purpose of transaction set · 00 Original

BGN-02 · 127 · Reference Identification · Required Min 1 Max 30 · Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier BGN02 is the transaction set reference number.

BGN-03 · 373 · Date · Required CCYYMMDD format · Date expressed as CCYYMMDD BGN03 is the transaction set date.

BGN-04 · 337 · Time · Optional HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format · Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99) BGN04 is the transaction set time.

Detail

OTI Loop

RequiredMax >1

OTI

010

Original Transaction Identification

RequiredMax use 1

To identify the edited transaction set and the level at which the results of the edit are reported, and to indicate the accepted, rejected, or accepted-with-change edit result

• The OTI loop is intended to provide a unique identification of the transaction set that is the subject of this application acknowledgment.

Example

If Transaction Set Control Number (OTI-09) is present, then Group Control Number (OTI-08) is required

OTI-01 · 110 · Application Acknowledgment Code · Required · Code indicating the application system edit results of the business data · TA Transaction Set Accept TE Transaction Set Accept with Error TR Transaction Set Reject

OTI-02 · 128 · Reference Identification Qualifier · Required · Code qualifying the Reference Identification OTI02 contains the qualifier identifying the business transaction from the original business application, and OTI03 will contain the original business application identification. · BA Retirement Plan Policy Number Used to report CP Intermodal load number. BM Bill of Lading Number BN Booking Number

OTI-03 · 127 · Reference Identification · Required Min 1 Max 30 · Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier OTI03 is the primary reference identification or number used to uniquely identify the original transaction set.

OTI-06 · 373 · Date · Optional CCYYMMDD format · Date expressed as CCYYMMDD OTI06 is the group date.

OTI-07 · 337 · Time · Optional HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format · Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99) OTI07 is the group time.

OTI-08 · 28 · Group Control Number · Optional Min 1 Max 9 · Assigned number originated and maintained by the sender

OTI-09 · 329 · Transaction Set Control Number · Optional Min 4 Max 9 · Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set If used, OTI09 through OTI10 will contain values from the original electronic transaction set generated by the sender.

REF

020

Equipment Number

OptionalMax use 12

To specify identifying information

• The REF segment allows for the provision of secondary reference identification or numbers required to uniquely identify the original transaction set. The primary reference identification or number should be provided in elements OTI02-03.

Example

Variants (all may be used)

REFWaybill Number

REF-01 · 128 · Reference Identification Qualifier · Required · Code qualifying the Reference Identification · EQ Equipment Number

REF-02 · 127 · Reference Identification · Optional Min 1 Max 30 · Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier · Usage notes Equipment initial and number.

REF

020

Waybill Number

OptionalMax use 12

To specify identifying information

• The REF segment allows for the provision of secondary reference identification or numbers required to uniquely identify the original transaction set. The primary reference identification or number should be provided in elements OTI02-03.

Example

Variants (all may be used)

REFEquipment Number

REF-01 · 128 · Reference Identification Qualifier · Required · Code qualifying the Reference Identification · WY Waybill Number

REF-02 · 127 · Reference Identification · Optional Min 1 Max 30 · Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier · Usage notes Equipment initial and number.

TED Loop

OptionalMax >1

TED

070

Technical Error Description

RequiredMax use 1

To identify the error and, if feasible, the erroneous segment, or data element, or both

TED-01 · 647 · Application Error Condition Code · Required · Code indicating application error condition · ZZZ Mutually Defined

TED-02 · 3 · Free Form Message · Optional Min 1 Max 60 · Free-form text If used, TED02 will contain a generic description of the data in error (e.g., part number, date, reference number, etc.).

SE

090

Transaction Set Trailer

RequiredMax use 1

To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)

SE-01 · 96 · Number of Included Segments · Required Min 1 Max 10 · Total number of segments included in a transaction set including ST and SE segments

SE-02 · 329 · Transaction Set Control Number · Required Min 4 Max 9 · Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set

GE

Functional Group Trailer

RequiredMax use 1

To indicate the end of a functional group and to provide control information

GE-01 · 97 · Number of Transaction Sets Included · Required Min 1 Max 6 · Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element

GE-02 · 28 · Group Control Number · Required Min 1 Max 9 · Assigned number originated and maintained by the sender

IEA

Interchange Control Trailer

RequiredMax use 1

To define the end of an interchange of zero or more functional groups and interchange-related control segments

IEA-01 · I16 · Number of Included Functional Groups · Required Min 1 Max 5 · A count of the number of functional groups included in an interchange

IEA-02 · I12 · Interchange Control Number · Required Min 9 Max 9 · A control number assigned by the interchange sender

EDI Samples

301 Transaction Set Accepted

ST*824*301801001
BGN*00*1*20181105*1728
OTI*TA*BN*17531000***20181105*2222*161330000*0001
SE*4*301801001

301 Transaction Set Accepted With Errors

ST*824*301802001
BGN*00*1*20181105*1722
OTI*TE*BN*13660675***20181105*2217*28905*0001
TED*ZZZ*MISSING VESSEL NAME IN V1 SEGMENT
TED*ZZZ*MISSING VOYAGE NUMBER IN V1 SEGMENT
TED*ZZZ*UNABLE TO MATCH LOCATION CODE IN R4 SEGMENT
SE*7*301802001

301 Transaction Set Rejected

ST*824*301801001
BGN*00*1*20181105*1728
OTI*TR*BN*19996110***20181105*2222*161331102*0001
TED*ZZZ*UNABLE TO MATCH ISO EQUIPMENT CODE IN Y4 SEGMENT
SE*5*301801001

404 Transaction Set Accepted

ST*824*503001
BGN*00*404*20181105*1828
OTI*TA*BM*SAMPLE640400***20181105*1808*52184*0001
REF*EQ*ABCU663542
REF*WY*432100
SE*6*503001

404 Transaction Set Accepted With Errors

ST*824*0001
BGN*00*404*20181105*1342
OTI*TE*BM*8003000000***20181105*134159*40199*401990001
REF*EQ*PROX70000
TED*ZZZ*MISSING REFERENCE HS (HARMONIZED CODE), PLEASE PROVIDE DATA
TED*ZZZ*MISSING REFERENCE FRC (FIRMS CODE), PLEASE PROVIDE DATA
SE*7*0001

404 Transaction Set Rejected

ST*824*0001
BGN*00*404*20181027*0147
OTI*TR*BA*TT80100000***20181027*014659*69320*69320001
REF*EQ*ABCU00009860640
TED*ZZZ*ERP & PHONE NUMBER MISSING ON EDI DATA.
SE*6*0001