X12

Connect to X12 API to perform encode and decode actions.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions and Integration Service Environments (ISEs)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
Integration Account ID string

Integration Account ID

Integration Account SAS URL securestring

Integration Account SAS URL

Size of Control Numbers block int

Specifies the block size of control numbers to be reserved from an agreement. This is intended for high throughput scenarios

Throttling Limits

Name Calls Renewal Period
API calls per connection180060 seconds

Actions

Add or update control numbers

Add or update control numbers

Batch encode by agreement name

Batch encode by agreement name

Batch encode X12 messages using identities

Batch encode X12 messages using identities

Decode X12 message

Decode X12 message

Encode to X12 message by agreement name

Encode to X12 message by agreement name

Encode to X12 message by agreement name (V2)

Encode XML interchange to X12 interchange by agreement name. The interchange can have one or more transaction sets.

Encode to X12 message by identities

Encode to X12 message by identities

Encode to X12 message by identities (V2)

Encode XML interchange to X12 interchange by identities. The interchange can have one or more transaction sets.

Resolve X12 agreement

Resolve X12 agreement

Add or update control numbers

Add or update control numbers

Parameters

Name Key Required Type Description
Agreement Name
AgreementName string

Add or update control numbers

Control Number Type
ControlNumberType string

Add or update control numbers

Control Number
ControlNumber string

Add or update control numbers

Control Number Changed Time
ControlNumberChangedTime date-time

Add or update control numbers

Message Direction
MessageDirection string

Add or update control numbers

Is Acknowledgement
IsAcknowledgement boolean

Add or update control numbers

Is Message Processing Failed
IsMessageProcessingFailed boolean

Add or update control numbers

Returns

Batch encode by agreement name

Batch encode by agreement name

Parameters

Name Key Required Type Description
Name of X12 agreement
agreementName True string

The agreement name.

BatchName
BatchName string

The agreement name.

PartitionName
PartitionName string

The agreement name.

MessageId
MessageId string

The agreement name.

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Replacement character
replacementCharacter integer

Replacement character - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

Returns

Batch encode X12 messages using identities

Batch encode X12 messages using identities

Parameters

Name Key Required Type Description
Sender identifier
senderIdentifier True string

The sender identifier.

Sender qualifier
senderQualifier True string

The sender qualifier.

Receiver identifier
receiverIdentifier True string

The receiver identifier.

Receiver qualifier
receiverQualifier True string

The receiver qualifier.

BatchName
BatchName string

The sender identifier.

PartitionName
PartitionName string

The sender identifier.

MessageId
MessageId string

The sender identifier.

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Replacement character
replacementCharacter integer

Replacement character - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

Returns

Decode X12 message

Decode X12 message

Parameters

Name Key Required Type Description
Preserve Interchange
preserveInterchange boolean

Preserve interchange - Overrides agreement setting.

Suspend Interchange On Error
suspendInterchangeOnError boolean

Suspend interchange on error - Overrides agreement setting.

X12 flat file message to decode
body True binary

X12 flat file message to decode

Returns

Encode to X12 message by agreement name

Encode to X12 message by agreement name

Parameters

Name Key Required Type Description
Name of X12 agreement
agreementName True string

Name of X12 agreement.

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Replacement character
replacementCharacter integer

Replacement character - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

XML message to encode
body True binary

XML message to encode

Control Version Number (ISA12)
ISA12 string

Provide a value to override the control version number (ISA12).

Application Sender Identifier/Code GS02
GS02 string

Provide a value to override the application sender identifier/code (GS02).

Application Receiver Identifier/Code GS03
GS03 string

Provide a value to override the application receiver identifier/code (GS03).

Returns

Encode to X12 message by agreement name (V2)

Encode XML interchange to X12 interchange by agreement name. The interchange can have one or more transaction sets.

Parameters

Name Key Required Type Description
Name of X12 agreement
agreementName True string

Name of X12 agreement

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Replacement character
replacementCharacter integer

Replacement character - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

XML message to encode
body True binary

XML message to encode

Application Sender Identifier/Code GS02
GS02 string

Provide a value to override the application sender identifier/code (GS02).

Application Receiver Identifier/Code GS03
GS03 string

Provide a value to override the application receiver identifier/code (GS03).

