MGCLatticeCreateSalesReturnRequestContract

Data contract for creating a sales return order (SalesType::ReturnItem): the customer, the header return reason, an optional return deadline, and the return lines.

Methods

new

Initializes a new instance of the MGCLatticeCreateSalesReturnRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeCreateSalesReturnRequestContract class.

• Visibility: public
• Returns: MGCLatticeCreateSalesReturnRequestContract A new MGCLatticeCreateSalesReturnRequestContract 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 return 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 return order is raised for.

• Visibility: public
• Returns: CustAccount

Name	Type	Optional	Description
_custAccount	CustAccount	Yes

parmReturnReasonCodeId

Gets or sets the header return reason code for the return order.

• Visibility: public
• Returns: ReturnReasonCodeId

Name	Type	Optional	Description
_returnReasonCodeId	ReturnReasonCodeId	Yes

parmReturnDeadline

Gets or sets the optional return deadline (by when the goods must be received).

• Visibility: public
• Returns: ReturnDeadline

Name	Type	Optional	Description
_returnDeadline	ReturnDeadline	Yes

parmLines

Gets or sets the return lines (each an MGCLatticeReturnLineContract).

• Visibility: public
• Returns: List

Name	Type	Optional	Description
_lines	List	Yes

parmExternalSystem

Gets or sets the external system whose keys the request's and its lines' external key members 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 the error code PreviewUnsupported and nothing is created or posted.

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

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