Hudson's Bay
/
Functional Acknowledgment
  • Specification
  • EDI Inspector
Stedi maintains this guide based on public documentation from Hudson's Bay. Contact Hudson's Bay for official EDI specifications. To report any errors in this guide, please contact us.
Go to Stedi Network
Hudson's Bay logo

X12 997 Functional Acknowledgment

X12 Release 4010
Delimiters
  • ~ Segment
  • * Element
  • > Component
EDI sample
  • Sample
View the latest version of this implementation guide as an interactive webpage
https://www.stedi.com/app/guides/view/hudsons-bay/functional-acknowledgment/01H82J49XAN6SNFP78NHRRVR9E
Powered by
Build EDI implementation guides at stedi.com
Overview
ISA
-
Interchange Control Header
Max use 1
Required
GS
-
Functional Group Header
Max use 1
Required
heading
ST
010
Transaction Set Header
Max use 1
Required
AK1
020
Functional Group Response Header
Max use 1
Required
AK2 Loop
AK2
030
Transaction Set Response Header
Max use 1
Required
AK3 Loop
AK5
060
Transaction Set Response Trailer
Max use 1
Required
AK9
070
Functional Group Response Trailer
Max use 1
Required
SE
080
Transaction Set Trailer
Max use 1
Required
GE
-
Functional Group Trailer
Max use 1
Required
IEA
-
Interchange Control Trailer
Max use 1
Required
ISA

Interchange Control Header

RequiredMax use 1
Example
ISA-01
I01
Authorization Information Qualifier
Required
Identifier (ID)
00
No Authorization Information Present (No Meaningful Information in I02)
ISA-02
I02
Authorization Information
Required
String (AN)
Min 10Max 10
ISA-03
I03
Security Information Qualifier
Required
Identifier (ID)
00
No Security Information Present (No Meaningful Information in I04)
ISA-04
I04
Security Information
Required
String (AN)
Min 10Max 10
ISA-05
I05
Interchange ID Qualifier
Required
Identifier (ID)
Min 2Max 2
Codes
ISA-06
I06
Interchange Sender ID
Required
String (AN)
Min 15Max 15
ISA-07
I05
Interchange ID Qualifier
Required
Identifier (ID)
Min 2Max 2
Codes
ISA-08
I07
Interchange Receiver ID
Required
String (AN)
Min 15Max 15
ISA-09
I08
Interchange Date
Required
Date (DT)
YYMMDD format
ISA-10
I09
Interchange Time
Required
Time (TM)
HHMM format
ISA-11
I10
Interchange Control Standards Identifier
Required
Identifier (ID)
U
U.S. EDI Community of ASC X12, TDCC, and UCS
ISA-12
I11
Interchange Control Version Number
Required
Identifier (ID)
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
Numeric (N0)
Min 9Max 9
ISA-14
I13
Acknowledgment Requested
Required
Identifier (ID)
Min 1Max 1
0
No Acknowledgment Requested
1
Interchange Acknowledgment Requested
ISA-15
I14
Usage Indicator
Required
Identifier (ID)
Min 1Max 1
I
Information
P
Production Data
T
Test Data
ISA-16
I15
Component Element Separator
Required
String (AN)
Min 1Max 1
>
Component Element Separator

Functional Group Header

RequiredMax use 1
Example
GS-01
479
Functional Identifier Code
Required
Identifier (ID)
FA
Functional Acknowledgment (997)
GS-02
142
Application Sender's Code
Required
String (AN)
Min 2Max 15
GS-03
124
Application Receiver's Code
Required
String (AN)
Min 2Max 15
Required
Date (DT)
CCYYMMDD format
Required
Time (TM)
HHMM, HHMMSS, HHMMSSD, or HHMMSSDD format
GS-06
28
Group Control Number
Required
Numeric (N0)
Min 1Max 9
GS-07
455
Responsible Agency Code
Required
Identifier (ID)
Min 1Max 2
T
Transportation Data Coordinating Committee (TDCC)
X
Accredited Standards Committee X12
GS-08
480
Version / Release / Industry Identifier Code
Required
String (AN)
004010
Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1997

Heading

ST
010
Heading > ST

Transaction Set Header

RequiredMax use 1
Example
ST-01
143
Transaction Set Identifier Code
Required
Identifier (ID)
997
Functional Acknowledgment
ST-02
329
Transaction Set Control Number
Required
Numeric (N)
Min 4Max 9
AK1
020
Heading > AK1

Functional Group Response Header

RequiredMax use 1
Usage notes
Example
AK1-01
479
Functional Identifier Code
Required
Identifier (ID)
Min 2Max 2
AK1-02
28
Group Control Number
Required
Numeric (N0)
Min 1Max 9
AK2 Loop
RequiredMax >1
AK2
030
Heading > AK2 Loop > AK2