Returns

Encode to X12 message by identities

Encode to X12 message by identities

Parameters

Name Key Required Type Description
Sender identifier
senderIdentifier True string

Sender identifier

Sender qualifier
senderQualifier True string

Sender qualifier

Receiver identifier
receiverIdentifier True string

Receiver identifier

Receiver qualifier
receiverQualifier True string

Receiver qualifier

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Replacement character
replacementCharacter integer

Replacement character - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

XML message to encode
body True binary

XML message to encode

Application Sender Identifier/Code GS02
GS02 string

Provide a value to override the application sender identifier/code (GS02).

Application Receiver Identifier/Code GS03
GS03 string

Provide a value to override the application receiver identifier/code (GS03).

Returns

Encode to X12 message by identities (V2)

Encode XML interchange to X12 interchange by identities. The interchange can have one or more transaction sets.

Parameters

Name Key Required Type Description
Sender identifier
senderIdentifier True string

Sender identifier

Sender qualifier
senderQualifier True string

Sender qualifier

Receiver identifier
receiverIdentifier True string

Receiver identifier

Receiver qualifier
receiverQualifier True string

Receiver qualifier

Data element separator
dataElementSeparator integer

Data element separator - Overrides agreement setting.

Component separator
componentSeparator integer

Component separator - Overrides agreement setting.

Replacement character
replacementCharacter integer

Replacement character - Overrides agreement setting.

Segment terminator
segmentTerminator integer

Segment terminator - Overrides agreement setting.

Segment terminator suffix
segmentTerminatorSuffix string

Segment terminator suffix - Overrides agreement setting.

XML message to encode
body True binary

XML message to encode

Application Sender Identifier/Code GS02
GS02 string

Provide a value to override the application sender identifier/code (GS02).

Application Receiver Identifier/Code GS03
GS03 string

Provide a value to override the application receiver identifier/code (GS03).

Returns

Resolve X12 agreement

Resolve X12 agreement

Parameters

Name Key Required Type Description
X12 flat file message
body True binary

X12 flat file message

Returns

Triggers

When a control number is modified

When a control number is modified

When a control number is modified

When a control number is modified

Parameters

Name Key Required Type Description
DateTime to start control number sync
startSyncTime date-time

Initial date time to poll for changes.

Returns

Definitions

ReplicableControlNumberContent

Name Path Type Description
Agreement Name
AgreementName string
Control Number Type
ControlNumberType string
Control Number
ControlNumber string
Control Number Changed Time
ControlNumberChangedTime date-time
Message Direction
MessageDirection string
Is Acknowledgement
IsAcknowledgement boolean
Is Message Processing Failed
IsMessageProcessingFailed boolean

UpdateControlNumberResult

Name Path Type Description
Status of the update control number action
UpdateControlNumberStatus string
OldControlNumberContent
OldControlNumberContent ControlNumberContent
ErrorDetails
ErrorDetails ErrorResponseBody

ControlNumberContent

Name Path Type Description
ControlNumber
ControlNumber string
ControlNumberChangedTime
ControlNumberChangedTime date-time

ErrorResponseBody

Name Path Type Description
StatusCode
StatusCode string
ErrorMessage
ErrorMessage string
source
source string
errors
errors array of string

EdiDecodeResponse[X12DecodeResponse,X12AcknowledgementResponse]

Name Path Type Description
InterchangeControlNumber
InterchangeControlNumber string
GroupControlNumbers
GroupControlNumbers array of string
GoodMessages
GoodMessages array of X12DecodeResponse
BadMessages
BadMessages array of X12DecodeResponse
GeneratedAcks
GeneratedAcks array of X12AcknowledgementResponse
ReceivedAcks
ReceivedAcks array of X12AcknowledgementResponse
AgreementName
AgreementName string
GuestPartnerName
GuestPartnerName string
HostPartnerName
HostPartnerName string
ReceiverIdentifier
ReceiverIdentifier string
ReceiverQualifier
ReceiverQualifier string
SenderIdentifier
SenderIdentifier string
SenderQualifier
SenderQualifier string

X12DecodeResponse

