Class: Aws::B2bi::Types::X12InterchangeControlHeaders

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb

Overview

In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope. It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#acknowledgment_requested_codeString

Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

Returns:

  • (String)


2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2817

class X12InterchangeControlHeaders < Struct.new(
  :sender_id_qualifier,
  :sender_id,
  :receiver_id_qualifier,
  :receiver_id,
  :repetition_separator,
  :acknowledgment_requested_code,
  :usage_indicator_code)
  SENSITIVE = []
  include Aws::Structure
end

#receiver_idString

Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

Returns:

  • (String)


2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2817

class X12InterchangeControlHeaders < Struct.new(
  :sender_id_qualifier,
  :sender_id,
  :receiver_id_qualifier,
  :receiver_id,
  :repetition_separator,
  :acknowledgment_requested_code,
  :usage_indicator_code)
  SENSITIVE = []
  include Aws::Structure
end

#receiver_id_qualifierString

Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

Returns:

  • (String)


2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2817

class X12InterchangeControlHeaders < Struct.new(
  :sender_id_qualifier,
  :sender_id,
  :receiver_id_qualifier,
  :receiver_id,
  :repetition_separator,
  :acknowledgment_requested_code,
  :usage_indicator_code)
  SENSITIVE = []
  include Aws::Structure
end

#repetition_separatorString

Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

This parameter is only honored for version greater than 401 (VERSION_4010 and higher).

For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.

Returns:

  • (String)


2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2817

class X12InterchangeControlHeaders < Struct.new(
  :sender_id_qualifier,
  :sender_id,
  :receiver_id_qualifier,
  :receiver_id,
  :repetition_separator,
  :acknowledgment_requested_code,
  :usage_indicator_code)
  SENSITIVE = []
  include Aws::Structure
end

#sender_idString

Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

Returns:

  • (String)


2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2817

class X12InterchangeControlHeaders < Struct.new(
  :sender_id_qualifier,
  :sender_id,
  :receiver_id_qualifier,
  :receiver_id,
  :repetition_separator,
  :acknowledgment_requested_code,
  :usage_indicator_code)
  SENSITIVE = []
  include Aws::Structure
end

#sender_id_qualifierString

Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

Returns:

  • (String)


2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2817

class X12InterchangeControlHeaders < Struct.new(
  :sender_id_qualifier,
  :sender_id,
  :receiver_id_qualifier,
  :receiver_id,
  :repetition_separator,
  :acknowledgment_requested_code,
  :usage_indicator_code)
  SENSITIVE = []
  include Aws::Structure
end

#usage_indicator_codeString

Located at position ISA-15 in the header. Specifies how this interchange is being used:

  • T indicates this interchange is for testing.

  • P indicates this interchange is for production.

  • I indicates this interchange is informational.

Returns:

  • (String)


2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2817

class X12InterchangeControlHeaders < Struct.new(
  :sender_id_qualifier,
  :sender_id,
  :receiver_id_qualifier,
  :receiver_id,
  :repetition_separator,
  :acknowledgment_requested_code,
  :usage_indicator_code)
  SENSITIVE = []
  include Aws::Structure
end