MGCLatticePurchaseReturnShipRequestContract

Data contract for purchase return order shipment requests containing PurchaseOrderId, the return shipment (product receipt) number PackingSlipId, and PostingDate.

Methods

new

Initializes a new instance of the MGCLatticePurchaseReturnShipRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticePurchaseReturnShipRequestContract class.

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

No parameters.

parmCorrelationId

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

• Visibility: public
• Returns: Guid The CorrelationId value.

Name	Type	Optional	Description
_correlationId	Guid	Yes	The CorrelationId value.

parmRequestId

Gets or sets the unique request identifier for idempotency.

• Visibility: public
• Returns: Guid The RequestId value.

Name	Type	Optional	Description
_requestId	Guid	Yes	The RequestId value.

parmLegalEntityId

Gets or sets the legal entity (company) in which to execute the operation.

• Visibility: public
• Returns: DataAreaId The LegalEntityId value.

Name	Type	Optional	Description
_legalEntityId	DataAreaId	Yes	The LegalEntityId value.

parmUserContext

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

• Visibility: public
• Returns: UserId The UserContext value.

Name	Type	Optional	Description
_userContext	UserId	Yes	The UserContext value.

parmPurchaseOrderId

Gets or sets the purchase order identifier for the return operation.

• Visibility: public
• Returns: PurchId The PurchaseOrderId value.

Name	Type	Optional	Description
_purchaseOrderId	PurchId	Yes	The PurchaseOrderId value.

parmPostingDate

Gets or sets the posting date for the journal entry.

• Visibility: public
• Returns: TransDate The PostingDate value.

Name	Type	Optional	Description
_postingDate	TransDate	Yes	The PostingDate value.

parmPackingSlipId

Gets or sets the return shipment (product receipt) number; required.

• Visibility: public
• Returns: PackingSlipId The PackingSlipId value.

Name	Type	Optional	Description
_packingSlipId	PackingSlipId	Yes	The PackingSlipId value.

parmExternalSystem

Gets or sets the external system whose keys the request's external key members hold.

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

Name	Type	Optional	Description
_externalSystem	MGCLatticeExternalSystemId	Yes	The ExternalSystem value.

parmPurchaseOrderIdExternalKey

Gets or sets the external system's key of the purchase return (a purchase order key), in place of PurchaseOrderId.

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

Name	Type	Optional	Description
_purchaseOrderIdExternalKey	MGCLatticeExternalKey	Yes	The PurchaseOrderIdExternalKey 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.