MGCLatticePurchaseProductReceiptCancelRequestContract

Request contract for canceling a posted purchase product receipt (cancelPurchaseProductReceipt): the purchase order (or its external key), the product receipt to cancel (optional: without it, the order's only product receipt that can be canceled), the preview flag (always refused) and the common envelope fields.

Methods

construct

Creates a new instance of the MGCLatticePurchaseProductReceiptCancelRequestContract class.

• Visibility: public
• Returns: MGCLatticePurchaseProductReceiptCancelRequestContract A new MGCLatticePurchaseProductReceiptCancelRequestContract 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) of the purchase order.

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

Name	Type	Optional	Description
_legalEntityId	DataAreaId	Yes	The LegalEntityId value.

parmUserContext

Gets or sets the calling system's user context (informational).

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

Name	Type	Optional	Description
_userContext	UserId	Yes	The UserContext value.

parmPurchaseOrderId

Gets or sets the purchase order whose product receipt is canceled (or send PurchaseOrderIdExternalKey).

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

Name	Type	Optional	Description
_purchaseOrderId	PurchId	Yes	The PurchaseOrderId value.

parmProductReceiptId

Gets or sets the product receipt to cancel. Optional: without it the order's only product receipt that can be canceled is canceled, and an order with several is refused.

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

Name	Type	Optional	Description
_productReceiptId	PackingSlipId	Yes	The ProductReceiptId value.

parmPreviewMode

Gets or sets preview mode. The operation has no preview, so a request with PreviewMode set is refused.

• Visibility: public
• Returns: boolean The PreviewMode value.

Name	Type	Optional	Description
_previewMode	boolean	Yes	The PreviewMode 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 order, in place of PurchaseOrderId.

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

Name	Type	Optional	Description
_purchaseOrderIdExternalKey	MGCLatticeExternalKey	Yes	The PurchaseOrderIdExternalKey value.