MGCLatticePurchaseReturnService
Custom service for purchase returns (Accounts payable): create a return order, ship it (return packing slip) and credit it (vendor credit note). Sales returns are MGCLatticeSalesReturnService.
Methods
new
Initializes a new instance of the MGCLatticePurchaseReturnService class.
- Visibility:
public - Returns:
void
No parameters.
construct
Creates a new instance of the MGCLatticePurchaseReturnService class.
- Visibility:
public - Returns:
MGCLatticePurchaseReturnServiceA new MGCLatticePurchaseReturnService instance.
No parameters.
createPurchaseReturn
Creates a purchase return order (PurchaseType::ReturnItem) to a vendor with one or more return lines, via the AxPurchTable / AxPurchLine business-document framework so the order and lines are defaulted and validated the standard way - the purchase counterpart of createSalesReturn. Every line needs a quantity (its size is used; a line without one is refused), and return quantities are stored negative. The standard purchase order entity cannot do this: it only covers PurchaseType::Purch. Idempotent by RequestId.
- Visibility:
public - Returns:
MGCLatticeOrderOperationResponseContractAn MGCLatticeOrderOperationResponseContract carrying the created PurchId, or a failure.
| Name | Type | Optional | Description |
|---|---|---|---|
_request | MGCLatticeCreatePurchaseReturnRequestContract | No | Request with VendAccount, ReturnItemNum (the vendor's RMA number), optional ReturnReasonCodeId, and lines (ItemId, Qty, and SiteId / WarehouseId or InventDimId). |
shipPurchaseReturn
Posts a return shipment (packing slip) for a purchase return order.
- Visibility:
public - Returns:
MGCLatticeOrderOperationResponseContractAn MGCLatticeOrderOperationResponseContract indicating success or failure with details.
| Name | Type | Optional | Description |
|---|---|---|---|
_request | MGCLatticePurchaseReturnShipRequestContract | No | The request containing PurchaseOrderId, PostingDate, and standard header fields. |
creditPurchaseReturn
Posts a credit note (invoice) for a purchase return order.
- Visibility:
public - Returns:
MGCLatticeOrderOperationResponseContractAn MGCLatticeOrderOperationResponseContract indicating success or failure with details.
| Name | Type | Optional | Description |
|---|---|---|---|
_request | MGCLatticePurchaseReturnCreditRequestContract | No | The request containing PurchaseOrderId, PostingDate, and standard header fields. |
shipPurchaseReturnBatch
Ships multiple purchase returns in a single bulk operation. A missing (null) item fails on its own as ValidationFailed (addBulkNullItemResult) without stopping the batch.
- Visibility:
public - Returns:
MGCLatticeBulkOperationResponseContractAn MGCLatticeBulkOperationResponseContract containing per-item results.
| Name | Type | Optional | Description |
|---|---|---|---|
_requests | List | No | List of MGCLatticePurchaseReturnShipRequestContract. |
creditPurchaseReturnBatch
Credits multiple purchase returns in a single bulk operation. A missing (null) item fails on its own as ValidationFailed (addBulkNullItemResult) without stopping the batch.
- Visibility:
public - Returns:
MGCLatticeBulkOperationResponseContractAn MGCLatticeBulkOperationResponseContract containing per-item results.
| Name | Type | Optional | Description |
|---|---|---|---|
_requests | List | No | List of MGCLatticePurchaseReturnCreditRequestContract. |
createPurchaseReturnBatch
Creates multiple purchase return orders in a single bulk operation. A missing (null) item fails on its own as ValidationFailed (addBulkNullItemResult) without stopping the batch.
- Visibility:
public - Returns:
MGCLatticeBulkOperationResponseContractAn MGCLatticeBulkOperationResponseContract containing per-item results.
| Name | Type | Optional | Description |
|---|---|---|---|
_requests | List | No | List of MGCLatticeCreatePurchaseReturnRequestContract. |