Skip to content

X12OutboundEdiHeaders

Source code in docs_src/capo_b2bi/types/x12_outbound_edi_headers.py
class X12OutboundEdiHeaders(TypedDict, closed=True):
    interchange_control_headers: NotRequired[
        "capo_b2bi.types.x12_interchange_control_headers.X12InterchangeControlHeaders"
    ]
    """<p>In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.</p>"""
    functional_group_headers: NotRequired[
        "capo_b2bi.types.x12_functional_group_headers.X12FunctionalGroupHeaders"
    ]
    """<p>The functional group headers for the X12 object.</p>"""
    delimiters: NotRequired["capo_b2bi.types.x12_delimiters.X12Delimiters"]
    """<p>The delimiters, for example semicolon (<code>;</code>), that separates sections of the headers for the X12 object.</p>"""
    validate_edi: NotRequired["capo_b2bi.types.x12_validate_edi.X12ValidateEdi"]
    """<p>Specifies whether or not to validate the EDI for this X12 object: <code>TRUE</code> or <code>FALSE</code>. When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.</p>"""
    control_numbers: NotRequired[
        "capo_b2bi.types.x12_control_numbers.X12ControlNumbers"
    ]
    """<p>Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.</p>"""
    gs05_time_format: NotRequired[
        "capo_b2bi.types.x12_gs05_time_format.X12GS05TimeFormat"
    ]

control_numbers instance-attribute

control_numbers: NotRequired[X12ControlNumbers]

Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

delimiters instance-attribute

delimiters: NotRequired[X12Delimiters]

The delimiters, for example semicolon (;), that separates sections of the headers for the X12 object.

functional_group_headers instance-attribute

functional_group_headers: NotRequired[X12FunctionalGroupHeaders]

The functional group headers for the X12 object.

gs05_time_format instance-attribute

gs05_time_format: NotRequired[X12GS05TimeFormat]

interchange_control_headers instance-attribute

interchange_control_headers: NotRequired[X12InterchangeControlHeaders]

In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

validate_edi instance-attribute

validate_edi: NotRequired[X12ValidateEdi]

Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE. When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.