documents | String List Documents to which to add a group envelope. | |
IDcode | String The Functional ID Code of the EDI document according to the EDI standard. | |
senderId | String (optional when syntaxVersion is greater than 3) 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. | |
senderQual | String (optional) EDI ID qualifier for the sender ID. | |
receiverId | String (optional when syntaxVersion is greater than 3) 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. | |
receiverQual | String (optional) EDI ID qualifier for the receiver ID. | |
ctlFromTable | String (optional; this parameter is used only when the grpCtlNumber parameter is not specified) Whether you want the service to obtain the control number for the group 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 a random generated number as the value. | |
grpCtlNumber | String (optional) The group control number of the EDI document. If a group control number is not specified, the service obtains the control number from the EDIControlNumber table. That is, the service behaves as if the ctlFromTable parameter is set to true. | |
prodMode | String (optional) The production mode associated with control number: Production (the default) or Test. | |
syntaxVersion | String Syntax version of the envelope level. | |
agencyCode | String (optional) Responsible agency code: UN (default) or AA. | |
verCode | String (optional) EDI standard version code, e.g., D, S, etc. | |
relCode | String (optional) EDI message standard release code, e.g., 96A, 97B, etc. | |
aACode | String (optional) EDI message standard assigned code, e.g., OD, EN, etc. | |
password | String (optional) The recipient transmission reference password. | |
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 ' 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. | |
release | String The release character for composite elements, e.g., ^. The default is the ? character. | |
decimal | String The release character for composite elements, e.g., . (the period character, which is the default). | |
outDocument | String Contains the outbound EDI string. |