APERAK Application error and acknowledgement message (D99A)

This is the standard EDIFACT D99A spec, with 5 loops and 17 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 (39 KB) Generate classes

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

The intermediary model ediFabric Native loads with set_map. Native supports X12 today, and EDIFACT is coming. Download Native (1 KB)

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

ediFabric Native

Native supports X12 today, and EDIFACT is coming. When it's available, map version D99A to this Native model with set_map to parse APERAK files to JSON from Python, Java, C or C#. See ediFabric Native.

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 APERAK classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each APERAK as JSON. To work with APERAK data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSAPERAK. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

APERAK structure

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

ID	Name	Usage	Max use
UNH	Message Header	Optional	1
BGM	BEGINNING OF MESSAGE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	9
FTX	FREE TEXT	Optional	9
CNT	CONTROL TOTAL	Optional	9
Loop DOC	DOCUMENT/MESSAGE DETAILS	Optional	99
DOC	DOCUMENT/MESSAGE DETAILS	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	99
Loop RFF	REFERENCE	Optional	9
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	9
Loop NAD	NAME AND ADDRESS	Optional	9
NAD	NAME AND ADDRESS	Mandatory	1
CTA	CONTACT INFORMATION	Optional	9
COM	COMMUNICATION CONTACT	Optional	9
Loop ERC	APPLICATION ERROR INFORMATION	Optional	99999
ERC	APPLICATION ERROR INFORMATION	Mandatory	1
FTX	FREE TEXT	Optional	1
Loop RFF	REFERENCE	Optional	9
RFF	REFERENCE	Mandatory	1
FTX	FREE TEXT	Optional	9
UNT	Message Trailer	Optional	1