Skip to main content
Version: v0.0.2

Interface: FunctionalGroupSpec

A single GS..GE functional group. The builder emits the GS header, each transaction set, then GE{count}{control} with GE-01 (the transaction count) computed for you.

Example​

const group: FunctionalGroupSpec = {
  functionalIdCode: "HC",
  groupControlNumber: "1",
  versionRelease: "005010X222A2",
  transactions: [tx],
};

Properties​

applicationReceiverCode?​

readonly optional applicationReceiverCode?: string

GS-03 - application receiver code. Defaults to the interchange receiver id.

applicationSenderCode?​

readonly optional applicationSenderCode?: string

GS-02 - application sender code. Defaults to the interchange sender id.

functionalIdCode​

readonly functionalIdCode: string

GS-01 - functional identifier code (HC claims, HP remittance, …).

groupControlNumber​

readonly groupControlNumber: string

GS-06 / GE-02 - group control number (echoed on GE-02).

groupDate?​

readonly optional groupDate?: string

GS-04 - group date CCYYMMDD. Defaults to the century-expanded ISA-09.

groupTime?​

readonly optional groupTime?: string

GS-05 - group time HHMM. Defaults to the interchange time (ISA-10).

responsibleAgencyCode?​

readonly optional responsibleAgencyCode?: string

GS-07 - responsible agency code. Defaults to "X" (ASC X12).

transactions​

readonly transactions: readonly TransactionSetSpec[]

The ordered ST..SE transaction sets inside this group.

versionRelease​

readonly versionRelease: string

GS-08 - version / release / industry identifier code (e.g. "005010X222A2").