Name Path Type Description
InterchangeEnvelope
InterchangeEnvelope InterchangeEnvelope
FunctionalGroupEnvelope
FunctionalGroupEnvelope X12FunctionalGroupEnvelope
TransactionSet
TransactionSet TransactionSet
TechnicalAckExpected
TechnicalAckExpected boolean
FunctionalAckExpected
FunctionalAckExpected boolean
Exception
Exception string
ComponentSeparator
ComponentSeparator integer
DataElementSeparator
DataElementSeparator integer
GroupControlNumber
GroupControlNumber string
InterchangeControlNumber
InterchangeControlNumber string
MessageType
MessageType string
Payload
Payload string
ReplacementCharacter
ReplacementCharacter integer
SegmentTerminator
SegmentTerminator integer
SegmentTerminatorSuffix
SegmentTerminatorSuffix string
TransactionSetControlNumber
TransactionSetControlNumber string
AgreementName
AgreementName string
GuestPartnerName
GuestPartnerName string
HostPartnerName
HostPartnerName string
ReceiverIdentifier
ReceiverIdentifier string
ReceiverQualifier
ReceiverQualifier string
SenderIdentifier
SenderIdentifier string
SenderQualifier
SenderQualifier string

X12AcknowledgementResponse

Name Path Type Description
FunctionalAcknowledgement
FunctionalAcknowledgement X12FunctionalAcknowledgement
TechnicalAcknowledgement
TechnicalAcknowledgement X12TechnicalAcknowledgement
AckPayload
AckPayload string
IsFunctionalAck
IsFunctionalAck boolean
IsTechnicalAck
IsTechnicalAck boolean
TechnicalAckExpected
TechnicalAckExpected boolean
FunctionalAckExpected
FunctionalAckExpected boolean
MessageType
MessageType string

InterchangeEnvelope

Name Path Type Description
ISA_Segment
ISA_Segment string
ISA05
ISA05 string
ISA06
ISA06 string
ISA07
ISA07 string
ISA08
ISA08 string
ISA09
ISA09 string
ISA10
ISA10 string
ISA11
ISA11 string
ISA12
ISA12 string
ISA13
ISA13 string
ISA14
ISA14 string
ISA15
ISA15 string
IEA01
IEA01 string
IEA02
IEA02 string

X12FunctionalGroupEnvelope

Name Path Type Description
GS_Segment
GS_Segment string
GS01
GS01 string
GS02
GS02 string
GS03
GS03 string
GS04
GS04 string
GS05
GS05 string
GS06
GS06 string
GS07
GS07 string
GS08
GS08 string
GE01
GE01 string
GE02
GE02 string

TransactionSet

Name Path Type Description
ST01
ST01 string
ST02
ST02 string
ST03
ST03 string
SE01
SE01 string
SE02
SE02 string
SE03
SE03 string

X12FunctionalAcknowledgement

Name Path Type Description
Header
Header AK1FunctionalGroupResponseHeader
AK2Loop
AK2Loop array of AK2Loop
Trailer
Trailer AK9FunctionalGroupResponseTrailer

X12TechnicalAcknowledgement

Name Path Type Description
TA101
TA101 string
TA102
TA102 string
TA103
TA103 string
TA104
TA104 string
TA105
TA105 string

AK1FunctionalGroupResponseHeader

Name Path Type Description
AK101
AK101 string
AK102
AK102 string

AK2Loop

Name Path Type Description
AK201
AK201 string
AK202
AK202 string
AK203
AK203 string
AK3Loop
AK3Loop array of DataSegmentNote
AK501
AK501 string
AK502
AK502 string
AK503
AK503 string
AK504
AK504 string
AK505
AK505 string
AK506
AK506 string

AK9FunctionalGroupResponseTrailer

Name Path Type Description
AK901
AK901 string
AK902
AK902 string
AK903
AK903 string
AK904
AK904 string
AK905
AK905 string
AK906
AK906 string
AK907
AK907 string
AK908
AK908 string
AK909
AK909 string

DataSegmentNote

Name Path Type Description
AK301
AK301 string
AK302
AK302 string
AK303
AK303 string
AK304
AK304 string
AK4DataElementNote
AK4DataElementNote array of DataElementNote

DataElementNote

Name Path Type Description
AK401
AK401 CompositeDataElement
AK402
AK402 string
AK403
AK403 string
AK404
AK404 string

