documents | String List EDI documents to which to add an interchange envelope. The EDI document might be wrapped with group envelopes. | |
authQual | String Authorization qualifier for the interchange envelope. | |
authInfo | String Authorization information for the interchange envelope. | |
securityQual | String Security qualifier for the interchange envelope. | |
securityInfo | String Security information for the interchange envelope. | |
senderQual | String EDI ID qualifier for the sender ID. It is used with sender to obtain the Trading Networks internal ID. | |
sender | String The sender to identify in the interchange envelope. For example, if you specify 01 for senderQual (indicating a D-U-N-S number), specify the value of the D-U-N-S number for sender. | |
receiverQual | String EDI ID qualifier for the receiver ID. It is used with receiver to obtain the Trading Networks internal ID. | |
receiver | String The receiver to identify in the interchange envelope. For example, if you specify 01 for receiverQual (indicating a D-U-N-S number), specify the value of the D-U-N-S number for sender. | |
ctlVersion | String Version of the EDI standard used, with a 00 prefix, e.g., for version 4010, specify 004010. | |
repSeparator | String A separator for the repeated occurrences of a simple data element or a composite data structure. Length: 1. Note: The repSeparator must be a different character than the record, field, or subfield delimiters. | |
ctlNumber | String (optional) The interchange control number of the EDI document. | |
ctlFromTable | String (optional; this parameter is used only when the ctlNumber parameter is not specified) Whether you want the service to obtain the control number for the interchange from the EDIControlNumber table, which is a module-specific table in the Trading Networks database. | |
Value | Meaning | |
true | Obtain the control number from the EDIControlNumber table. | |
false | Do not obtain the control number from the EDIControlNumber table. Use the value specified in the ctlNumber parameter. | |
ackRequested | String (optional) Whether you want to request an acknowledgment for this interchange. | |
Value | Meaning | |
0 | Do not request an acknowledgment for this interchange. This is the default. | |
1 | Requests an acknowledgment for this interchange. | |
testIndicator | String (optional) Whether to indicate production or test mode. | |
Value | Meaning | |
P | Production. This is the default value. | |
T | Test. | |
I | Information. | |
delimiters | Document (optional) Delimiters used in the outbound EDI document. | |
Key | Description | |
record | String The segment terminator for the EDI document, e.g., \u000a to use the new line character. The default is the new line character. | |
field | String The field separator for each EDI segment e.g., !. The default is the * character. | |
subfield | String The separator for composite elements, e.g., ^. The default is the : character. | |
addGroup | String (optional) Whether you want the addICEnvelope service to add group envelopes in addition to the interchange envelope. Note: You must add a group envelope either by setting this parameter to true, or setting this parameter to false and using the addGroupEnvelope service prior to using the addICEnvelope service. Failing to add a group envelope or creating a group envelope twice will result in an invalid document. | |
Value | Meaning | |
true | Add group envelopes (GS and GE segments) to the document prior to adding the interchange envelope. Note that ANSI X12 documents must have a group segment. Set this parameter to true if you did not use the addGroupEnvelope service and you do not need maximum control over group envelope parameters. | |
false | Do not add group envelopes prior to creating the Interchange envelope. Set this parameter to false if you would prefer to use the addGroupEnvelope service prior to using this service. The addGroupEnvelope service provides more control over the parameters in the group envelopes. | |
groupInfo | Document (optional) Information about the group segments added by addGroup. | |
Key | Description | |
IDcode | String (optional) The Functional ID Code of the EDI document according to the EDI standard. | |
sender | String (optional) The sender to identify in the group envelope. For example, if you specify 01 for senderQual (indicating a D-U-N-S number), specify the value of the D-U-N-S number for sender. | |
receiver | String (optional) The receiver to identify in the group envelope. For example, if you specify 01 for receiverQual (indicating a D-U-N-S number), specify the value of the D-U-N-S number for receiver. | |
ctlNumber | String (optional) The control number of the EDI document. | |
agencyCode | String (optional) Responsible agency code: T (default) or X. | |
groupVersion | String (optional) The group version of the EDI document. | |
justification | String How you want the values for ICA header fields to be justified. Specify one of the following: | |
Value | Meaning | |
left | Left justify. | |
right | Right justify. | |
none | No justification. This is the default. | |
ctlNumberWleadingZero | String (optional) (ANSI X12 only) Whether to add leading zeros to the interchange control number to make it a nine-digit number. | |
Value | Meaning | |
false | Do not add leading zeros to the interchange control number. This is the default. | |
true | Add leading zeros to the interchange control number to make it a nine digit number, e.g., 12 becomes 000000012. | |
outDocument | String Contains the outbound EDI string. This parameter can be validated by providing it as input to the
wm.b2b.edi:envelopeProcess service. |