Edifact
Connect to EDIFACT 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-edifact |
| Privacy policy | https://privacy.microsoft.com/ |
| Categories | IT Operations;Commerce |
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 |
| Decode EDIFACT message |
Decode EDIFACT message |
| Encode to EDIFACT batch message by agreement name (Preview) |
Encode to EDIFACT batch message by agreement name |
| Encode to EDIFACT batch message by identities (Preview) |
Encode to EDIFACT batch message by identities |
| Encode to EDIFACT message by agreement name |
Encode to EDIFACT message by agreement name |
| Encode to EDIFACT message by agreement name (V2) (Preview) |
Encode XML interchange to EDIFACT interchange by agreement name. The interchange can have one or more transaction sets. |
| Encode to EDIFACT message by identities |
Encode to EDIFACT message by identities |
| Encode to EDIFACT message by identities (V2) (Preview) |
Encode XML interchange to EDIFACT interchange by identities. The interchange can have one or more transaction sets. |
| Resolve EDIFACT agreement |
Resolve EDIFACT 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
Decode EDIFACT message
Decode EDIFACT message
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Component separator
|
componentSeparator | integer |
Component separator. |
|
|
Data element separator
|
dataElementSeparator | integer |
Data element separator. |
|
|
Release indicator
|
releaseIndicator | integer |
Release indicator. |
|
|
Repetition separator
|
repetitionSeparator | integer |
Repetition separator. |
|
|
Segment terminator
|
segmentTerminator | integer |
Segment terminator. |
|
|
Segment terminator suffix
|
segmentTerminatorSuffix | string |
Segment terminator suffix. |
|
|
Decimal indicator
|
decimalIndicator | string |
Decimal indicator. |
|
|
Payload character set
|
payloadCharacterSet | string |
Payload character set. |
|
|
Preserve Interchange
|
preserveInterchange | boolean |
Preserve interchange - Overrides agreement setting. |
|
|
Suspend Interchange On Error
|
suspendInterchangeOnError | boolean |
Suspend interchange on error - Overrides agreement setting. |
|
|
EDIFACT flat file message to decode
|
body | True | binary |
EDIFACT flat file message to decode |
Returns
EDI decode response
Encode to EDIFACT batch message by agreement name (Preview)
Encode to EDIFACT batch message by agreement name
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name of EDIFACT 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. |
|
|
Release indicator
|
releaseIndicator | integer |
Release indicator - Overrides agreement setting. |
|
|
Component separator
|
componentSeparator | integer |
Component separator - Overrides agreement setting. |
|
|
Repetition separator
|
repetitionSeparator | integer |
Repetition separator - Overrides agreement setting. |
|
|
Segment terminator
|
segmentTerminator | integer |
Segment terminator - Overrides agreement setting. |
|
|
Segment terminator suffix
|
segmentTerminatorSuffix | string |
Segment terminator suffix - Overrides agreement setting. |
|
|
Decimal indicator
|
decimalIndicator | string |
Decimal indicator - Overrides agreement setting. |
Returns
EDIFACT batch encode response
Encode to EDIFACT batch message by identities (Preview)
Encode to EDIFACT batch message by 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. |
|
|
Release indicator
|
releaseIndicator | integer |
Release indicator - Overrides agreement setting. |
|
|
Component separator
|
componentSeparator | integer |
Component separator - Overrides agreement setting. |
|
|
Repetition separator
|
repetitionSeparator | integer |
Repetition separator - Overrides agreement setting. |
|
|
Segment terminator
|
segmentTerminator | integer |
Segment terminator - Overrides agreement setting. |
|
|
Segment terminator suffix
|
segmentTerminatorSuffix | string |
Segment terminator suffix - Overrides agreement setting. |
|
|
Decimal indicator
|
decimalIndicator | string |
Decimal indicator - Overrides agreement setting. |
Returns
EDIFACT batch encode response
Encode to EDIFACT message by agreement name
Encode to EDIFACT message by agreement name
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name of EDIFACT agreement
|
agreementName | True | string |
Name of EDIFACT agreement |
|
Data element separator
|
dataElementSeparator | integer |
Data element separator - Overrides agreement setting. |
|
|
Release indicator
|
releaseIndicator | integer |
Release indicator - Overrides agreement setting. |
|
|
Component separator
|
componentSeparator | integer |
Component separator - Overrides agreement setting. |
|
|
Repetition separator
|
repetitionSeparator | integer |
Repetition separator - Overrides agreement setting. |
|
|
Segment terminator
|
segmentTerminator | integer |
Segment terminator - Overrides agreement setting. |
|
|
Segment terminator suffix
|
segmentTerminatorSuffix | string |
Segment terminator suffix - Overrides agreement setting. |
|
|
Decimal indicator
|
decimalIndicator | string |
Decimal indicator - Overrides agreement setting. |
|
|
XML message to encode
|
body | True | binary |
XML message to encode |
Returns
Edifact encode response
Encode to EDIFACT message by agreement name (V2) (Preview)
Encode XML interchange to EDIFACT interchange by agreement name. The interchange can have one or more transaction sets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name of EDIFACT agreement
|
agreementName | True | string |
Name of EDIFACT agreement |
|
Data element separator
|
dataElementSeparator | integer |
Data element separator - Overrides agreement setting. |
|
|
Release indicator
|
releaseIndicator | integer |
Release indicator - Overrides agreement setting. |
|
|
Component separator
|
componentSeparator | integer |
Component separator - Overrides agreement setting. |
|
|
Repetition separator
|
repetitionSeparator | integer |
Repetition separator - Overrides agreement setting. |
|
|
Segment terminator
|
segmentTerminator | integer |
Segment terminator - Overrides agreement setting. |
|
|
Segment terminator suffix
|
segmentTerminatorSuffix | string |
Segment terminator suffix - Overrides agreement setting. |
|
|
Decimal indicator
|
decimalIndicator | string |
Decimal indicator - Overrides agreement setting. |
|
|
XML message to encode
|
body | True | binary |
XML message to encode |
Returns
Edifact V2 encode response
Encode to EDIFACT message by identities
Encode to EDIFACT message by identities
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Sender identifier
|
senderIdentifier | True | string |
Sender identifier |
|
Receiver identifier
|
receiverIdentifier | True | string |
Receiver identifier |
|
Sender qualifier
|
senderQualifier | string |
Sender qualifier |
|
|
Receiver qualifier
|
receiverQualifier | string |
Receiver qualifier |
|
|
Data element separator
|
dataElementSeparator | integer |
Data element separator - Overrides agreement setting. |
|
|
Release indicator
|
releaseIndicator | integer |
Release indicator - Overrides agreement setting. |
|
|
Component separator
|
componentSeparator | integer |
Component separator - Overrides agreement setting. |
|
|
Repetition separator
|
repetitionSeparator | integer |
Repetition separator - Overrides agreement setting. |
|
|
Segment terminator
|
segmentTerminator | integer |
Segment terminator - Overrides agreement setting. |
|
|
Segment terminator suffix
|
segmentTerminatorSuffix | string |
Segment terminator suffix - Overrides agreement setting. |
|
|
Decimal indicator
|
decimalIndicator | string |
Decimal indicator - Overrides agreement setting. |
|
|
XML message to encode
|
body | True | binary |
XML message to encode |
Returns
Edifact encode response
Encode to EDIFACT message by identities (V2) (Preview)
Encode XML interchange to EDIFACT 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 |
|
Receiver identifier
|
receiverIdentifier | True | string |
Receiver identifier |
|
Sender qualifier
|
senderQualifier | string |
Sender qualifier |
|
|
Receiver qualifier
|
receiverQualifier | string |
Receiver qualifier |
|
|
Data element separator
|
dataElementSeparator | integer |
Data element separator - Overrides agreement setting. |
|
|
Release indicator
|
releaseIndicator | integer |
Release indicator - Overrides agreement setting. |
|
|
Component separator
|
componentSeparator | integer |
Component separator - Overrides agreement setting. |
|
|
Repetition separator
|
repetitionSeparator | integer |
Repetition separator - Overrides agreement setting. |
|
|
Segment terminator
|
segmentTerminator | integer |
Segment terminator - Overrides agreement setting. |
|
|
Segment terminator suffix
|
segmentTerminatorSuffix | string |
Segment terminator suffix - Overrides agreement setting. |
|
|
Decimal indicator
|
decimalIndicator | string |
Decimal indicator - Overrides agreement setting. |
|
|
XML message to encode
|
body | True | binary |
XML message to encode |
Returns
Edifact V2 encode response
Resolve EDIFACT agreement
Resolve EDIFACT agreement
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Component separator
|
componentSeparator | integer |
Component separator |
|
|
Data element separator
|
dataElementSeparator | integer |
Data element separator |
|
|
Release indicator
|
releaseIndicator | integer |
Release indicator |
|
|
Repetition separator
|
repetitionSeparator | integer |
Repetition separator |
|
|
Segment terminator
|
segmentTerminator | integer |
Segment terminator |
|
|
Segment terminator suffix
|
segmentTerminatorSuffix | string |
Segment terminator suffix |
|
|
Decimal indicator
|
decimalIndicator | string |
Decimal indicator |
|
|
EDIFACT flat file message
|
body | True | binary |
EDIFACT 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 |
|---|---|---|---|---|
|
Initial date time to poll for changes.
|
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[EdifactDecodeResponse,EdifactAcknowledgement]
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 EdifactDecodeResponse |
Good messages |
|
BadMessages
|
BadMessages | array of EdifactDecodeResponse |
Bad messages |
|
GeneratedAcks
|
GeneratedAcks | array of EdifactAcknowledgement |
Generated Acknowledgements |
|
ReceivedAcks
|
ReceivedAcks | array of EdifactAcknowledgement |
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 |
EdifactDecodeResponse
Edifact decode response
| Name | Path | Type | Description |
|---|---|---|---|
|
UNA_Segment
|
UNA_Segment | string |
UNA segment |
|
UNB
|
UNB | EdifactInterchangeHeaders |
EDIFACT Interchange Headers |
|
UNG
|
UNG | EdifactGroupHeaders |
EDIFACT Group Headers |
|
UNH
|
UNH | EdifactMessageHeaders |
EDIFACT Group Segment - Message Headers |
|
DecimalPointIndicator
|
DecimalPointIndicator | integer |
DecimalPointIndicator (Ascii value of the char) |
|
RepetitionSeparator
|
RepetitionSeparator | integer |
RepetitionSeparator (Ascii value of the char) |
|
EscapeCharacter
|
EscapeCharacter | integer |
EscapeCharacter (Ascii value of the char) |
|
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 |
EdifactAcknowledgement
Acknowledgement
| Name | Path | Type | Description |
|---|---|---|---|
|
Acknowledgement
|
Acknowledgement | EdifactFunctionalAcknowledgement |
EDIFACT Functional 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 |
EdifactInterchangeHeaders
EDIFACT Interchange Headers
| Name | Path | Type | Description |
|---|---|---|---|
|
UNB_Segment
|
UNB_Segment | string |
UNBSegment |
|
UNB2.1
|
UNB2.1 | string |
UNB2.1 |
|
UNB2.2
|
UNB2.2 | string |
UNB2.2 |
|
UNB2.3
|
UNB2.3 | string |
UNB2.3 |
|
UNB2.4
|
UNB2.4 | string |
UNB2.4 |
|
UNB3.1
|
UNB3.1 | string |
UNB3.1 |
|
UNB3.2
|
UNB3.2 | string |
UNB3.2 |
|
UNB3.3
|
UNB3.3 | string |
UNB3.3 |
|
UNB3.4
|
UNB3.4 | string |
UNB3.4 |
|
UNB11
|
UNB11 | string |
UNB11 |
EdifactGroupHeaders
EDIFACT Group Headers
| Name | Path | Type | Description |
|---|---|---|---|
|
UNG_Segment
|
UNG_Segment | string |
UNGSegment |
|
UNG1
|
UNG1 | string |
UNG1 |
|
UNG2.1
|
UNG2.1 | string |
UNGTwo1 |
|
UNG2.2
|
UNG2.2 | string |
UNGTwo2 |
|
UNG3.1
|
UNG3.1 | string |
UNGThree1 |
|
UNG3.2
|
UNG3.2 | string |
UNGThree2 |
|
UNG4.1
|
UNG4.1 | string |
UNGFour1 |
|
UNG4.2
|
UNG4.2 | string |
UNGFour2 |
|
UNG5
|
UNG5 | string |
UNG5 |
|
UNG6
|
UNG6 | string |
UNG6 |
|
UNG7.1
|
UNG7.1 | string |
UNGSeven1 |
|
UNG7.2
|
UNG7.2 | string |
UNGSeven2 |
|
UNG7.3
|
UNG7.3 | string |
UNGSeven3 |
EdifactMessageHeaders
EDIFACT Group Segment - Message Headers
| Name | Path | Type | Description |
|---|---|---|---|
|
UNH1
|
UNH1 | string |
UNH1 |
|
UNH2.1
|
UNH2.1 | string |
UNHTwo1 |
|
UNH2.2
|
UNH2.2 | string |
UNHTwo2 |
|
UNH2.3
|
UNH2.3 | string |
UNHTwo3 |
|
UNH2.4
|
UNH2.4 | string |
UNHTwo4 |
|
UNH2.5
|
UNH2.5 | string |
UNHTwo5 |
|
UNH2.6
|
UNH2.6 | string |
UNHTwo6 |
|
UNH2.7
|
UNH2.7 | string |
UNHTwo7 |
EdifactFunctionalAcknowledgement
EDIFACT Functional Acknowledgement
| Name | Path | Type | Description |
|---|---|---|---|
|
SG1Loop
|
SG1Loop | SG1Loop |
SG1Loop |
|
SG3Loop
|
SG3Loop | array of SG3Loop |
SG3 Loop Data Segments |
|
UNH1
|
UNH1 | string |
UNH1 |
|
UNH2.1
|
UNH2.1 | string |
UNH201 |
|
UNH2.2
|
UNH2.2 | string |
UNH202 |
|
UNH2.3
|
UNH2.3 | string |
UNH203 |
|
UNH2.4
|
UNH2.4 | string |
UNH204 |
|
UCI
|
UCI | UCISegment |
UCI segment |
|
UNT1
|
UNT1 | string |
UNT1 |
|
UNT2
|
UNT2 | string |
UNT2 |
SG1Loop
SG1Loop
| Name | Path | Type | Description |
|---|---|---|---|
|
UCM1
|
UCM1 | string |
UCM1 |
|
UCM2
|
UCM2 | EdifactMessageIdentification |
Message identification in EDI acknowledgement |
|
UCM3
|
UCM3 | string |
UCM3 |
|
UCM4
|
UCM4 | string |
UCM4 |
|
UCM5
|
UCM5 | string |
UCM5 |
|
UCM6
|
UCM6 | EdifactDataElementIdentification |
EDIFACT Data Elements Identification |
|
SG2Loop
|
SG2Loop | array of EdifactTransactionSetErrorDetails |
SG2Loop Data Segment properties |
SG3Loop
SG3Loop
| Name | Path | Type | Description |
|---|---|---|---|
|
UCF1
|
UCF1 | string |
UCF1 |
|
UCF2
|
UCF2 | EdifactApplicationIdentification |
EDIFACT Application Identification |
|
UCF3
|
UCF3 | EdifactApplicationIdentification |
EDIFACT Application Identification |
|
UCF4
|
UCF4 | integer |
UCF4 |
|
UCF5
|
UCF5 | string |
UCF5 |
|
UCF6
|
UCF6 | string |
UCF6 |
|
UCF7
|
UCF7 | EdifactDataElementIdentification |
EDIFACT Data Elements Identification |
|
SG4Loop
|
SG4Loop | array of SG4Loop |
SG2Loop Data Segments |
UCISegment
UCI segment
| Name | Path | Type | Description |
|---|---|---|---|
|
UCI1
|
UCI1 | string |
UCI1 |
|
UCI2.1
|
UCI2.1 | string |
UCI2.1 |
|
UCI2.2
|
UCI2.2 | string |
UCI2.2 |
|
UCI2.3
|
UCI2.3 | string |
UCI2.3 |
|
UCI3.1
|
UCI3.1 | string |
UCI3.1 |
|
UCI3.2
|
UCI3.2 | string |
UCI3.2 |
|
UCI4
|
UCI4 | string |
UCI4 |
|
UCI5
|
UCI5 | string |
UCI5 |
|
UCI6
|
UCI6 | string |
UCI6 |
|
UCI7
|
UCI7 | EdifactDataElementIdentification |
EDIFACT Data Elements Identification |
EdifactMessageIdentification
Message identification in EDI acknowledgement
| Name | Path | Type | Description |
|---|---|---|---|
|
UCM2.1
|
UCM2.1 | string |
UCM2.1 |
|
UCM2.2
|
UCM2.2 | string |
UCM2.2 |
|
UCM2.3
|
UCM2.3 | string |
UCM2.3 |
|
UCM2.4
|
UCM2.4 | string |
UCM2.4 |
EdifactDataElementIdentification
EDIFACT Data Elements Identification
| Name | Path | Type | Description |
|---|---|---|---|
|
DataElementPosition
|
DataElementPosition | integer |
Position of erroneous data element |
|
ComponentElementPosition
|
ComponentElementPosition | integer |
Position of erroneous component |
|
DataElementOccurrence
|
DataElementOccurrence | integer |
Occurrence of erroneous data element |
EdifactTransactionSetErrorDetails
EDIFACT Transaction Set Error Details - SG2Loop and SG5Loop
| Name | Path | Type | Description |
|---|---|---|---|
|
UCS1
|
UCS1 | string |
UCS1 |
|
UCS2
|
UCS2 | string |
UCS2 |
|
UCD1
|
UCD1 | string |
UCD1 |
|
UCD2
|
UCD2 | EdifactDataElementIdentification |
EDIFACT Data Elements Identification |
EdifactApplicationIdentification
EDIFACT Application Identification
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
Id | string |
Identifier |
|
Qualifier
|
Qualifier | string |
Qualifier |
SG4Loop
SG4Loop
| Name | Path | Type | Description |
|---|---|---|---|
|
UCM1
|
UCM1 | string |
UCM1 |
|
UCM2
|
UCM2 | EdifactMessageIdentification |
Message identification in EDI acknowledgement |
|
UCM3
|
UCM3 | integer |
UCM3 |
|
UCM4
|
UCM4 | string |
UCM4 |
|
UCM5
|
UCM5 | string |
UCM5 |
|
UCM6
|
UCM6 | EdifactDataElementIdentification |
EDIFACT Data Elements Identification |
|
SG5Loop
|
SG5Loop | array of EdifactTransactionSetErrorDetails |
SG5Loop Data Segments |
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 |
EdifactEncodeResponse
Edifact encode response
| Name | Path | Type | Description |
|---|---|---|---|
|
Acknowledgement
|
Acknowledgement | EdifactTechnicalAcknowledgement |
Technical Acknowledgement properties |
|
UNB
|
UNB | EdifactInterchangeHeaders |
EDIFACT Interchange Headers |
|
UNG
|
UNG | EdifactGroupHeaders |
EDIFACT Group Headers |
|
UNH
|
UNH | EdifactMessageHeaders |
EDIFACT Group Segment - Message Headers |
|
DecimalPointIndicator
|
DecimalPointIndicator | integer |
Decimal Point Indicator |
|
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 |
EdifactTechnicalAcknowledgement
Technical Acknowledgement properties
| Name | Path | Type | Description |
|---|---|---|---|
|
UNH1
|
UNH1 | string |
UNH1 |
|
UNH2.1
|
UNH2.1 | string |
UNH201 |
|
UNH2.2
|
UNH2.2 | string |
UNH202 |
|
UNH2.3
|
UNH2.3 | string |
UNH203 |
|
UNH2.4
|
UNH2.4 | string |
UNH204 |
|
UCI
|
UCI | UCISegment |
UCI segment |
|
UNT1
|
UNT1 | string |
UNT1 |
|
UNT2
|
UNT2 | string |
UNT2 |
EdifactEncodeV2Response
Edifact V2 encode response
| Name | Path | Type | Description |
|---|---|---|---|
|
Interchange
|
Interchange | EdifactInterchangeBatchEnvelope |
EDIFACT interchange batch envelope |
|
Content
|
Content | Object | |
|
AgreementProperties
|
AgreementProperties | EdiAgreementProperties |
EDI agreement properties |
|
Delimiters
|
Delimiters | Delimiters |
Delimiters associated with an EDI message |
EdifactInterchangeBatchEnvelope
EDIFACT interchange batch envelope
| Name | Path | Type | Description |
|---|---|---|---|
|
InterchangeControlNumber
|
InterchangeControlNumber | string |
Interchange control number |
|
FunctionalGroups
|
FunctionalGroups | array of EdifactFunctionalGroupBatchEnvelope |
Functional groups in the interchange |
|
TransactionSets
|
TransactionSets | array of EdifactTransactionSetBatchEnvelope |
Transaction sets |
|
UNB_Segment
|
UNB_Segment | string |
UNBSegment |
|
UNB2_1
|
UNB2_1 | string |
UNBTwo1 |
|
UNB2_2
|
UNB2_2 | string |
UNBTwo2 |
|
UNB2_3
|
UNB2_3 | string |
UNBTwo3 |
|
UNB2_4
|
UNB2_4 | string |
UNBTwo4 |
|
UNB3_1
|
UNB3_1 | string |
UNBThree1 |
|
UNB3_2
|
UNB3_2 | string |
UNBThree2 |
|
UNB3_3
|
UNB3_3 | string |
UNBThree3 |
|
UNB3_4
|
UNB3_4 | string |
UNBThree4 |
|
UNB11
|
UNB11 | string |
UNB11 |
Object
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 |
EdifactFunctionalGroupBatchEnvelope
EDIFACT functional group batch envelope
| Name | Path | Type | Description |
|---|---|---|---|
|
GroupControlNumber
|
GroupControlNumber | string |
Group control number |
|
TransactionSets
|
TransactionSets | array of EdifactTransactionSetBatchEnvelope |
Transaction sets |
|
UNG_Segment
|
UNG_Segment | string |
UNG Segment |
|
UNG1
|
UNG1 | string |
UNG1 |
|
UNG2_1
|
UNG2_1 | string |
UNG2.1 |
|
UNG2_2
|
UNG2_2 | string |
UNG2.2 |
|
UNG3_1
|
UNG3_1 | string |
UNG3.1 |
|
UNG3_2
|
UNG3_2 | string |
UNG3.2 |
|
UNG4_1
|
UNG4_1 | string |
UNG4.1 |
|
UNG4_2
|
UNG4_2 | string |
UNG4.2 |
|
UNG5
|
UNG5 | string |
UNG5 |
|
UNG6
|
UNG6 | string |
UNG6 |
|
UNG7_1
|
UNG7_1 | string |
UNG7.1 |
|
UNG7_2
|
UNG7_2 | string |
UNG7.2 |
|
UNG7_3
|
UNG7_3 | string |
UNG7.3 |
EdifactTransactionSetBatchEnvelope
Batch EDIFACT transaction set
| Name | Path | Type | Description |
|---|---|---|---|
|
TransactionSetControlNumber
|
TransactionSetControlNumber | string |
Transaction set control number |
|
MessageId
|
MessageId | string |
Batch message Id |
|
UNH1
|
UNH1 | string |
UNH1 |
|
UNH2_1
|
UNH2_1 | string |
UNH2.1 |
|
UNH2_2
|
UNH2_2 | string |
UNH2.2 |
|
UNH2_3
|
UNH2_3 | string |
UNH2.3 |
|
UNH2_4
|
UNH2_4 | string |
UNH2.4 |
|
UNH2_5
|
UNH2_5 | string |
UNH2.5 |
|
UNH2_6
|
UNH2_6 | string |
UNH2.6 |
|
UNH2_7
|
UNH2_7 | string |
UNH2.7 |
EdifactBatchEncodeResponse
EDIFACT batch encode response
| Name | Path | Type | Description |
|---|---|---|---|
|
Interchange
|
Interchange | EdifactInterchangeBatchEnvelope |
EDIFACT 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 |
BatchItemError
Error response for a bad batch message
| Name | Path | Type | Description |
|---|---|---|---|
|
MessageId
|
MessageId | string |
Bad message id |
|
Error
|
Error | string |
Error |