Skip to content

X12InterchangeControlHeaders

Source code in docs_src/capo_b2bi/types/x12_interchange_control_headers.py
class X12InterchangeControlHeaders(TypedDict, closed=True):
    sender_id_qualifier: NotRequired["capo_b2bi.types.x12_id_qualifier.X12IdQualifier"]
    """<p>Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.</p>"""
    sender_id: NotRequired["capo_b2bi.types.x12_sender_id.X12SenderId"]
    """<p>Located at position ISA-06 in the header. This value (along with the <code>senderIdQualifier</code>) identifies the sender of the interchange. </p>"""
    receiver_id_qualifier: NotRequired[
        "capo_b2bi.types.x12_id_qualifier.X12IdQualifier"
    ]
    """<p>Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.</p>"""
    receiver_id: NotRequired["capo_b2bi.types.x12_receiver_id.X12ReceiverId"]
    """<p>Located at position ISA-08 in the header. This value (along with the <code>receiverIdQualifier</code>) identifies the intended recipient of the interchange. </p>"""
    repetition_separator: NotRequired[
        "capo_b2bi.types.x12_repetition_separator.X12RepetitionSeparator"
    ]
    """<p>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.</p> <note> <p>This parameter is only honored for version greater than 401 (<code>VERSION_4010</code> and higher).</p> <p>For versions less than 401, this field is called <a href="https://www.stedi.com/edi/x12-004010/segment/ISA#ISA-11">StandardsId</a>, in which case our service sets the value to <code>U</code>.</p> </note>"""
    acknowledgment_requested_code: NotRequired[
        "capo_b2bi.types.x12_acknowledgment_requested_code.X12AcknowledgmentRequestedCode"
    ]
    """<p>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.</p>"""
    usage_indicator_code: NotRequired[
        "capo_b2bi.types.x12_usage_indicator_code.X12UsageIndicatorCode"
    ]
    """<p>Located at position ISA-15 in the header. Specifies how this interchange is being used:</p> <ul> <li> <p> <code>T</code> indicates this interchange is for testing.</p> </li> <li> <p> <code>P</code> indicates this interchange is for production.</p> </li> <li> <p> <code>I</code> indicates this interchange is informational.</p> </li> </ul>"""

acknowledgment_requested_code instance-attribute

acknowledgment_requested_code: NotRequired[X12AcknowledgmentRequestedCode]

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.

receiver_id instance-attribute

receiver_id: NotRequired[X12ReceiverId]

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

receiver_id_qualifier instance-attribute

receiver_id_qualifier: NotRequired[X12IdQualifier]

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

repetition_separator instance-attribute

repetition_separator: NotRequired[X12RepetitionSeparator]

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.

sender_id instance-attribute

sender_id: NotRequired[X12SenderId]

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

sender_id_qualifier instance-attribute

sender_id_qualifier: NotRequired[X12IdQualifier]

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

usage_indicator_code instance-attribute

usage_indicator_code: NotRequired[X12UsageIndicatorCode]

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.