api/WIPCompletionsEntry/CreateAndBackflush (POST)
Creates a new WIP Completions Entry Transaction and Kit Issue Backflush Transaction using the supplied creation data.
HTTP Method: POST
Required Fields: JOB_ID
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns the created WIP Completions Entry Transaction and any transacted Kit Issue Backflush Components.
This API call can automatically perform a Kit Issue Backflush transaction in conjunction with a WIP Completions transaction. To do this the WIP Completions transaction must refer to a Task where a Kit Issue Backflush is possible.
It is not strictly necessary to include the WIPCompletionsEntryBackflushComponent array in the request JSON. However, this array should be used if it is necessary to specify a LOT_ID, STOCK_LOCATION or SERIAL_NUMBER for any of the Backflush Components. It is only necessary to list the Backflush Components for which you need to specify any of these items. All eligible Components will be included in the Kit Issue Backflush transaction automatically.
This API call uses the Kit/Shortage Issue program (ICTKI) to perform the Kit Issue Backflush. Therefore, the API user must have Run Permission for ICTKI in order to perform a Kit Issue Backflush in conjunction with this API call.
If there is any error in the WIP Completions transaction or the Kit Issue Backflush transaction, then neither transaction will be committed to the database. There is no error if the Task referred to in the WIP Completions transaction is not capable of a Kit Issue Backflush.
All transacted Kit Issue Backflush Components are listed in the WIPCompletionsEntryBackflushComponent array in the response JSON.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing WIP Completions Entry Transaction creation data.
Create WIP Completions Entry Transaction Example:
{
"WIPCompletionsEntry": {
"JOB_ID": "000958",
"ACTION_TYPE": "TC",
"FROM_TASK": "10",
"STORES_CODE": "MS",
"QUANTITY": "5",
"SERIAL_NUMBER": "GC00004057:GC00004060,GC00004062"
},
"WIPCompletionsEntryBackflushComponent": [
{
"COMPONENT_ID": "MOUNT007",
"LOT_ID": "MTR3-007-42",
"STOCK_LOCATION": "ISLE 12/SHELF 1",
"SERIAL_NUMBER": "JX00005140:JX00005143,JX00005145"
}
]
}
Returns 1 WIP Completions Entry Transaction and any transacted Kit Issue Backflush Components if successful.
SERIAL_NUMBER can contain a single Serial Number.
SERIAL_NUMBER can contain multiple Serial Numbers separated by commas.
SERIAL_NUMBER can contain a range of Serial Numbers separated by a colon.
SERIAL_NUMBER can contain any combination of ranges and single Serial Numbers spearated by commas.
Accepted WIP Completions Entry Fields:
ACTION_DATE, ACTION_TYPE, BATCH_NUMBER, EXPIRE_DATE,
FROM_TASK, GL_MONTH, GL_YEAR, JOB_ID,
LOT_ID, MULTI_LOC, QUANTITY, REASON_CODE,
REFERENCE, SERIAL_NUMBER, STOCK_LOCATION, STORES_CODE,
TO_JOB_ID, TO_TASK
Accepted WIP Completions Entry Backflush Component Fields:
COMPONENT_ID, LOT_ID, SERIAL_NUMBER, STOCK_LOCATION |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON object with created WIP Completions Entry Transaction.
Error:
400/Request JSON is invalid.
400/Request has no Transaction Body.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.
Returned WIP Completions Entry Fields:
ACTION_DATE, ACTION_TYPE, BATCH_NUMBER, DELIVER_TO, EXPIRE_DATE, FROM_TASK, GL_MONTH, GL_YEAR, JOB_DESC, JOB_ID, JOB_UM, LOT_ID, MULTI_LOC, ON_HAND_QTY, PART_DESC, PART_ID, QUANTITY, REASON_CODE, REFERENCE, SERIAL_NUMBER, STOCK_LOCATION, STORES_CODE, TASK_DESC, TO_JOB_ID, TO_TASK, TOTAL_STD_COST, TXNS_ACCEPTED
Returned WIP Completions Entry Backflush Component Fields:
ACCOUNT, BALANCE_DUE, COMPANY_ID, COMPONENT_ID, DATE_LAST_ACT, DEPARTMENT, ISSUED_QTY, KIT_PRINT_DATE, KIT_QTY, KIT_STORES, LOT_ID, REFERENCE, SCH_KIT_DATE, SERIAL_NUMBER, STOCK_LOCATION