EDI Acknowledgment Guidelines

See How to Use this Guide before reading the below information.

Message Type:

  • Inbound – IE_EDI_ACKNOWLEDGEMENT_IB
  • Outbound – IE_EDI_ACKNOWLEDGEMENT

Info Exchange Display Name: EDI Acknowledgement

When sending an element in Date or DateTime format, a valid date must be given. "00" is not a valid day or month value and "0000" is not a valid year value.
Data Element Occurs Format Length Enums Req Description
997 [1…1] - - - M -
  ISA [1…1] - - - M ISA interchange envelope.
  ISA01 [1…1] String [2/2] - M Qualifier for authorization control number in ISA02.

Valid values include: *1

  • 00 - No authorization info present.
  • 03 - Additional data identification.
  • TL - Read ServiceLinkId from GS segment.
  ISA02 [1…1] String [10/10] - M Information used for additional identification or authorization of the interchange sender or the data in the interchange. 10 spaces must be present to constitute a valid entry.
  ISA03 [1…1] String [2/2] - M Qualifier for security information in ISA04.

Valid values include: *2

  • 00 - No security information present.
  • 01 - Password
  ISA04 [1…1] String [10/10] - M Identifies security information about the interchange sender or data.
  ISA05 [1…1] String [2/2] EDISenderType M Interchange sender partner ID qualifier. *3
  ISA06 [1…1] String [15/15] - M EDI sender ID mapping to file control header. *4
  ISA07 [1…1] String [2/2] EDISenderType M Interchange receiver partner ID qualifier. *5
  ISA08 [1…1] String [15/15] - M EDI receiver ID mapping to file control header. *6
  ISA09 [1…1] Date [6/6] - M Interchange date in 6 char YYMMDD format. *7
  ISA10 [1…1] Time [4/4] - M Interchange time in 4 char HHMM format. *8
  ISA11 [1…1] String [1/1] - M Repetition separator. Delimiter used to separate repeated occurrences of a simple data element or a composite data structure. This value must be different than the data element separator, component element separator, and the segment terminator. *9
  ISA12 [1…1] String [5/5] - M Interchange control version number.

Valid value = "00501". *10
  ISA13 [1…1] Integer [1/9] - M Interchange Control Number for file control header. *11
  ISA14 [1…1] String [1/1] - M Interchange level acknowledgment requested.

Valid values: *12

  • 0 - No acknowledgment requested.
  • 1 - Interchange level acknowledgment requested.
  ISA15 [1…1] String [1/1] - M Indicates whether the interchange is for production, test, or information purposes.

Valid values : *13

  • I - Information
  • P - Production data
  • T - Test data
  ISA16 [1…1] String [1/1] - M Sub element Separator.
  ISA17 [1…1] String [1/1] - M Delimiter.
  GS [1…*] - - - M GS group functional envelope. Child of ISA. Only one GS group expected per interchange.
  GS01 [1…1] String [2/2] - M GS group function code.

Valid value: FA - Functional Acknowledgment. *14
  GS02 [1…1] String [2/15] - M Application Sender's Code. Used for ServiceLinkId concatenation when ISA01 = 00. *15
  GS03 [1…1] String [2/15] - M Application Receiver's Code. *16
  GS04 [1…1] Date [8/8] - M Current date stamp in 8 char X12 date format YYYYMMDD. *17
  GS05 [1…1] Time [4/8] - M Current time stamp in 6 char X12 time format HHMMSS. *18
  GS06 [1…1] String [1/9] - M Group Control ID Number. *19
  GS07 [1…1] String [1/2] - M Responsible Agency Code.

Valid value = X. *20
  GS08 [1…1] String [1/12] - M X12 message version code.

Valid value = 005010. *21
  ST [1…*] - - - M ST transaction set envelope. Child of GS group. Only one ST transaction expected.
  ST01 [1…1] String [3/3] - M Transaction set identifier code. *22
  ST02 [1…1] String [4/9] - M Transaction set ID number. Counter for each ST segment beginning with 1. *23
  AK1 [1…1] - - - M AK1 Functional Group Response Header.
  AK101 [1…1] String [2/2] - M Functional identification code. Identifies group of related transaction sets. This field identifies the GS level functional code for the EDI message set that is being acknowledged.

