Skip to main content

MGCLatticeReturnLineContract

Data contract representing a return order line with ItemId, Qty, the storage dimensions (InventDimId, or SiteId / WarehouseId) and an optional DispositionCode (applied at registration; can also be supplied on the receive request). Used by createSalesReturn and createPurchaseReturn. The return reason is the request header's ReturnReasonCodeId.

Methods​

new​

Initializes a new instance of the MGCLatticeReturnLineContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeReturnLineContract class.

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

No parameters.

parmItemId​

Gets or sets the item number for the line.

  • Visibility: public
  • Returns: ItemId The ItemId value.
NameTypeOptionalDescription
_itemIdItemIdYesThe ItemId value.

parmQty​

Gets or sets the quantity for the line.

  • Visibility: public
  • Returns: Qty The Qty value.
NameTypeOptionalDescription
_qtyQtyYesThe Qty value.

parmInventDimId​

Gets or sets the inventory dimension identifier (site, warehouse, etc.).

  • Visibility: public
  • Returns: InventDimId The InventDimId value.
NameTypeOptionalDescription
_inventDimIdInventDimIdYesThe InventDimId value.

parmSiteId​

Gets or sets the site of the line, used with WarehouseId when no InventDimId is given.

  • Visibility: public
  • Returns: InventSiteId The SiteId value.
NameTypeOptionalDescription
_siteIdInventSiteIdYesThe SiteId value.

parmWarehouseId​

Gets or sets the warehouse of the line, used with SiteId when no InventDimId is given. A purchase return ships from it, so it must hold the returned quantity.

  • Visibility: public
  • Returns: InventLocationId The WarehouseId value.
NameTypeOptionalDescription
_warehouseIdInventLocationIdYesThe WarehouseId value.

parmDispositionCode​

Gets or sets the disposition code of the return line (optional at creation; the receive request can supply one for lines that have none). USMF: 11 = Credit, 21 = CreditOnly, 61 = Scrap.

  • Visibility: public
  • Returns: ReturnDispositionCodeId The DispositionCode value.
NameTypeOptionalDescription
_dispositionCodeReturnDispositionCodeIdYesThe DispositionCode value.

parmItemIdExternalKey​

Gets or sets the external system's key of the released product, in place of ItemId; it uses the request's ExternalSystem.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The ItemIdExternalKey value.
NameTypeOptionalDescription
_itemIdExternalKeyMGCLatticeExternalKeyYesThe ItemIdExternalKey value.