Install Last updated: 2026-10-16

EdiFabric 11.0.0 is a NuGet package. Install it from nuget.org, add the C# EDI templates for your transactions, then call License.SetSerial with your serial key.

EdiFabric on NuGet Sign up free for Community

Every plan uses the same package and the same C# templates, so upgrading from the community plan replaces only the serial key. See Replace the community plan serial key with your full one.

Install from nuget.org

From the project directory:

dotnet add package EdiFabric

In Visual Studio, open Tools → NuGet Package Manager → Package Manager Console and run:

Install-Package EdiFabric

The package contains the parser, the generator and the validator. The EDI templates for your transactions are C# files. Download them from the EDI spec library and add them to a class library, as described in EDI templates. Every plan, Community or paid, uses the same templates.

Flat-file models are not in the EDI spec library. They are C# classes in the FlatFile.NET examples.

The package targets .NET 8, .NET 9, .NET 10, and .NET Framework 4.8. Pick the target that matches your project. The example solutions ship as net6.0 and net48. To try a later .NET, change TargetFramework and rebuild.

Restore and build:

dotnet restore
dotnet build

Apply the serial key

To evaluate without an account, use the demo serial key bd96a836feca45cb91c86ee65d281f52 until its limited quota runs out. The same key works for ediFabric Native and Cloud. Then sign up free for Community and copy your own serial from Your account. Call this before any parse, generate, validate, or acknowledge. The same serial covers ediFabric .NET, Native, and Cloud on that plan.

// Community
License.SetSerial(serial);

// Developer: 1-day cache; refreshes if the token expires within N seconds
License.EnsureToken(serial, seconds: 3600);

// Enterprise: offline token
License.SetToken(token);

The examples come with the demo serial key in TrialSerialKey in Config.cs (for X12, NET Framework 4.8/EdiFabric.Examples.X12.Common/Config.cs), so they run without an account. When its quota runs out, paste your Community serial there. The .NET 6 projects link that file. The examples call License.SetSerial(Config.TrialSerialKey).

Community is 250 operations per day, non-production, and never expires. One operation is one parse, generate, validate, or acknowledge call. Past the quota, calls throw LicenseException with error 639. Error 635 means the serial was never set.

Read a file

using EdiFabric.Core.Model.Edi;
using EdiFabric.Framework.Readers;
using EdiFabric.Templates.X12004010;

License.SetSerial(serial);

var ediStream = File.OpenRead(@"Files\X12\PurchaseOrders.txt");

List<IEdiItem> ediItems;
using (var ediReader = new X12Reader(ediStream, "ClassLibrary1"))
    ediItems = ediReader.ReadToEnd().ToList();

var purchaseOrders = ediItems.OfType<TS850>();

ClassLibrary1 is the assembly name of the class library that holds the C# templates for the 850. To run a complete solution instead, clone X12.NET and run the demo, as described in C# .NET examples:

cd "NET 6/EdiFabric.Examples.X12.Demo"
dotnet run

Add a DLL reference

Reference the assembly whose target matches the project: .NET 8, .NET 9, .NET 10, or .NET Framework 4.8. The assemblies are in the examples ZIP. A project that uses PackageReference should install the NuGet package instead of mixing in a loose DLL.

Replace the community plan serial key with your full one

Every plan uses the same EdiFabric package and the same C# templates, so you keep the package, the template projects and the code as they are. Replace only the serial key, as described in Apply the serial key, and switch to the license call for your plan: License.EnsureToken on Developer, or License.SetToken on Enterprise.

Implement a token cache

You must implement a token cache to reduce the number of roundtrips to the authentication API and avoid exceeding the daily quota limits. Apply the serial key shows License.EnsureToken and License.SetToken. For more information, see the Serial Key Authentication article.