823 Lockbox (003030)

This is the standard X12 003030 spec, with 6 loops and 34 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 (35 KB) Generate classes

The ediFabric .NET template, class TS823. It needs the common segments, composites and codes of X12 003030, one download for every transaction in the version. Download C# (1 KB) Common files (159 KB)

The intermediary model ediFabric Native loads with set_map. Download Native (29 KB)

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

ediFabric Native

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

ediFabric Native returns each 823 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 TS823. 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.

823 structure

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

ID	Name	Usage	Max use
ST	Transaction Set Header	Optional	1
Loop N1	Name	Mandatory	2
N1	Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Numbers	Optional	12
PER	Administrative Communications Contact	Optional	3
Loop DEP	Deposit	Mandatory	100
DEP	Deposit	Mandatory	1
AMT	Monetary Amount	Mandatory	1
QTY	Quantity	Mandatory	2
REF	Reference Numbers	Optional	5
DTM	Date/Time Reference	Optional	10
Loop BAT	Batch	Optional	100
BAT	Batch	Mandatory	1
AVA	Funds Availability	Optional	10
AMT	Monetary Amount	Optional	1
QTY	Quantity	Optional	1
DTM	Date/Time Reference	Optional	10
Loop BPS	Beginning Segment for Payment Order/Remittance Advice	Optional	1000
BPS	Beginning Segment for Payment Order/Remittance Advice	Mandatory	1
CUR	Currency	Optional	1
REF	Reference Numbers	Optional	5
DTM	Date/Time Reference	Optional	10
AVA	Funds Availability	Optional	1
Loop N1	Name	Optional	200
N1	Name	Mandatory	1
N2	Additional Name Information	Optional	2
N3	Address Information	Optional	2
N4	Geographic Location	Optional	1
REF	Reference Numbers	Optional	12
PER	Administrative Communications Contact	Optional	3
Loop RMT	Remittance Advice	Optional	10000
RMT	Remittance Advice	Mandatory	1
N1	Name	Optional	1
CUR	Currency	Optional	1
REF	Reference Numbers	Optional	5
DTM	Date/Time Reference	Optional	10
SE	Transaction Set Trailer	Optional	1