Main Web API Documentation Information
|
|
Actual Page/Function Name:
|
updatePOLineItem |
Human Readable Name or Caption:
|
Update PO Line Item |
Page/Function Description:
|
This method will update a PO line item. |
Page/Function Output Type:
|
API - JSON or WDDX |
Categories:
|
purchase order |
Extra Page/Function Notes:
|
Parameters
|
|||||||
Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
Arguments | ADJUSTED_DATE_TIME | String | Pass in th adjusted date/time stamp. | Yes | |||
Arguments | CORP_ID | Numeric | 0 | Pass in the corp id number. | Yes | ||
Arguments | FORMATTED_ITEM_COST | String | Pass in the formatted item cost. | Yes | |||
Arguments | FORMATTED_LINE_QUANTITY | String | Pass in the formatted line quantity. | Yes | |||
Arguments | FORMATTED_OLD_ITEM_COST | String | Pass in the formatted old item cost. | Yes | |||
Arguments | FORMATTED_REQUEST_QUANTITY | String | Pass in the formatted request quantity. | Yes | |||
Arguments | ITEM_COST | Numeric | 0 | Pass in the item cost. | Yes | ||
Arguments | LINE_DESCRIPTION | String | Pass in the line description. | Yes | |||
Arguments | LINE_ITEM_SORT | Numeric | 0 | Pass in the line item sort value. | Yes | ||
Arguments | LINE_QUANTITY | Numeric | 0 | Pass in the line quantity. | Yes | ||
Arguments | LINE_RF_ID_TAG_NUMBER | String | Pass in the line specific control/RFID tag number. | Yes | |||
Arguments | LINE_SHOW | Numeric | 0 | Pass in a 1 for show and a 0 for hide. | Yes | ||
Arguments | OLD_ITEM_COST | Numeric | 0 | Pass in the old item cost. | Yes | ||
Arguments | PART_ID | Numeric | 0 | Pass in the part id number. | Yes | ||
Arguments | PART_NUMBER | String | Pass in the correct part number. | Yes | |||
Arguments | PAYEE_ID | Numeric | 0 | Pass in the payee id number of the person doing the insert. | Yes | ||
Arguments | PO_INVOICE_LINE_ID | Numeric | 0 | Pass in the line id number. | Yes | ||
Arguments | PO_NUMBER | Numeric | 0 | Pass in the correct main PO number for the line item. | Yes | ||
Arguments | REQUEST_QUANTITY | Numeric | 0 | Pass in the request quantity. | Yes | ||
Arguments | ROUNDING_ERROR_VALUE | String | auto | Pass in the plus or minus rounding error value. You may also use the keyword "auto" to have the system figure out the rounding error, if any. | Yes | ||
Arguments | STORE_ID | Numeric | 0 | Pass in the location id. | Yes | ||
Arguments | VENDOR_PAYEE_ID | Numeric | 0 | Pass in the correct vendor id number. | Yes |
Results
|
||||
RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
ok | success | This assumes that everything went well. | ||
dataIn | Unable to update the PO line item. Missing some data. | Use your back button and try again. | This is returned if missing one or more of the following arguments: CORP_ID, ITEM_COST, LINE_DESCRIPTION, LINE_ITEM_SORT, LINE_SHOW, PART_ID, PART_NUMBER, PAYEE_ID, PO_INVOICE_LINE_ID, PO_NUMBER, STORE_ID, VENDOR_PAYEE_ID. | |
dataIn2 | Unable to update the PO line item. Missing the date information. | Use your back button and try again. | This is returned if ADJUSTED_DATE_TIME is not a date. | |
decimalValue | Unable to update the PO line item. One or more values is over the maximum. See note below. | One or more of the values is over +/- 99,999,999.99 (+/- ninety-nine million). Check the values (including any math) and try again. You may need to break the items into smaller parts or pieces. | This is returned if temp_line_quantity or temp_cost is greater than +/- 99,999,99.99999, or if temp_cost_extended is greater than +/- 99,999,999.99. | |
db | Unable to connect to the database. The PO line item was not updated in the database. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. |
Samples
|
|
Caption | Text |
JSON |
{
"API_CALL_FUNCTION_NAME": "updatePOLineItem",
"ADJUSTED_DATE_TIME": "2025-08-04 10:29:00",
"CORP_ID": 53,
"FORMATTED_ITEM_COST": "0.30",
"FORMATTED_LINE_QUANTITY": "10",
"FORMATTED_OLD_ITEM_COST": "0.28",
"FORMATTED_REQUEST_QUANTITY": "12",
"ITEM_COST": 0.30,
"LINE_DESCRIPTION": "EPS 1.0 LB Density for Door Type A",
"LINE_ITEM_SORT": 1,
"LINE_QUANTITY": 10,
"LINE_RF_ID_TAG_NUMBER": "RFID123",
"LINE_SHOW": 1,
"OLD_ITEM_COST": 0.28,
"PART_ID": 123,
"PART_NUMBER": "EPS001",
"PAYEE_ID": 5130,
"PO_INVOICE_LINE_ID": 456,
"PO_NUMBER": 123,
"REQUEST_QUANTITY": 12,
"ROUNDING_ERROR_VALUE": "auto",
"STORE_ID": 178,
"VENDOR_PAYEE_ID": 3,
"API_CORP_KEY_ID": "PLA-0053",
"API_USER_NAME": "demo",
"API_USER_PASSWORD": "1234",
"API_INPUT_OUTPUT_TYPE": "JSON",
"API_CURRENT_PAYEE_ID": "3",
"API_URL_ENCODING": "AUTO"
}
|