all data is live and searchable
« Back . [api documentation and samples] . [view sample]
Main Web API Documentation Information
Actual Page/Function Name:
updateMainInvoiceAmount
Human Readable Name or Caption:
Update Main Invoice Amount
Page/Function Description:
This method will update the main invoice amount and record a quick history.
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
CORP_ID Numeric 0 Pass in the corp id number. Yes
Arguments INVOICE_AMOUNT Numeric 0 Pass in the new invoice amount. Yes
Arguments INVOICE_NUMBER Numeric 0 Pass in the invoice number. Yes
Arguments PAYEE_ID Numeric 0 Pass in the payee id number of the person doing the action. 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 main invoice amount. Missing some data. Use your back button and try again. This is returned if missing one or more of the following arguments: CORP_ID, INVOICE_NUMBER, PAYEE_ID.
dataIn2 Unable to update the main invoice amount. Missing the date/time stamp. Use your back button and try again. This is returned if argument ADJUSTED_DATE_TIME is not a date.
db Unable to connect to the database. The main invoice amount 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":"updatemaininvoiceamount","ADJUSTED_DATE_TIME":"7/6/2015 2:37 PM","CORP_ID":53,"INVOICE_AMOUNT":100.25,"INVOICE_NUMBER":10,"PAYEE_ID":178,"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"}