system.mes.inventory.newUnconsumeRequest
Description
Generates an empty Unconsume Request to provide the structure required by the API to save a new record into the database. This method must be combined with the unconsume method in order to persist the record.
Permissions
This method does not require any permissions.
Syntax
system.mes.inventory.newUnconsumeRequest()
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
| None | - | - | This method does not take any parameters. |
Returns
Returns a JSON representation of the newly created Unconsume Request object. The following is a list of keys and default values:
| Key | Default Value |
|---|---|
type | UNCONSUME |
quantity | null |
unitOfMeasureSymbol | null |
lotIdOrName | null |
materialIdOrPath | null |
destinationLocationIdOrPath | null |
sourceLocationIdOrPath | null |
operationId | null |
inventoryOperationId | null |
productionOrderIdOrName | null |
materialReasonCodeId | null |
startDate | Current Time |
endDate | null |
ongoing | false |
inventoryName | null |
notes | null |
spare1 | null |
spare2 | null |
spare3 | null |
Code Examples
# Generate the object structure for a new unconsume request object with no initial arguments
newRequest = system.mes.inventory.newUnconsumeRequest()
# Set basic attributes for the new unconsume request
newRequest['materialIdOrPath'] = 'Bottle/Milk'
newRequest['destinationLocationIdOrPath'] = 'DairyCo'
newRequest['quantity'] = 610
# (You can continue setting other properties as needed here)
# Unconsume the request
unconsumedRequest = system.mes.inventory.unconsume(**newRequest)
# Output the JSON representation of the unconsumed request
print(unconsumedRequest)