all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
updateMainInvoice |
|
Human Readable Name or Caption:
|
Update Main Invoice |
|
Page/Function Description:
|
This method will update the main invoice details for a single invoice. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
invoice |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | ADJUSTED_DATE_TIME | String | Pass in the adjusted date/time stamp. | Yes | |||
| Arguments | CORP_ID | Numeric | 0 | Pass in the corp id number. | Yes | ||
| Arguments | CUSTOMER_ID | Numeric | 0 | Pass in the customer id number. | Yes | ||
| Arguments | EXTERNAL_PO_NUMBER | String | Pass in the external PO number. | Yes | |||
| Arguments | INVOICE_AMOUNT | Numeric | 0 | Pass in the invoice amount. | Yes | ||
| Arguments | INVOICE_DATE | String | Pass in the invoice date. | Yes | |||
| Arguments | INVOICE_NOTES | String | Pass in the general invoice notes. | Yes | |||
| Arguments | INVOICE_NUMBER | Numeric | 0 | Pass in the invoice number. | Yes | ||
| Arguments | INVOICE_TYPE_ID | Numeric | 0 | Pass in the invoice type id number. | Yes | ||
| Arguments | OLD_CUSTOMER_ID | Numeric | 0 | Pass in the old customer id number. | Yes | ||
| Arguments | OLD_INVOICE_DATE | String | Pass in the old invoice date. | Yes | |||
| Arguments | OLD_INVOICE_TYPE_ID | Numeric | 0 | Pass in the old invoice type id number. | Yes | ||
| Arguments | OLD_OTHER_STORE_ID | Numeric | 0 | Pass in the old other location id number. | Yes | ||
| Arguments | OLD_STORE_ID | Numeric | 0 | Pass in the old location id number. | Yes | ||
| Arguments | OTHER_SALESPERSON_ID | Numeric | 0 | Pass in the other salesperson id number. | Yes | ||
| Arguments | OTHER_STORE_ID | Numeric | 0 | Pass in the other location id number. | Yes | ||
| Arguments | PAYEE_ID | Numeric | 0 | Pass in the payee id of who is doing the action. | Yes | ||
| Arguments | PRINTABLE_INVOICE_NOTES | String | Pass in the printable invoice notes. | Yes | |||
| Arguments | SALESPERSON_ID | Numeric | 0 | Pass in the salesperson id number. | Yes | ||
| Arguments | STOCK | Numeric | 0 | Pass in the internal stock number if any. | Yes | ||
| Arguments | STOCK_UNIT_LIST | String | Pass in the stock numbers used as line items. | Yes | |||
| Arguments | STORE_ID | Numeric | 0 | Pass in the main location id number. | Yes | ||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
| ok | Successfully updated the main invoice information. | "Where can we take you? [invoice line items] [printable invoice] [invoice homepage] [new cart] | This assumes that everything went well. | |
| dataIn | Unable to update the main invoice. Missing some data. | Use your back button and try again. | Missing one or more of the arguments: CORP_ID, CUSTOMER_ID, INVOICE_NUMBER, INVOICE_TYPE_ID, OLD_CUSTOMER_ID, OLD_INVOICE_TYPE_ID, OLD_OTHER_STORE_ID, OLD_STORE_ID, OTHER_SALESPERSON_ID, OTHER_STORE_ID, PAYEE_ID, SALESPERSON_ID, STORE_ID | |
| dataIn2 | Unable to update the main invoice. Missing the invoice dates. | Use your back button and try again. | One or more of the following values were not input as dates: INVOICE_DATE, ADJUSTED_DATE_TIME, OLD_INVOICE_DATE | |
| zeroCorp | Unable to find the corporation information requested. | Use your back button and try again. | This is returned if no corporation information could be found for the requested CORP_ID. | |
| corp_customer | Unable to update the main invoice. Check the [name] id number that was submitted. | Unable to find the [name] id you requested assigned to your [corp type]. Use your back button and try again. | This is returned if the requested customer could not be found. | |
| noOldCustomer | Unable to find the old [name] id number in the database. | Use your back button and try again. | This is returned if no information could be found associated with the requested CORP_ID and OLD_CUSTOMER_ID. | |
| noNewCustomer | Unable to find the new [name] id number in the database. | Use your back button and try again. | This is returned if no information could be found associated with the requested CORP_ID and CUSTOMER_ID. | |
| zero | Unable to find the main invoice number requested. | Use your back button and try again. | This is returned if no information could be found associated with the requested CORP_ID and INVOICE_NUMBER. | |
| db | Unable to connect to the database. The main invoice was not updated. | 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":"updatemaininvoice","ADJUSTED_DATE_TIME":"1/1/15 1:00:00 PM","CORP_ID":53,"CUSTOMER_ID":178,"EXTERNAL_PO_NUMBER":"PONumber123","INVOICE_AMOUNT":100,"INVOICE_DATE":"1/1/15","INVOICE_NOTES":"Invoice Notes","INVOICE_NUMBER":4,"INVOICE_TYPE_ID":3,"OLD_CUSTOMER_ID":178,"OLD_INVOICE_DATE":"1/1/15","OLD_INVOICE_TYPE_ID":4,"OLD_OTHER_STORE_ID":178,"OLD_STORE_ID":178,"OTHER_SALESPERSON_ID":178,"OTHER_STORE_ID":20192,"PAYEE_ID":178,"PRINTABLE_INVOICE_NOTES":"Printable Invoice Notes","SALESPERSON_ID":178,"STOCK":5,"STOCK_UNIT_LIST":"Stock, Unit, List","STORE_ID":20192,"API_CORP_KEY_ID":"PLA-0053","API_USER_NAME":"demo","API_USER_PASSWORD":"1234","API_CURRENT_PAYEE_ID":"3","API_INPUT_OUTPUT_TYPE":"JSON","API_URL_ENCODING":"AUTO"}
|