CompositeDataElement

Name Path Type Description
AK41.1
AK41.1 string
AK41.2
AK41.2 string
AK41.3
AK41.3 string

EdiAgreementProperties

Name Path Type Description
AgreementName
AgreementName string
GuestPartnerName
GuestPartnerName string
HostPartnerName
HostPartnerName string
ReceiverIdentifier
ReceiverIdentifier string
ReceiverQualifier
ReceiverQualifier string
SenderIdentifier
SenderIdentifier string
SenderQualifier
SenderQualifier string

Object

X12BatchEncodeResponse

Name Path Type Description
Interchange
Interchange InterchangeBatchEnvelope
BatchName
BatchName string
PartitionName
PartitionName string
Content
Content Object
BadMessages
BadMessages array of BatchItemError
AgreementProperties
AgreementProperties EdiAgreementProperties
Delimiters
Delimiters Delimiters

InterchangeBatchEnvelope

Name Path Type Description
InterchangeControlNumber
InterchangeControlNumber string
FunctionalGroups
FunctionalGroups array of X12FunctionalGroupBatchEnvelope
ISA_Segment
ISA_Segment string
ISA05
ISA05 string
ISA06
ISA06 string
ISA07
ISA07 string
ISA08
ISA08 string
ISA09
ISA09 string
ISA10
ISA10 string
ISA11
ISA11 string
ISA12
ISA12 string
ISA13
ISA13 string
ISA14
ISA14 string
ISA15
ISA15 string
IEA01
IEA01 string
IEA02
IEA02 string

BatchItemError

Name Path Type Description
MessageId
MessageId string
Error
Error string

Delimiters

Name Path Type Description
ComponentSeparator
ComponentSeparator integer
DataElementSeparator
DataElementSeparator integer
ReplacementCharacter
ReplacementCharacter integer
ReleaseIndicator
ReleaseIndicator integer
RepetitionSeparator
RepetitionSeparator integer
SegmentTerminator
SegmentTerminator integer
SegmentTerminatorSuffix
SegmentTerminatorSuffix string
DecimalIndicator
DecimalIndicator integer

X12FunctionalGroupBatchEnvelope

Name Path Type Description
GroupControlNumber
GroupControlNumber string
TransactionSets
TransactionSets array of TransactionSetBatchEnvelope
GS_Segment
GS_Segment string
GS01
GS01 string
GS02
GS02 string
GS03
GS03 string
GS04
GS04 string
GS05
GS05 string
GS06
GS06 string
GS07
GS07 string
GS08
GS08 string
GE01
GE01 string
GE02
GE02 string

TransactionSetBatchEnvelope

Name Path Type Description
TransactionSetControlNumber
TransactionSetControlNumber string
MessageId
MessageId string
ST01
ST01 string
ST02
ST02 string
ST03
ST03 string
SE01
SE01 string
SE02
SE02 string
SE03
SE03 string

EdiEncodeResponse

Name Path Type Description
IsFunctionalAck
IsFunctionalAck boolean
IsTechnicalAck
IsTechnicalAck boolean
TechnicalAckExpected
TechnicalAckExpected boolean
FunctionalAckExpected
FunctionalAckExpected boolean
ComponentSeparator
ComponentSeparator integer
DataElementSeparator
DataElementSeparator integer
GroupControlNumber
GroupControlNumber string
InterchangeControlNumber
InterchangeControlNumber string
MessageType
MessageType string
Payload
Payload string
ReplacementCharacter
ReplacementCharacter integer
SegmentTerminator
SegmentTerminator integer
SegmentTerminatorSuffix
SegmentTerminatorSuffix string
TransactionSetControlNumber
TransactionSetControlNumber string
AgreementName
AgreementName string
GuestPartnerName
GuestPartnerName string
HostPartnerName
HostPartnerName string
ReceiverIdentifier
ReceiverIdentifier string
ReceiverQualifier
ReceiverQualifier string
SenderIdentifier
SenderIdentifier string
SenderQualifier
SenderQualifier string

X12EncodeV2Response

Name Path Type Description
Interchange
Interchange InterchangeBatchEnvelope
Content
Content Object
AgreementProperties
AgreementProperties EdiAgreementProperties
Delimiters
Delimiters Delimiters