997 Functional Acknowledgment (002040)
This is the standard X12 002040 spec, with 2 loops and 8 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.
Use the 997 spec in your code
ediFabric .NET
Add the C# template and its common files to your project, or reference the template NuGet package, and read 997 files into TS997 objects. See ediFabric .NET.
ediFabric Native
Map version 002040 to the Native model with set_map, then parse 997 files to JSON from Python, Java, C or C#. See Convert between EDI and JSON.
OpenEDI
Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.
Generate 997 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 997 as JSON, with the property names of the OpenEDI schema. To work with that JSON as typed objects, generate classes from the OpenEDI file in your language and deserialize the JSON into TS997. Serialize the objects back to JSON to build EDI with ediFabric Native. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats, so validate files with ediFabric Native. Read more in Generate a class from OpenEDI.
Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.
997 structure
Loops and segments of the standard 997, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| AK1 | Functional Group Response Header | Mandatory | 1 |
| Loop AK2 | Transaction Set Response Header | Optional | 999999 |
| AK2 | Transaction Set Response Header | Mandatory | 1 |
| Loop AK3 | Data Segment Note | Optional | 999999 |
| AK3 | Data Segment Note | Mandatory | 1 |
| AK4 | Data Element Note | Optional | 99 |
| AK5 | Transaction Set Response Trailer | Mandatory | 1 |
| AK9 | Functional Group Response Trailer | Mandatory | 1 |
| SE | Transaction Set Trailer | Optional | 1 |