UNB

UNB object is only used as part of the EdifactInterchange object and represents the standard EDIFACT UNB segment, interchange header.

Example

{
  "SYNTAXIDENTIFIER_1": {
    "SyntaxIdentifier_1": "UNOB",
    "SyntaxVersionNumber_2": "1"
  },
  "INTERCHANGESENDER_2": {
    "InterchangeSenderIdentification_1": "102096559TEST",
    "IdentificationCodeQualifier_2": "16",
    "InterchangeSenderInternalIdentification_3": "ZZUK"
  },
  "INTERCHANGERECIPIENT_3": {
    "InterchangeRecipientIdentification_1": "PARTNERID",
    "IdentificationCodeQualifier_2": "01",
    "InterchangeRecipientInternalIdentification_3": "ZZUK"
  },
  "DATEANDTIMEOFPREPARATION_4": {
    "Date_1": "071101",
    "Time_2": "1701"
  },
  "InterchangeControlReference_5": "131",
  "ApplicationReference_7": "INVOIC",
  "AcknowledgementRequest_9": "1",
  "TestIndicator_11": "1"
}

Attributes

SYNTAXIDENTIFIER_1 object

Syntax identifier.

1. SyntaxIdentifier_1 string

   a3, upper case Controlling Agency (e.g. UNO=UN/ECE) and a1 stating level (e.g. A) (which together give UNOA).

2. SyntaxVersionNumber_2 string

   Increments 1 for each new version. Shall be 2 to indicate this version.

INTERCHANGESENDER_2 object

The interchange sender.

1. InterchangeSenderIdentification_1 string

   Sender identification. Code or name as specified in IA

2. IdentificationCodeQualifier_2 string

   Partner identification code qualifier. Used with sender identification code.

3. InterchangeSenderInternalIdentification_3 string

   Address for reverse routing.

INTERCHANGERECIPIENT_3 object

The interchange recipient.

1. InterchangeRecipientIdentification_1 string

   Recipient Identification. Code or name as specified in IA

2. IdentificationCodeQualifier_2 string

   Partner identification code qualifier. Used with recipient identification code.

3. InterchangeRecipientInternalIdentification_3 string

   Routing address. If used, normally coded sub-address for onward routing.

DATEANDTIMEOFPREPARATION_4 object

The date and time when the interchange was created.

1. Date_1 string

   Date.

2. Time_2 string

   Time.

InterchangeControlReference_5 string

Unique reference assigned by sender.

RECIPIENTSREFERENCEPASSWORDDETAILS_6 object

The date and time when the interchange was created.

1. RecipientReferencePassword_1 string

   Recipient's reference/password.

2. RecipientReferencePasswordQualifier_2 string

   Recipient's reference/password qualifier.

ApplicationReference_7 string

Optionally message identification if the interchange contains only one type of message.

ProcessingPriorityCode_8 string

Used if specified in IA.

AcknowledgementRequest_9 string

Set = 1 if senderrequests acknowledgement, i.e. UNB and UNZ segments received and identified.

InterchangeAgreementIdentifier_10 string

If used, to identify type of communication agreement controlling the interchange,e.g. Customs or ECE greement. Code or name as specified in IA.

TestIndicator_11 string

Set = 1 if the interchange is a test. Otherwise not used used.