Control Segments

The converter does not parse control segments by default. To enable parsing of control segments, set the convertControlSegments parameter to true when using the API or the AWS Lambda. For CLI, use the --out-control-segments flag.

You can also set the EDI_CONVERT_CONTROL_SEGMENTS environment variable to true to make the control segment parsing the default.

Interchange Control (ISA)

Segment: ISA Open API SchemaSince: 2.15.0
NameDescriptionTypeEDI Reference

id

Unique object identifier assigned by the converter

String

objectType

Type of this object, always set to 'INTERCHANGE_CONTROL'

String

elementSeparator

Element separator character

Default: '*'

String

Required

segmentTerminator

Segment terminator character

Default: '~'

String

Required

authorizationInformationQualifier

Authorization information qualifier

Default: '00'

String

Required

ISA01

authorizationInformation

Authorization information

Default: ' '

String

Required

ISA02

securityInformationQualifier

Security information qualifier

Default: '00'

String

Required

ISA03

securityInformation

Security information

Default: ' '

String

Required

ISA04

senderIdQualifier

Sender id qualifier

String

Required

ISA05

senderId

Sender id

String

Required

ISA06

receiverIdQualifier

Receiver id qualifier

String

Required

ISA07

receiverId

Receiver id

String

Required

ISA08

interchangeDate

Interchange date

Date

Required

ISA09

interchangeTime

Interchange time

Time

Required

ISA10

repetitionSeparator

Repetition separator

Default: '^'

String

Required

ISA11

interchangeControlVersionNumber

Interchange control version number

Default: '00501'

String

Required

ISA12

controlNumber

Control number

Default: 'Unique random number'

Integer

Required

ISA13

acknowledgmentRequested

Acknowledgment requested

Default: '0'

String

Required

ISA14

interchangeUsageIndicator

Interchange usage indicator

Default: 'T'

String

Required

ISA15

componentElementSeparator

Component element separator

Default: ':'

String

Required

ISA16

Functional Group (GS)

Segment: GS Open API SchemaSince: 2.15.0
NameDescriptionTypeEDI Reference

id

Unique object identifier assigned by the converter

String

objectType

Type of this object, always set to 'FUNCTIONAL_GROUP'

String

transactionType

Transaction type as enum for the EDI generator; if not provided, GS01, GS08 must be populated. Not populated by the converter

Values:

PROF, INST, PAYMENT

String

functionalIdentifierCode

Functional identifier code

String

Required

GS01

senderCode

Sender code

String

Required

GS02

receiverCode

Receiver code

String

Required

GS03

date

Date

Default: 'Today's date'

Date

Required

GS04

time

Time

Default: 'Current time'

Time

Required

GS05

controlNumber

Control number

Default: 'Unique random number'

Integer

Required

GS06

responsibleAgencyCode

Responsible agency code

Default: 'X'

String

Required

GS07

version

Version

String

Required

GS08