Valid values: *24

  • AG = 824 Application Advice (error report)
  • SH = 856 ASN (ship notice/manifest)
  AK102 [1…1] String [1/9] - M Functional group control identification number. *25
  AK103 [1…1] String [1/12] - M Version of the original transaction acknowledgment, from GS08 of the original interchange. *26
  AK2 [0…*] - - - O AK2 transaction set status response data loop. Optional segment and/or data element reporting errors in one or more message sets within functional group.
  AK201 [1…1] String [3/3] - M Transaction set identifier code for the transaction set being acknowledged. *27
  AK202 [1…1] String [1/60] - M Transaction set control identification number. Identifies instance of a transaction set within a function group. *28
  AK3 [0…*] - - - O AK3 data segment syntax status. Optional segment reporting errors in segments within the transaction set. Child of AK2.
  AK301 [1…1] String [2/3] - M Segment identification code for data segment with error. *29
  AK302 [0…1] String [0/10] - O The numerical count position of this data segment from the start of the transaction set. The transaction set header is count position 1. *30
  AK303 [0…1] String [0/4] - O The loop identification number for the segment with the error on the transaction set diagram. *31
  AK304 [0…1] String [0/3] SegmentSyntaxError O Segment syntax error code. *32
  AK4 [0…*] - - - O AK4 syntax status of data element within segment. Optional segment reporting errors in data elements within segments in the transaction set. Child of AK2.
If AK4 segment exists, then AK401 and AK403 are mandatory.
  AK401.1 [1…1] String [2/3] - C The numerical count position of the error data element from the beginning of the segment. Initial count position is 1. *33
  AK401.2 [1…1] String [1/30] - C The numerical count position of the error component data element within a composite data element from the beginning of the composite data structure. Initial count position is 1. *34
  AK401.3 [0…1] Integer [1/4] - O The numerical count position of the error component data element within a composite data element from the beginning of the composite data structure. Initial count position is 1. *35
  AK402 [1…1] String [1/4] - M Repeating data element position identifying the specific repetition of a data element that is in error. *36
  AK403 [1…1] String [1/3] DataElementSyntaxError C Data element syntax error code. *37
  AK404 [1…1] String [1/99] - M Copy of the data element in error. *38
  AK5 [0…1] - - - O AK5 Transaction set response trailer data.
  AK501 [0…1] String [0/1] AcknowledgmentCode O Code indicating the acceptance or rejection based on the syntax check of the transaction set. *39
  AK502 [0…1] String [0/3] TransactionSetErrorCode O Transaction set syntax error code. *40
  AK503 [0…1] String [0/3] TransactionSetErrorCode O Transaction set syntax error code. *41
  AK504 [0…1] String [0/30] TransactionSetErrorCode O Transaction set syntax error code. *42
  AK505 [0…1] String [0/3] TransactionSetErrorCode O Transaction set syntax error code. *43
  AK506 [0…1] String [0/30] TransactionSetErrorCode O Transaction set syntax error code. *44
  AK9 [1…1] - - - M AK1 Functional Group Response Header.
  AK901 [1…1] String [1/1] AcknowledgmentCode M Code indicating the acceptance or rejection based on the syntax check of the functional group. *45
  AK902 [1…1] Integer [1/6] - M Total number of transaction sets included in the functional group that terminated by the trailer record that includes this data element. *46
  AK903 [1…1] Integer [1/6] - M Total number of transaction sets received in functional group being acknowledged. *47
  AK904 [1…1] Integer [1/6] - M Total number of transaction sets accepted in functional group being acknowledged. *48
  AK905 [0…1] String [0/3] FunctionGroupErrorCode O Functional group syntax error code. *49
  AK906 [0…1] String [0/3] FunctionGroupErrorCode O Functional group syntax error code. *50
  AK907 [0…1] String [0/3] FunctionGroupErrorCode O Functional group syntax error code. *51
  AK908 [0…1] String [0/3] FunctionGroupErrorCode O Functional group syntax error code. *52
  AK909 [0…1] String [0/3] FunctionGroupErrorCode O Functional group syntax error code. *53
  SE [1…1] - - - M ST-SE transaction set trailer envelope. Child of GS group. Only one ST transaction expected.
  SE01 [1…1] Integer [1/10] - M Total count of segments in ST-SE transaction set including ST and SE segments.
  SE02 [1…1] String [4/9] - M Transaction set control number.
  GE [1…1] - - - M GS-GE functional group trailer envelope. Child of ISA interchange. Only one GS group expected.
  GE01 [1…1] Integer [1/6] - M Number of transaction sets in functional group.
  GE02 [1…1] String [1/9] - M Functional group control number.
  IEA [1…1] - - - M ISA-IEA interchange control trailer envelope. Only one interchange expected per transmission.
  IEA01 [1…1] Integer [1/5] - M Number of functional groups in interchange.
  IEA02 [1…1] String [9/9] - M Interchange control number.