824 Application Advice (005020)
This is the standard X12 005020 spec, with 5 loops and 23 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 824 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 824 files into TS824 objects. See ediFabric .NET.
ediFabric Native
Map version 005020 to the Native model with set_map, then parse 824 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 824 classes in Python, Java, Node.js, Go, Rust or C
ediFabric Native returns each 824 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 TS824. 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.
For a sample file, the same data as JSON, and code to parse, validate and generate the 824, see the 824 transaction guide.
824 structure
Loops and segments of the standard 824, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| ST | Transaction Set Header | Optional | 1 |
| BGN | Beginning Segment | Mandatory | 1 |
| Loop N1 | Party Identification | Optional | >1 |
| N1 | Party Identification | Mandatory | 1 |
| N2 | Additional Name Information | Optional | 2 |
| N3 | Party Location | Optional | 2 |
| N4 | Geographic Location | Optional | 1 |
| REF | Reference Information | Optional | 12 |
| PER | Administrative Communications Contact | Optional | 3 |
| Loop OTI | Original Transaction Identification | Mandatory | >1 |
| OTI | Original Transaction Identification | Mandatory | 1 |
| REF | Reference Information | Optional | 12 |
| DTM | Date/Time Reference | Optional | 2 |
| PER | Administrative Communications Contact | Optional | 3 |
| AMT | Monetary Amount Information | Optional | >1 |
| QTY | Quantity Information | Optional | >1 |
| NM1 | Individual or Organizational Name | Optional | 9 |
| Loop TED | Technical Error Description | Optional | >1 |
| TED | Technical Error Description | Mandatory | 1 |
| CTX | Context | Optional | 10 |
| NTE | Note/Special Instruction | Optional | 100 |
| RED | Related Data | Optional | 100 |
| Loop LM | Code Source Information | Optional | >1 |
| LM | Code Source Information | Mandatory | 1 |
| Loop LQ | Industry Code Identification | Mandatory | 100 |
| LQ | Industry Code Identification | Mandatory | 1 |
| RED | Related Data | Optional | 100 |
| SE | Transaction Set Trailer | Optional | 1 |