831 Application Control Totals (005020)

This is the standard X12 005020 spec, with 1 loops and 9 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.

Loading the spec…
The spec as an OpenAPI 3 schema with x-openedi-* extensions, for ediFabric Native, ediFabric Cloud and the EDI Spec Builder. Download OpenEDI (50 KB) Generate classes
The ediFabric .NET template, class TS831. It needs the common segments, composites and codes of X12 005020, one download for every transaction in the version. Download C# (1 KB) Common files (267 KB)
The intermediary model ediFabric Native loads with set_map. Download Native (34 KB)

Use the 831 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 831 files into TS831 objects. See ediFabric .NET.

ediFabric Native

Map version 005020 to the Native model with set_map, then parse 831 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 831 classes in Python, Java, Node.js, Go, Rust or C

ediFabric Native returns each 831 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 TS831. 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.

831 structure

Loops and segments of the standard 831, with their usage and maximum repeats.

IDNameUsageMax use
STTransaction Set HeaderOptional1
BGNBeginning SegmentMandatory1
DTMDate/Time ReferenceOptional2
N9Extended Reference InformationOptional>1
TRNTraceOptional>1
QTYQuantity InformationOptional10
Loop AMTMonetary Amount InformationOptional>1
AMTMonetary Amount InformationMandatory1
QTYQuantity InformationOptional1
SETransaction Set TrailerOptional1