Function
The Purchase Order (PO) Schedule Edit API is used to edit scheduling information in POs.
URL
{Root URL}/API/PO/ScheduleEdit/{API Key} |
Parameters
| Parameter | Description | Required | Comment |
1 | poNum | Purchase order number | Y |
|
2 | uniqLnNo | PO unique item identifier | Y |
|
3 | schd_date | Schedule date | N | Will default to the current date, or enter the date in the following format: MM-DD-YYYY. |
4 | req_date | Required date | N | Will default to the current date, or enter the date in the following format: MM-DD-YYYY. |
5 | schd_qty | Scheduled quantity | Y | Must be equal to or less than the order quantity. |
6 | warehouse | Warehouse | N | The warehouse where the item will be received. |
7 | location | Warehouse location | N | Used with warehouse to designate a location. |
8 | origcommitdt | Commit date | N | Will default to the current date, or enter the date in the following format: MM-DD-YYYY. |
9 | schdNotes | Schedule notes | N | Can be used to attach a schedule note to the PO. |
10 | GL_NBR | General Ledger account number | N |
|
11 | REQUESTOR | Name of requestor | N |
|
12 | WOPRJNUMBER | WO or Project number scheduled qtys will be allocated to upon receipt | N |
|
Example Strings
PO Schedule Edit Quantity
URL
?poNum=PONUMBER&uniqDetNo=UNIQDETNO&SCHD_QTY=QTY |
JSON
{ "poNum":"PONUMBER", "uniqLnNo":"UNIQLNNO", "SCHD_QTY":"QTY", } |
A successful add should result in the following:
{ "$id": "1", "Code": "200", "Message": "PO Schedule edited successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Common Errors
API Key Error
If there is an error with the API key, the system will return an error message describing it:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
URL Error
If there is an error with the URL, the system will return a not found HTTP error:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleAdd/123456789'.", "MessageDetail": "No type was found that matches the controller named 'POScheduleAdd'." } |
Missing Parameter
If a required parameter is missing, the system will return an error detailing which parameter is required:
{ "$id": "1", "Code": "403", "Message": "PO Schedule edit failed.UNIQDETNO is required.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |