Skip to main content
To access all articles and videos, log in through Portal. Learn how

Functional Acknowledgment: Standard EDI payload

  • Updated

If you would like confirmation that the TradeCentric platform received your EDI document request, you can request that we send an X12 997 functional acknowledgment request to your system. We can deliver functional acknowledgments for EDI invoices, purchase order acknowledgments (POAs), or advanced shipment notices (ASNs). Delivery methods vary by integration, but we support methods such as AS2, HTTP, and SFTP.

To receive functional acknowledgments as expected, your system must accept our standard EDI format. This article describes the standard EDI request format.

Note: This acknowledgment payload only confirms that we received your document request, not that the buyer's eProcurement system accepted the document.

Jump to:

Request payload (from TradeCentric)

Request segment details

 

Request payload (from TradeCentric)

The code block below shows an example functional acknowledgment payload in our standard EDI format:

X12
997
Functional acknowledgment request
ISA*00*          *00*          *ZZ*TEST_CORP      *ZZ*SUPPLIER_INC   *221118*1057*U*00401*000000003*0*P*>~
GS*FA*TEST_CORP*SUPPLIER_INC*20221118*1057*3*X*004010~
ST*997*1234~
AK1*PR*2~
AK2*855*0001~
AK5*A~
AK9*A*1*1*1~
SE*6*1234~
GE*1*3~
IEA*1*000000003~

 

Request segment details

A standard functional acknowledgment EDI payload has envelope, heading, detail, and summary sections. The subsections explain the segments and fields in each payload section.

String and number types: ID = standard EDI code, AN = alphanumeric text, N0 = whole number, N2 = decimal number without decimal point, R = decimal number with decimal point

 

Envelope

Contains the entire payload and provides the general identifying information described in the subsections below

 

ISA - Interchange control header

Provides identifying information about the payload

Example
ISA*00*          *00*          *ZZ*TEST_CORP      *ZZ*SUPPLIER_INC   *221118*1057*U*00401*000000003*0*P*>~
ISA field breakdown
  • ISA-01
    Authorization information qualifier

    Type: String (ID)Length: 2

    Specifies the type of authorization information included

    Example: 00 = no authorization information is included

  • ISA-02
    Authorization information

    Type: String (AN)Length: 10

    Provides the authorization value when authorization information is included

    Example:           = 10 spaces to indicate that the authorization information is blank

  • ISA-03
    Security information qualifier

    Type: String (ID)Length: 2

    Specifies whether security information is included

    Example: 00 = no security information is included

  • ISA-04
    Security information

    Type: String (AN)Length: 10

    Provides the security value when security information is included

    Example:           = 10 spaces to indicate that the security information is blank

  • ISA-05
    Sender qualifier

    Type: String (ID)Length: 2

    Specifies the type of sender identifier provided

    Example: ZZ = mutually defined by buyer and supplier

  • ISA-06
    Sender identifier

    Type: String (AN)Length: 15

    Provides the sender identifier

    Example: TEST_CORP

  • ISA-07
    Receiver qualifier

    Type: String (ID)Length: 2

    Specifies the type of receiver identifier provided

    Example: ZZ = mutually defined by buyer and supplier

  • ISA-08
    Receiver identifier

    Type: String (AN)Length: 15

    Provides the receiver identifier

    Example: SUPPLIER_INC

  • ISA-09
    Interchange date

    Format: YYMMDD

    Provides the date when the payload was created

    Example: 221118 = November 18, 2022

  • ISA-10
    Interchange time

    Format: HHMM

    Provides the time when the payload was created

    Example: 1057 = 10:57

  • ISA-11
    Interchange control standards identifier

    Type: String (ID)Length: 1

    Specifies the standards organization that defines the format used for the payload

    Example: U = U.S. EDI Community of ASC X12, TDCC, and UCS

  • ISA-12
    Interchange control version code

    Type: String (ID)Length: 5

    Specifies the X12 version used for the payload

    Example: 00401

  • ISA-13
    Interchange control number

    Type: Numeric (N0)Length: 9

    Provides a unique control number for the payload

    Example: 000000003

  • ISA-14
    Acknowledgment requested

    Type: String (ID)Length: 1

    Specifies whether TradeCentric requests an acknowledgment that your organization received this document

    Values: 0 = no acknowledgment requested, 1 = acknowledgment requested

  • ISA-15
    Interchange usage indicator code

    Type: String (ID)Length: 1

    Indicates how the receiver should process the payload

    Example: P = production data

    Other codes: T = test data, I = informational data

  • ISA-16
    Component element separator

    Type: DelimiterLength: 1

    Specifies the unique character used to separate multiple values within one field

    Example: >

 

GS - Functional group header

Assigns a functional group to the acknowledgment in the payload

Example
GS*FA*TEST_CORP*SUPPLIER_INC*20221118*1057*3*X*004010~
GS field breakdown
  • GS-01
    Functional identifier code

    Type: String (ID)Length: 2

    Specifies the transaction type for the group

    Will be FA

  • GS-02
    Application sender's code

    Type: String (AN)Length: 2-15

    Provides the sender code for the group

    Example: TEST_CORP

  • GS-03
    Application receiver's code

    Type: String (AN)Length: 2-15

    Provides the receiver code for the group

    Example: SUPPLIER_INC

  • GS-04
    Functional group date

    Format: YYYYMMDD

    Provides the date when the group was created

    Example: 20221118 = November 18, 2022

  • GS-05
    Functional group time

    Format: HHMM

    Provides the time when the group was created

    Example: 1057 = 10:57

  • GS-06
    Group control number

    Type: Numeric (N0)Length: 1-9

    Provides a unique control number for the group

    Example: 3

  • GS-07
    Responsible agency code

    Type: String (ID)Length: 1

    Specifies the standards agency

    Will be X

  • GS-08
    Version or release code

    Type: String (AN)Length: 1-12

    Provides the X12 version used for the group

    Example: 004010

 

Heading

Starts the acknowledgment and provides the identifying information described in the subsections below

 

ST - Transaction set header

Start of the acknowledgment document

Example
ST*997*1234~
ST field breakdown
  • ST-01
    Transaction set identifier code

    Type: String (ID)Length: 3

    Specifies the transaction type

    Example: 997 = functional acknowledgment

  • ST-02
    Transaction set control number

    Type: String (AN)Length: 4-9

    Provides a unique control number for the transaction set

    Example: 1234

 

AK1 - Functional group response header

Provides details about the functional group being acknowledged

Note: Because we recommend one functional group per payload, we'll typically only include one functional group acknowledgment.

Example
AK1*PR*2~
AK1 field breakdown
  • AK1-01
    Functional identifier code

    Type: String (ID)Length: 2

    Specifies the type of group being acknowledged

    Example: IN = invoice

    Other common values: PR = POA, SH = ASN

  • AK1-02
    Group control number

    Type: Numeric (N0)Length: 1-9

    Provides the control number from GS-06 of the group being acknowledged

    Example: 2

 

Detail

Provides the transaction set acknowledgment details, which are described in the subsections below

 

AK2 and AK5 loop - Transaction set acknowledgment

Provides identifying information and an acknowledgment status for the transaction set

Note: Because we recommend one transaction set per payload, we'll typically only include one transaction set acknowledgment.

Example
AK2*855*0001~
AK5*A~
AK2/AK5 loop breakdown
  • AK2
    Transaction set response header

    Identifies the transaction set being acknowledged

    • AK2-01 Transaction set identifier code

      Type: String (ID)Length: 3

      Specifies the type of transaction set

      Example: 810 = invoice

      Other common values: 855 = POA, 856 = ASN

    • AK2-02 Transaction set control number

      Type: String (AN)Length: 4-9

      Provides the transaction set control number from the ST-02 field

      Example: 0001

  • AK5
    Transaction set response trailer

    Provides status details for the transaction set being acknowledged

    • AK5-01 Transaction set acknowledgment code

      Type: String (ID)Length: 1

      Specifies whether our platform accepted the transaction set and whether it processed with errors

      Example: A = accepted

      Other common codes: E = accepted with errors, P = partially accepted, R = rejected

    • AK5-02 Syntax error code

      Type: String (ID)Length: 1-3

      Describes any errors that happened when our platform processed the transaction set

      Example: blank in this payload

      Common codes: 3 = the control numbers in ST and SE don't match, 4 = the segment count in SE doesn't match the actual count, 5 = one or more segments have an error

 

Summary

Ends the acknowledgment and the payload using the summary details described in the subsections below

 

AK9 - Functional group response trailer

Provides the acknowledgment status for the functional group

Example
AK9*A*1*1*1~
AK9 field breakdown
  • AK9-01
    Functional group acknowledgment code

    Type: String (ID)Length: 1

    Specifies whether our platform accepted the functional group and whether it processed with errors

    Example: A = accepted

    Other common codes: E = accepted with errors, P = partially accepted, R = rejected

  • AK9-02
    Number of transaction sets included

    Type: Numeric (N0)Length: 1-6

    Provides the number of transaction sets included in the functional group

    Example: 1

  • AK9-03
    Number of received transaction sets

    Type: Numeric (N0)Length: 1-6

    Provides the number of transaction sets that we received from the functional group

    Example: 1

  • AK9-04
    Number of accepted transaction sets

    Type: Numeric (N0)Length: 1-6

    Provides the number of transaction sets that our platform accepted from the functional group

    Example: 1

  • AK9-05
    Syntax error code

    Type: String (ID)Length: 1-3

    Describes any errors that happened when our platform processed the functional group

    Example: 5 = one or more segments have an error

 

SE - Transaction set trailer

Ends the acknowledgment

Example
SE*6*1234~
SE field breakdown
  • SE-01
    Number of included segments

    Type: Numeric (N0)Min value: 1

    Provides the total number of segments from ST through SE

    Example: 6

  • SE-02
    Transaction set control number

    Type: String (AN)Length: 4-9

    Provides the same control number as ST-02

    Example: 1234

 

GE - Functional group trailer

Ends the functional group

Example
GE*1*3~
GE field breakdown
  • GE-01
    Number of transaction sets included

    Type: Numeric (N0)

    Provides the number of transaction sets included in the functional group

    Example: 1

  • GE-02
    Group control number

    Type: Numeric (N0)Length: 1-9

    Provides the same control number as GS-06

    Example: 3

 

IEA - Interchange control trailer

Ends the payload

Example
IEA*1*000000003~
IEA field breakdown
  • IEA-01
    Number of included functional groups

    Type: Numeric (N0)Length: 1-5

    Provides the number of functional groups included in the payload

    Example: 1

  • IEA-02
    Interchange control number

    Type: Numeric (N0)Length: 9

    Provides the same control number as ISA-13

    Example: 000000003

Was this article helpful?
0 out of 0 found this helpful
Return to top
© 2026 TradeCentric. All rights reserved.
Confidential and proprietary. For use by TradeCentric and organizations under NDA only. Not for public distribution.