X12EnvelopeSettings Class

The X12 agreement envelope settings.

All required parameters must be populated in order to send to Azure.

Inheritance

msrest.serialization.Model

X12EnvelopeSettings

Constructor

X12EnvelopeSettings(*, control_standards_id: int, use_control_standards_id_as_repetition_character: bool, sender_application_id: str, receiver_application_id: str, control_version_number: str, interchange_control_number_lower_bound: int, interchange_control_number_upper_bound: int, rollover_interchange_control_number: bool, enable_default_group_headers: bool, group_control_number_lower_bound: int, group_control_number_upper_bound: int, rollover_group_control_number: bool, group_header_agency_code: str, group_header_version: str, transaction_set_control_number_lower_bound: int, transaction_set_control_number_upper_bound: int, rollover_transaction_set_control_number: bool, overwrite_existing_transaction_set_control_number: bool, group_header_date_format: str | X12DateFormat, group_header_time_format: str | X12TimeFormat, usage_indicator: str | UsageIndicator, functional_group_id: str | None = None, transaction_set_control_number_prefix: str | None = None, transaction_set_control_number_suffix: str | None = None, **kwargs)

Keyword-Only Parameters

Name	Description
control_standards_id	int Required. The controls standards id.
use_control_standards_id_as_repetition_character	bool Required. The value indicating whether to use control standards id as repetition character.
sender_application_id	str Required. The sender application id.
receiver_application_id	str Required. The receiver application id.
control_version_number	str Required. The control version number.
interchange_control_number_lower_bound	int Required. The interchange control number lower bound.
interchange_control_number_upper_bound	int Required. The interchange control number upper bound.
rollover_interchange_control_number	bool Required. The value indicating whether to rollover interchange control number.
enable_default_group_headers	bool Required. The value indicating whether to enable default group headers.
functional_group_id	str The functional group id.
group_control_number_lower_bound	int Required. The group control number lower bound.
group_control_number_upper_bound	int Required. The group control number upper bound.
rollover_group_control_number	bool Required. The value indicating whether to rollover group control number.
group_header_agency_code	str Required. The group header agency code.
group_header_version	str Required. The group header version.
transaction_set_control_number_lower_bound	int Required. The transaction set control number lower bound.
transaction_set_control_number_upper_bound	int Required. The transaction set control number upper bound.
rollover_transaction_set_control_number	bool Required. The value indicating whether to rollover transaction set control number.
transaction_set_control_number_prefix	str The transaction set control number prefix.
transaction_set_control_number_suffix	str The transaction set control number suffix.
overwrite_existing_transaction_set_control_number	bool Required. The value indicating whether to overwrite existing transaction set control number.
group_header_date_format	str or X12DateFormat Required. The group header date format. Possible values include: "NotSpecified", "CCYYMMDD", "YYMMDD".
group_header_time_format	str or X12TimeFormat Required. The group header time format. Possible values include: "NotSpecified", "HHMM", "HHMMSS", "HHMMSSdd", "HHMMSSd".
usage_indicator	str or UsageIndicator Required. The usage indicator. Possible values include: "NotSpecified", "Test", "Information", "Production".

Variables

Name	Description
control_standards_id	int Required. The controls standards id.
use_control_standards_id_as_repetition_character	bool Required. The value indicating whether to use control standards id as repetition character.
sender_application_id	str Required. The sender application id.
receiver_application_id	str Required. The receiver application id.
control_version_number	str Required. The control version number.
interchange_control_number_lower_bound	int Required. The interchange control number lower bound.
interchange_control_number_upper_bound	int Required. The interchange control number upper bound.
rollover_interchange_control_number	bool Required. The value indicating whether to rollover interchange control number.
enable_default_group_headers	bool Required. The value indicating whether to enable default group headers.
functional_group_id	str The functional group id.
group_control_number_lower_bound	int Required. The group control number lower bound.
group_control_number_upper_bound	int Required. The group control number upper bound.
rollover_group_control_number	bool Required. The value indicating whether to rollover group control number.
group_header_agency_code	str Required. The group header agency code.
group_header_version	str Required. The group header version.
transaction_set_control_number_lower_bound	int Required. The transaction set control number lower bound.
transaction_set_control_number_upper_bound	int Required. The transaction set control number upper bound.
rollover_transaction_set_control_number	bool Required. The value indicating whether to rollover transaction set control number.
transaction_set_control_number_prefix	str The transaction set control number prefix.
transaction_set_control_number_suffix	str The transaction set control number suffix.
overwrite_existing_transaction_set_control_number	bool Required. The value indicating whether to overwrite existing transaction set control number.
group_header_date_format	str or X12DateFormat Required. The group header date format. Possible values include: "NotSpecified", "CCYYMMDD", "YYMMDD".
group_header_time_format	str or X12TimeFormat Required. The group header time format. Possible values include: "NotSpecified", "HHMM", "HHMMSS", "HHMMSSdd", "HHMMSSd".
usage_indicator	str or UsageIndicator Required. The usage indicator. Possible values include: "NotSpecified", "Test", "Information", "Production".