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) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | https://support.microsoft.com/ |
| abapi@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://docs.microsoft.com/en-us/azure/logic-apps/logic-apps-enterprise-integration-x12 |
| Privacy policy | https://privacy.microsoft.com/ |
| Categories | IT Operations;Commerce |
Connector in-depth
For more information about the connector, see the in-depth section.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Integration Account ID | string | Integration Account ID | True |
| Integration Account SAS URL | securestring | Integration Account SAS URL | True |
| 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 connection | 1800 | 60 seconds |
Actions
| Add or update control numbers |
Add or update control numbers |
| Batch encode by agreement name (Preview) |
Batch encode by agreement name |
| Batch encode X12 messages using identities (Preview) |
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) (Preview) |
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) (Preview) |
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 |
Agreement name |
|
|
Control Number Type
|
ControlNumberType | string |
Type of control number (ICN/TSCN/GCN) associated with entry |
|
|
Control Number
|
ControlNumber | string |
Control number |
|
|
Control Number Changed Time
|
ControlNumberChangedTime | date-time |
Message received time |
|
|
Message Direction
|
MessageDirection | string |
Message direction |
|
|
Is Acknowledgement
|
IsAcknowledgement | boolean |
Message is an acknowledgement message |
|
|
Is Message Processing Failed
|
IsMessageProcessingFailed | boolean |
Whether received message processing failed |
Returns
- response
- array of UpdateControlNumberResult
Batch encode by agreement name (Preview)
Batch encode by agreement name
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name of X12 agreement
|
agreementName | True | string |
The agreement name. |
|
BatchName
|
BatchName | string |
Batch name |
|
|
PartitionName
|
PartitionName | string |
Batch partition name |
|
|
MessageId
|
MessageId | string |
Unique id of the batch item |
|
|
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
X12 batch encode response
Batch encode X12 messages using identities (Preview)
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 |
Batch name |
|
|
PartitionName
|
PartitionName | string |
Batch partition name |
|
|
MessageId
|
MessageId | string |
Unique id of the batch item |
|
|
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
X12 batch encode response
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
EDI decode response
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
EDI Encode response
- Body
- EdiEncodeResponse
Encode to X12 message by agreement name (V2) (Preview)
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
X12 encode V2 response
- Body
- X12EncodeV2Response
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
EDI Encode response
- Body
- EdiEncodeResponse
Encode to X12 message by identities (V2) (Preview)
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
X12 encode V2 response
- Body
- X12EncodeV2Response
Resolve X12 agreement
Resolve X12 agreement
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
X12 flat file message
|
body | True | binary |
X12 flat file message |
Returns
EDI agreement properties
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
Replicable control number content
| Name | Path | Type | Description |
|---|---|---|---|
|
Agreement Name
|
AgreementName | string |
Agreement name |
|
Control Number Type
|
ControlNumberType | string |
Type of control number (ICN/TSCN/GCN) associated with entry |
|
Control Number
|
ControlNumber | string |
Control number |
|
Control Number Changed Time
|
ControlNumberChangedTime | date-time |
Message received time |
|
Message Direction
|
MessageDirection | string |
Message direction |
|
Is Acknowledgement
|
IsAcknowledgement | boolean |
Message is an acknowledgement message |
|
Is Message Processing Failed
|
IsMessageProcessingFailed | boolean |
Whether received message processing failed |
UpdateControlNumberResult
| Name | Path | Type | Description |
|---|---|---|---|
|
Status of the update control number action
|
UpdateControlNumberStatus | string | |
|
OldControlNumberContent
|
OldControlNumberContent | ControlNumberContent | |
|
ErrorDetails
|
ErrorDetails | EipErrorResponseBody |
Error Response Body |
ControlNumberContent
| Name | Path | Type | Description |
|---|---|---|---|
|
ControlNumber
|
ControlNumber | string | |
|
ControlNumberChangedTime
|
ControlNumberChangedTime | date-time |
EipErrorResponseBody
Error Response Body
| Name | Path | Type | Description |
|---|---|---|---|
|
StatusCode
|
StatusCode | string |
HTTP Status code of the response |
|
ErrorMessage
|
ErrorMessage | string |
Error Message |
|
source
|
source | string |
Source of the error |
|
errors
|
errors | array of string |
Errors provided by the source |
EdiDecodeResponse[X12DecodeResponse,X12AcknowledgementResponse]
EDI decode response
| Name | Path | Type | Description |
|---|---|---|---|
|
InterchangeControlNumber
|
InterchangeControlNumber | string |
Interchange Control Number |
|
GroupControlNumbers
|
GroupControlNumbers | array of string |
Group Control Numbers occurring in interchange |
|
GoodMessages
|
GoodMessages | array of X12DecodeResponse |
Good messages |
|
BadMessages
|
BadMessages | array of X12DecodeResponse |
Bad messages |
|
GeneratedAcks
|
GeneratedAcks | array of X12AcknowledgementResponse |
Generated Acknowledgements |
|
ReceivedAcks
|
ReceivedAcks | array of X12AcknowledgementResponse |
Incoming Acknowledgements |
|
AgreementName
|
AgreementName | string |
Agreement Name |
|
GuestPartnerName
|
GuestPartnerName | string |
Guest Partner Name |
|
HostPartnerName
|
HostPartnerName | string |
Host Partner Name |
|
ReceiverIdentifier
|
ReceiverIdentifier | string |
Receiver Identity |
|
ReceiverQualifier
|
ReceiverQualifier | string |
Receiver Qualifier |
|
SenderIdentifier
|
SenderIdentifier | string |
Sender Identity |
|
SenderQualifier
|
SenderQualifier | string |
Sender Qualifier |
X12DecodeResponse
X12 decode response
| Name | Path | Type | Description |
|---|---|---|---|
|
InterchangeEnvelope
|
InterchangeEnvelope | InterchangeEnvelope |
Interchange envelope |
|
FunctionalGroupEnvelope
|
FunctionalGroupEnvelope | X12FunctionalGroupEnvelope |
Functional group envelope |
|
TransactionSet
|
TransactionSet | TransactionSet |
EDI transaction set |
|
TechnicalAckExpected
|
TechnicalAckExpected | boolean |
Whether technical acknowledgement is required or not |
|
FunctionalAckExpected
|
FunctionalAckExpected | boolean |
Whether functional acknowledgement is required or not |
|
Exception
|
Exception | string |
Exception |
|
ComponentSeparator
|
ComponentSeparator | integer |
Component Separator |
|
DataElementSeparator
|
DataElementSeparator | integer |
Data Element Separator |
|
GroupControlNumber
|
GroupControlNumber | string |
Group Control Number |
|
InterchangeControlNumber
|
InterchangeControlNumber | string |
Interchange Control Number |
|
MessageType
|
MessageType | string |
Message Type |
|
Payload
|
Payload | string |
Payload |
|
ReplacementCharacter
|
ReplacementCharacter | integer |
Replacement Character |
|
SegmentTerminator
|
SegmentTerminator | integer |
Segment Terminator |
|
SegmentTerminatorSuffix
|
SegmentTerminatorSuffix | string |
Segment Terminator Suffix |
|
TransactionSetControlNumber
|
TransactionSetControlNumber | string |
Transaction Set Control Number |
|
AgreementName
|
AgreementName | string |
Agreement Name |
|
GuestPartnerName
|
GuestPartnerName | string |
Guest Partner Name |
|
HostPartnerName
|
HostPartnerName | string |
Host Partner Name |
|
ReceiverIdentifier
|
ReceiverIdentifier | string |
Receiver Identity |
|
ReceiverQualifier
|
ReceiverQualifier | string |
Receiver Qualifier |
|
SenderIdentifier
|
SenderIdentifier | string |
Sender Identity |
|
SenderQualifier
|
SenderQualifier | string |
Sender Qualifier |
X12AcknowledgementResponse
X12 Acknowledgements
| Name | Path | Type | Description |
|---|---|---|---|
|
FunctionalAcknowledgement
|
FunctionalAcknowledgement | X12FunctionalAcknowledgement |
Functional Acknowledgement |
|
TechnicalAcknowledgement
|
TechnicalAcknowledgement | X12TechnicalAcknowledgement |
EDI Technical Acknowledgement |
|
AckPayload
|
AckPayload | string |
Acknowledgement payload |
|
IsFunctionalAck
|
IsFunctionalAck | boolean |
Is Functional Acknowledgement |
|
IsTechnicalAck
|
IsTechnicalAck | boolean |
Is Technical Acknowledgement |
|
TechnicalAckExpected
|
TechnicalAckExpected | boolean |
Whether technical acknowledgement is expected or not |
|
FunctionalAckExpected
|
FunctionalAckExpected | boolean |
Whether functional acknowledgement is expected or not |
|
MessageType
|
MessageType | string |
Message Type |
InterchangeEnvelope
Interchange envelope
| Name | Path | Type | Description |
|---|---|---|---|
|
ISA_Segment
|
ISA_Segment | string |
ISA Segment |
|
ISA05
|
ISA05 | string |
ISA05 |
|
ISA06
|
ISA06 | string |
ISA06 |
|
ISA07
|
ISA07 | string |
ISA07 |
|
ISA08
|
ISA08 | string |
ISA08 |
|
ISA09
|
ISA09 | string |
ISA09 |
|
ISA10
|
ISA10 | string |
ISA10 |
|
ISA11
|
ISA11 | string |
ISA11 |
|
ISA12
|
ISA12 | string |
ISA12 |
|
ISA13
|
ISA13 | string |
ISA13 |
|
ISA14
|
ISA14 | string |
ISA14 |
|
ISA15
|
ISA15 | string |
ISA15 |
|
IEA01
|
IEA01 | string |
IEA01 |
|
IEA02
|
IEA02 | string |
IEA02 |
X12FunctionalGroupEnvelope
Functional group envelope
| Name | Path | Type | Description |
|---|---|---|---|
|
GS_Segment
|
GS_Segment | string |
GS Segment |
|
GS01
|
GS01 | string |
GS01 |
|
GS02
|
GS02 | string |
GS02 |
|
GS03
|
GS03 | string |
GS03 |
|
GS04
|
GS04 | string |
GS04 |
|
GS05
|
GS05 | string |
GS05 |
|
GS06
|
GS06 | string |
GS06 |
|
GS07
|
GS07 | string |
GS07 |
|
GS08
|
GS08 | string |
GS08 |
|
GE01
|
GE01 | string |
GE01 |
|
GE02
|
GE02 | string |
GE02 |
TransactionSet
EDI transaction set
| Name | Path | Type | Description |
|---|---|---|---|
|
ST01
|
ST01 | string |
ST01 |
|
ST02
|
ST02 | string |
ST02 |
|
ST03
|
ST03 | string |
ST03 |
|
SE01
|
SE01 | string |
SE01 |
|
SE02
|
SE02 | string |
SE02 |
|
SE03
|
SE03 | string |
SE03 |
X12FunctionalAcknowledgement
Functional Acknowledgement
| Name | Path | Type | Description |
|---|---|---|---|
|
Header
|
Header | AK1FunctionalGroupResponseHeader |
Functional Group Header |
|
AK2Loop
|
AK2Loop | array of AK2Loop |
AK2Loop |
|
Trailer
|
Trailer | AK9FunctionalGroupResponseTrailer |
AK9 functional group trailer |
X12TechnicalAcknowledgement
EDI Technical Acknowledgement
| Name | Path | Type | Description |
|---|---|---|---|
|
TA101
|
TA101 | string |
TA101 |
|
TA102
|
TA102 | string |
TA102 |
|
TA103
|
TA103 | string |
TA103 |
|
TA104
|
TA104 | string |
TA104 |
|
TA105
|
TA105 | string |
TA105 |
AK1FunctionalGroupResponseHeader
Functional Group Header
| Name | Path | Type | Description |
|---|---|---|---|
|
AK101
|
AK101 | string |
AK101 |
|
AK102
|
AK102 | string |
AK102 |
AK2Loop
AK2Loop Transaction Set Response Header
| Name | Path | Type | Description |
|---|---|---|---|
|
AK201
|
AK201 | string |
AK201 |
|
AK202
|
AK202 | string |
AK202 |
|
AK203
|
AK203 | string |
AK203 |
|
AK3Loop
|
AK3Loop | array of DataSegmentNote |
AK3Loop Data Segments |
|
AK501
|
AK501 | string |
AK501 |
|
AK502
|
AK502 | string |
AK502 |
|
AK503
|
AK503 | string |
AK503 |
|
AK504
|
AK504 | string |
AK504 |
|
AK505
|
AK505 | string |
AK505 |
|
AK506
|
AK506 | string |
AK506 |
AK9FunctionalGroupResponseTrailer
AK9 functional group trailer
| Name | Path | Type | Description |
|---|---|---|---|
|
AK901
|
AK901 | string |
AK901 |
|
AK902
|
AK902 | string |
AK902 |
|
AK903
|
AK903 | string |
AK903 |
|
AK904
|
AK904 | string |
AK904 |
|
AK905
|
AK905 | string |
AK905 |
|
AK906
|
AK906 | string |
AK906 |
|
AK907
|
AK907 | string |
AK907 |
|
AK908
|
AK908 | string |
AK908 |
|
AK909
|
AK909 | string |
AK909 |
DataSegmentNote
Data Segments used in EDI acknowledgement
| Name | Path | Type | Description |
|---|---|---|---|
|
AK301
|
AK301 | string |
AK301 |
|
AK302
|
AK302 | string |
AK302 |
|
AK303
|
AK303 | string |
AK303 |
|
AK304
|
AK304 | string |
AK304 |
|
AK4DataElementNote
|
AK4DataElementNote | array of DataElementNote |
AK4 segment |
DataElementNote
Data Elements in EDI acknowledgement
| Name | Path | Type | Description |
|---|---|---|---|
|
AK401
|
AK401 | CompositeDataElement |
AK401 composite data element |
|
AK402
|
AK402 | string |
AK402 |
|
AK403
|
AK403 | string |
AK403 |
|
AK404
|
AK404 | string |
AK404 |
CompositeDataElement
AK401 composite data element
| Name | Path | Type | Description |
|---|---|---|---|
|
AK41.1
|
AK41.1 | string |
CompositeProperty1 which represents AK41.1 of X12 acknowledgements |
|
AK41.2
|
AK41.2 | string |
CompositeProperty2 which represents AK41.2 of X12 acknowledgements |
|
AK41.3
|
AK41.3 | string |
CompositeProperty3 which represents AK41.3 of X12 acknowledgements |
EdiAgreementProperties
EDI agreement properties
| Name | Path | Type | Description |
|---|---|---|---|
|
AgreementName
|
AgreementName | string |
Agreement Name |
|
GuestPartnerName
|
GuestPartnerName | string |
Guest Partner Name |
|
HostPartnerName
|
HostPartnerName | string |
Host Partner Name |
|
ReceiverIdentifier
|
ReceiverIdentifier | string |
Receiver Identity |
|
ReceiverQualifier
|
ReceiverQualifier | string |
Receiver Qualifier |
|
SenderIdentifier
|
SenderIdentifier | string |
Sender Identity |
|
SenderQualifier
|
SenderQualifier | string |
Sender Qualifier |
Object
X12BatchEncodeResponse
X12 batch encode response
| Name | Path | Type | Description |
|---|---|---|---|
|
Interchange
|
Interchange | InterchangeBatchEnvelope |
Interchange batch envelope |
|
BatchName
|
BatchName | string |
Batch name |
|
PartitionName
|
PartitionName | string |
Partition name |
|
Content
|
Content | Object | |
|
BadMessages
|
BadMessages | array of BatchItemError |
Bad messages |
|
AgreementProperties
|
AgreementProperties | EdiAgreementProperties |
EDI agreement properties |
|
Delimiters
|
Delimiters | Delimiters |
Delimiters associated with an EDI message |
InterchangeBatchEnvelope
Interchange batch envelope
| Name | Path | Type | Description |
|---|---|---|---|
|
InterchangeControlNumber
|
InterchangeControlNumber | string |
Interchange control number |
|
FunctionalGroups
|
FunctionalGroups | array of X12FunctionalGroupBatchEnvelope |
Functional groups in the interchange |
|
ISA_Segment
|
ISA_Segment | string |
ISA Segment |
|
ISA05
|
ISA05 | string |
ISA05 |
|
ISA06
|
ISA06 | string |
ISA06 |
|
ISA07
|
ISA07 | string |
ISA07 |
|
ISA08
|
ISA08 | string |
ISA08 |
|
ISA09
|
ISA09 | string |
ISA09 |
|
ISA10
|
ISA10 | string |
ISA10 |
|
ISA11
|
ISA11 | string |
ISA11 |
|
ISA12
|
ISA12 | string |
ISA12 |
|
ISA13
|
ISA13 | string |
ISA13 |
|
ISA14
|
ISA14 | string |
ISA14 |
|
ISA15
|
ISA15 | string |
ISA15 |
|
IEA01
|
IEA01 | string |
IEA01 |
|
IEA02
|
IEA02 | string |
IEA02 |
BatchItemError
Error response for a bad batch message
| Name | Path | Type | Description |
|---|---|---|---|
|
MessageId
|
MessageId | string |
Bad message id |
|
Error
|
Error | string |
Error |
Delimiters
Delimiters associated with an EDI message
| Name | Path | Type | Description |
|---|---|---|---|
|
ComponentSeparator
|
ComponentSeparator | integer |
Component separator |
|
DataElementSeparator
|
DataElementSeparator | integer |
Data element separator |
|
ReplacementCharacter
|
ReplacementCharacter | integer |
Replacement character |
|
ReleaseIndicator
|
ReleaseIndicator | integer |
Release indicator |
|
RepetitionSeparator
|
RepetitionSeparator | integer |
Repetition separator |
|
SegmentTerminator
|
SegmentTerminator | integer |
Segment terminator |
|
SegmentTerminatorSuffix
|
SegmentTerminatorSuffix | string |
Segment terminator suffix |
|
DecimalIndicator
|
DecimalIndicator | integer |
Decimal indicator |
X12FunctionalGroupBatchEnvelope
Functional group batch envelope
| Name | Path | Type | Description |
|---|---|---|---|
|
GroupControlNumber
|
GroupControlNumber | string |
Group control number |
|
TransactionSets
|
TransactionSets | array of TransactionSetBatchEnvelope |
Transaction sets |
|
GS_Segment
|
GS_Segment | string |
GS Segment |
|
GS01
|
GS01 | string |
GS01 |
|
GS02
|
GS02 | string |
GS02 |
|
GS03
|
GS03 | string |
GS03 |
|
GS04
|
GS04 | string |
GS04 |
|
GS05
|
GS05 | string |
GS05 |
|
GS06
|
GS06 | string |
GS06 |
|
GS07
|
GS07 | string |
GS07 |
|
GS08
|
GS08 | string |
GS08 |
|
GE01
|
GE01 | string |
GE01 |
|
GE02
|
GE02 | string |
GE02 |
TransactionSetBatchEnvelope
Batch EDI transaction set
| Name | Path | Type | Description |
|---|---|---|---|
|
TransactionSetControlNumber
|
TransactionSetControlNumber | string |
Transaction set control number |
|
MessageId
|
MessageId | string |
Batch message Identifier |
|
ST01
|
ST01 | string |
ST01 |
|
ST02
|
ST02 | string |
ST02 |
|
ST03
|
ST03 | string |
ST03 |
|
SE01
|
SE01 | string |
SE01 |
|
SE02
|
SE02 | string |
SE02 |
|
SE03
|
SE03 | string |
SE03 |
EdiEncodeResponse
EDI Encode response
| Name | Path | Type | Description |
|---|---|---|---|
|
IsFunctionalAck
|
IsFunctionalAck | boolean |
Whether this is a Functional Acknowledgement |
|
IsTechnicalAck
|
IsTechnicalAck | boolean |
Whether this is a Technical Acknowledgement |
|
TechnicalAckExpected
|
TechnicalAckExpected | boolean |
Whether Technical Acknowledgement is expected or not |
|
FunctionalAckExpected
|
FunctionalAckExpected | boolean |
Whether Functional Acknowledgement is expected or not |
|
ComponentSeparator
|
ComponentSeparator | integer |
Component Separator |
|
DataElementSeparator
|
DataElementSeparator | integer |
Data Element Separator |
|
GroupControlNumber
|
GroupControlNumber | string |
Group Control Number |
|
InterchangeControlNumber
|
InterchangeControlNumber | string |
Interchange Control Number |
|
MessageType
|
MessageType | string |
Message Type |
|
Payload
|
Payload | string |
Payload |
|
ReplacementCharacter
|
ReplacementCharacter | integer |
Replacement Character |
|
SegmentTerminator
|
SegmentTerminator | integer |
Segment Terminator |
|
SegmentTerminatorSuffix
|
SegmentTerminatorSuffix | string |
Segment Terminator Suffix |
|
TransactionSetControlNumber
|
TransactionSetControlNumber | string |
Transaction Set Control Number |
|
AgreementName
|
AgreementName | string |
Agreement Name |
|
GuestPartnerName
|
GuestPartnerName | string |
Guest Partner Name |
|
HostPartnerName
|
HostPartnerName | string |
Host Partner Name |
|
ReceiverIdentifier
|
ReceiverIdentifier | string |
Receiver Identity |
|
ReceiverQualifier
|
ReceiverQualifier | string |
Receiver Qualifier |
|
SenderIdentifier
|
SenderIdentifier | string |
Sender Identity |
|
SenderQualifier
|
SenderQualifier | string |
Sender Qualifier |
X12EncodeV2Response
X12 encode V2 response
| Name | Path | Type | Description |
|---|---|---|---|
|
Interchange
|
Interchange | InterchangeBatchEnvelope |
Interchange batch envelope |
|
Content
|
Content | Object | |
|
AgreementProperties
|
AgreementProperties | EdiAgreementProperties |
EDI agreement properties |
|
Delimiters
|
Delimiters | Delimiters |
Delimiters associated with an EDI message |