CUSPED Periodic customs declaration message (D04B)

This is the standard EDIFACT D04B spec, with 34 loops and 102 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 (105 KB) Generate classes

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

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

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

ediFabric Native

Native supports X12 today, and EDIFACT is coming. When it's available, map version D04B to this Native model with set_map to parse CUSPED 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 CUSPED classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each CUSPED as JSON. To work with CUSPED data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSCUSPED. 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.

CUSPED structure

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

ID	Name	Usage	Max use
UNH	Message Header	Optional	1
BGM	BEGINNING OF MESSAGE	Mandatory	1
CST	CUSTOMS STATUS OF GOODS	Optional	1
LOC	PLACE/LOCATION IDENTIFICATION	Optional	99
DTM	DATE/TIME/PERIOD	Optional	99
GEI	PROCESSING INFORMATION	Optional	99
FII	FINANCIAL INSTITUTION INFORMATION	Optional	1
Loop RFF	REFERENCE	Optional	99
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	9
Loop NAD	NAME AND ADDRESS	Optional	99
NAD	NAME AND ADDRESS	Mandatory	1
RFF	REFERENCE	Optional	9
Loop CTA	CONTACT INFORMATION	Optional	9
CTA	CONTACT INFORMATION	Mandatory	1
COM	COMMUNICATION CONTACT	Optional	9
Loop MOA	MONETARY AMOUNT	Optional	99
MOA	MONETARY AMOUNT	Mandatory	1
Loop CUX	CURRENCIES	Optional	9
CUX	CURRENCIES	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	1
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	99
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	9
GEI	PROCESSING INFORMATION	Optional	9
CNT	CONTROL TOTAL	Optional	9
Loop DMS	DOCUMENT/MESSAGE SUMMARY	Optional	9999
DMS	DOCUMENT/MESSAGE SUMMARY	Mandatory	1
CNT	CONTROL TOTAL	Optional	9
RFF	REFERENCE	Optional	9
DTM	DATE/TIME/PERIOD	Optional	9
GEI	PROCESSING INFORMATION	Optional	99
LOC	PLACE/LOCATION IDENTIFICATION	Optional	99
EQD	EQUIPMENT DETAILS	Optional	999
PAC	PACKAGE	Optional	9
TDT	TRANSPORT INFORMATION	Optional	9
Loop NAD	NAME AND ADDRESS	Optional	9
NAD	NAME AND ADDRESS	Mandatory	1
RFF	REFERENCE	Optional	9
Loop CTA	CONTACT INFORMATION	Optional	9
CTA	CONTACT INFORMATION	Mandatory	1
COM	COMMUNICATION CONTACT	Optional	9
Loop DOC	DOCUMENT/MESSAGE DETAILS	Optional	99
DOC	DOCUMENT/MESSAGE DETAILS	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	9
LOC	PLACE/LOCATION IDENTIFICATION	Optional	1
NAD	NAME AND ADDRESS	Optional	1
Loop TOD	TERMS OF DELIVERY OR TRANSPORT	Optional	9
TOD	TERMS OF DELIVERY OR TRANSPORT	Mandatory	1
LOC	PLACE/LOCATION IDENTIFICATION	Optional	9
FTX	FREE TEXT	Optional	9
Loop MOA	MONETARY AMOUNT	Optional	99
MOA	MONETARY AMOUNT	Mandatory	1
Loop CUX	CURRENCIES	Optional	9
CUX	CURRENCIES	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	1
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	99
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	9
GEI	PROCESSING INFORMATION	Optional	9
Loop CST	CUSTOMS STATUS OF GOODS	Optional	9999
CST	CUSTOMS STATUS OF GOODS	Mandatory	1
FTX	FREE TEXT	Optional	9
LOC	PLACE/LOCATION IDENTIFICATION	Optional	99
DTM	DATE/TIME/PERIOD	Optional	9
MEA	MEASUREMENTS	Optional	99
NAD	NAME AND ADDRESS	Optional	9
TDT	TRANSPORT INFORMATION	Optional	9
Loop PAC	PACKAGE	Optional	99
PAC	PACKAGE	Mandatory	1
Loop PCI	PACKAGE IDENTIFICATION	Optional	999
PCI	PACKAGE IDENTIFICATION	Mandatory	1
FTX	FREE TEXT	Optional	1
Loop MOA	MONETARY AMOUNT	Optional	99
MOA	MONETARY AMOUNT	Mandatory	1
Loop CUX	CURRENCIES	Optional	1
CUX	CURRENCIES	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	1
Loop DOC	DOCUMENT/MESSAGE DETAILS	Optional	999
DOC	DOCUMENT/MESSAGE DETAILS	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	9
LOC	PLACE/LOCATION IDENTIFICATION	Optional	1
NAD	NAME AND ADDRESS	Optional	1
GIN	GOODS IDENTITY NUMBER	Optional	99
MOA	MONETARY AMOUNT	Optional	1
Loop IMD	ITEM DESCRIPTION	Optional	1
IMD	ITEM DESCRIPTION	Mandatory	1
FTX	FREE TEXT	Optional	9
Loop RFF	REFERENCE	Optional	99
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	1
Loop TOD	TERMS OF DELIVERY OR TRANSPORT	Optional	1
TOD	TERMS OF DELIVERY OR TRANSPORT	Mandatory	1
LOC	PLACE/LOCATION IDENTIFICATION	Optional	9
FTX	FREE TEXT	Optional	1
Loop GDS	NATURE OF CARGO	Optional	1
GDS	NATURE OF CARGO	Mandatory	1
FTX	FREE TEXT	Optional	1
Loop GEI	PROCESSING INFORMATION	Optional	99
GEI	PROCESSING INFORMATION	Mandatory	1
PCD	PERCENTAGE DETAILS	Optional	1
DTM	DATE/TIME/PERIOD	Optional	1
RFF	REFERENCE	Optional	1
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	99
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	9
GEI	PROCESSING INFORMATION	Optional	1
Loop QVR	QUANTITY VARIANCES	Optional	1
QVR	QUANTITY VARIANCES	Mandatory	1
QTY	QUANTITY	Optional	1
Loop RFF	REFERENCE	Optional	1
RFF	REFERENCE	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	1
Loop GIR	RELATED IDENTIFICATION NUMBERS	Optional	99
GIR	RELATED IDENTIFICATION NUMBERS	Mandatory	1
GEI	PROCESSING INFORMATION	Optional	9
NAD	NAME AND ADDRESS	Optional	1
MEA	MEASUREMENTS	Optional	9
Loop MOA	MONETARY AMOUNT	Optional	99
MOA	MONETARY AMOUNT	Mandatory	1
Loop CUX	CURRENCIES	Optional	1
CUX	CURRENCIES	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	1
Loop TAX	DUTY/TAX/FEE DETAILS	Optional	99
TAX	DUTY/TAX/FEE DETAILS	Mandatory	1
MOA	MONETARY AMOUNT	Optional	9
GEI	PROCESSING INFORMATION	Optional	1
Loop DOC	DOCUMENT/MESSAGE DETAILS	Optional	99
DOC	DOCUMENT/MESSAGE DETAILS	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	9
LOC	PLACE/LOCATION IDENTIFICATION	Optional	1
NAD	NAME AND ADDRESS	Optional	1
Loop AUT	AUTHENTICATION RESULT	Optional	1
AUT	AUTHENTICATION RESULT	Mandatory	1
DTM	DATE/TIME/PERIOD	Optional	9
UNT	Message Trailer	Optional	1