MGCLatticeCreateSalesOrderRequestContract

Request contract for CAPTURING (creating) a sales order (SalesType::Sales) via the AxSalesTable/AxSalesLine business-document framework: the customer account, an optional currency code, an optional caller-supplied sales order number (SalesOrderId), an optional customer reference, the order lines, the preview flag, and the common envelope fields (correlation/request identifiers, legal entity, user context).

Methods

new

Initializes a new instance of the MGCLatticeCreateSalesOrderRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeCreateSalesOrderRequestContract class.

• Visibility: public
• Returns: MGCLatticeCreateSalesOrderRequestContract A new MGCLatticeCreateSalesOrderRequestContract instance.

No parameters.

parmCorrelationId

Gets or sets the correlation identifier for tracing the request across systems.

• Visibility: public
• Returns: Guid

Name	Type	Optional	Description
_correlationId	Guid	Yes

parmRequestId

Gets or sets the unique request identifier for idempotency.

• Visibility: public
• Returns: Guid

Name	Type	Optional	Description
_requestId	Guid	Yes

parmLegalEntityId

Gets or sets the legal entity (company) in which to create the sales order.

• Visibility: public
• Returns: DataAreaId

Name	Type	Optional	Description
_legalEntityId	DataAreaId	Yes

parmUserContext

Gets or sets the user context under which the operation executes.

• Visibility: public
• Returns: UserId

Name	Type	Optional	Description
_userContext	UserId	Yes

parmCustAccount

Gets or sets the customer account the sales order is raised for.

• Visibility: public
• Returns: CustAccount

Name	Type	Optional	Description
_custAccount	CustAccount	Yes

parmCurrencyCode

Gets or sets the optional order currency code (customer default is used when blank).

• Visibility: public
• Returns: CurrencyCode

Name	Type	Optional	Description
_currencyCode	CurrencyCode	Yes

parmSalesOrderId

Gets or sets an optional caller-supplied SalesId. When blank, the number sequence assigns one.

• Visibility: public
• Returns: SalesId

Name	Type	Optional	Description
_salesOrderId	SalesId	Yes

parmCustomerRef

Gets or sets the optional customer reference (e.g. the external purchase order number) for the header.

• Visibility: public
• Returns: CustRef

Name	Type	Optional	Description
_customerRef	CustRef	Yes

parmLines

Gets or sets the order lines (each an MGCLatticeSalesOrderCaptureLineContract).

• Visibility: public
• Returns: List

Name	Type	Optional	Description
_lines	List	Yes

parmExternalSystem

Gets or sets the external system whose keys the request's external key members, and its lines' keys, hold.

• Visibility: public
• Returns: MGCLatticeExternalSystemId The ExternalSystem value.

Name	Type	Optional	Description
_externalSystem	MGCLatticeExternalSystemId	Yes	The ExternalSystem value.

parmCustAccountExternalKey

Gets or sets the external system's key of the customer, in place of CustAccount.

• Visibility: public
• Returns: MGCLatticeExternalKey The CustAccountExternalKey value.

Name	Type	Optional	Description
_custAccountExternalKey	MGCLatticeExternalKey	Yes	The CustAccountExternalKey value.

parmPreviewMode

Gets or sets whether the request runs as a preview. This operation has no preview: a request with PreviewMode set is refused with PreviewUnsupported before anything runs.

• Visibility: public
• Returns: boolean The current preview flag.

Name	Type	Optional	Description
_previewMode	boolean	Yes	The preview flag to set.