all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
addInvoiceHistory |
|
Human Readable Name or Caption:
|
Add Invoice History |
|
Page/Function Description:
|
This method will add a history note for an invoice. We highly recommend that this gets used any time an invoice gets created or altered. It's like a miniature audit trail. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
eComm,invoice |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | CORP_ID | Numeric | 0 | Pass in the corp id number. This is your corporation ID or your business world number. This is required and will be validated. The default is 0, but will be checked for a real number. | Yes | ||
| Arguments | HISTORY_DATE_TIME | String | Pass in the date/time stamp. | Yes | |||
| Arguments | HISTORY_FLAG_ID | Numeric | 2 or 3. See notes. | Pass in the history flag id number. 2=New/Add, 3=Edit/Update, 4=Lock, 5=Unlock, 6=Delete, 7=Quote, 8=Sale, 9=Void, 10=Posted, 11=Printed, 12=Assigned, 13=Removed. | Yes | ||
| Arguments | HISTORY_NOTE | String | Pass in the history note. This has a maximum of 150 characters, but we usually record any sort of details that can help recreate the story (a line item that was changed, an amount or status that was altered, etc). | Yes | |||
| Arguments | INVOICE_NUMBER | Numeric | 0 | Pass in the invoice number. This is the tie-in with the invoice that this history message is connected with. | Yes | ||
| Arguments | PAYEE_ID | Numeric | 0 | Pass in the payee user id of the person adding the history note. This id number will be used for a history message of who added the record. If this is not passed in, it will default to whoever the main payee/user id is that is using the method. | Yes | ||
|
Results
|
||||||||||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description | ||||||||
| ok | success | This assumes that everything went well. | ||||||||||
|
||||||||||||
| dataIn | Unable to add the invoice history note. Missing some data. | Use your back button and try again. | This is returned if the corp id, history flag id, history note, invoice number, or payee id is missing. | |||||||||
| dataIn2 | Unable to update the invoice history. Missing the date/time stamp. | Use your back button and try again. | This is returned if the history date time is not a date. | |||||||||
| db | Unable to connect to the database. Invoice history was not added correctly. | Use your back button and try again. | This is returned if there was an error inserting the corp id, history date time, history flag id, history note, invoice number, or payee id into the database. | |||||||||
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_CALL_FUNCTION_NAME":"addinvoicehistory","CORP_ID":53,"HISTORY_DATE_TIME":"2015/03/24 11:54:00 am","HISTORY_FLAG_ID":2,"HISTORY_NOTE":"Hello","INVOICE_NUMBER":78,"PAYEE_ID":3,"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"}
|