Transaction Set Response Header

RequiredMax use 1
Usage notes
Example
AK2-01
143
Transaction Set Identifier Code
Required
Identifier (ID)
Min 3Max 3
AK2-02
329
Transaction Set Control Number
Required
Numeric (N)
Min 4Max 9
AK3 Loop
OptionalMax >1
AK3
040
Heading > AK2 Loop > AK3 Loop > AK3

Data Segment Note

RequiredMax use 1
Usage notes
Example
AK3-01
721
Segment ID Code
Required
Identifier (ID)
Min 2Max 3
AK3-02
719
Segment Position in Transaction Set
Required
Numeric (N0)
Min 1Max 6
AK3-03
447
Loop Identifier Code
Required
String (AN)
Min 1Max 6
AK3-04
720
Segment Syntax Error Code
Required
Identifier (ID)
Min 1Max 3
AK4
050
Heading > AK2 Loop > AK3 Loop > AK4

Data Element Note

OptionalMax use 99
Usage notes
Example
AK4-01
C030
Position in Segment
RequiredMax use 1
Code indicating the relative position of a simple data element, or the relative position of a composite data structure combined with the relative position of the component data element within the composite data structure, in error; the count starts with 1 for the simple data element or composite data structure immediately following the segment ID
C030-01
722
Element Position in Segment
Required
Numeric (N0)
Min 1Max 2
AK4-02
725
Data Element Reference Number
Required
Numeric (N0)
Min 1Max 4
AK4-03
723
Data Element Syntax Error Code
Required
Identifier (ID)
Min 1Max 3
AK4-04
724
Copy of Bad Data Element
Required
String (AN)
Min 1Max 99
AK3 Loop end
AK5
060
Heading > AK2 Loop > AK5

Transaction Set Response Trailer

RequiredMax use 1
Usage notes
Example
AK5-01
717
Transaction Set Acknowledgment Code
Required
Identifier (ID)
A
Accepted
E
Accepted But Errors Were Noted
R
Rejected
AK5-02
718
Transaction Set Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK5-03
718
Transaction Set Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK5-04
718
Transaction Set Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK5-05
718
Transaction Set Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK5-06
718
Transaction Set Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK2 Loop end
AK9
070
Heading > AK9

Functional Group Response Trailer

RequiredMax use 1
Usage notes
Example
AK9-01
715
Functional Group Acknowledge Code
Required
Identifier (ID)
A
Accepted
E
Accepted, But Errors Were Noted.
R
Rejected
AK9-02
97
Number of Transaction Sets Included
Required
Numeric (N0)
Min 1Max 6
AK9-03
123
Number of Received Transaction Sets
Required
Numeric (N0)
Min 1Max 6
AK9-04
2
Number of Accepted Transaction Sets
Required
Numeric (N0)
Min 1Max 6
AK9-05
716
Functional Group Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK9-06
716
Functional Group Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK9-07
716
Functional Group Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK9-08
716
Functional Group Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
AK9-09
716
Functional Group Syntax Error Code
Optional
Identifier (ID)
Min 1Max 3
SE
080
Heading > SE

Transaction Set Trailer

RequiredMax use 1
Example
SE-01
96
Number of Included Segments
Required
Numeric (N0)
Min 1Max 10
SE-02
329
Transaction Set Control Number
Required
Numeric (N)
Min 4Max 9
Heading end

Functional Group Trailer

RequiredMax use 1
Example
GE-01
97
Number of Transaction Sets Included
Required
Numeric (N0)
Min 1Max 6
GE-02
28
Group Control Number
Required
Numeric (N0)
Min 1Max 9

Interchange Control Trailer

RequiredMax use 1
Example
IEA-01
I16
Number of Included Functional Groups
Required
Numeric (N0)
Min 1Max 5
IEA-02
I12
Interchange Control Number
Required
Numeric (N0)
Min 9Max 9
EDI Samples

Sample

ISA*00* *00* *ZZ*SENDER *ZZ*RECEIVER *231101*0157*U*00401*000000001*0*T*>
GS*FA*SENDERGS*RECEIVERGS*20231101*015758*000000001*X*004010
ST*997*401001280
AK1*SH*168
AK2*856*0001
AK5*A
AK2*856*0002
AK5*A
AK9*A*2*2*2
SE*8*401001280
GE*1*000000001
IEA*1*000000001

Stedi is a registered trademark of Stedi, Inc. All names, logos, and brands of third parties listed on this page are trademarks of their respective owners (including “X12”, which is a trademark of X12 Incorporated). Stedi, Inc. and its products and services are not endorsed by, sponsored by, or affiliated with these third parties. Use of these names, logos, and brands is for identification purposes only, and does not imply any such endorsement, sponsorship, or affiliation.