all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
addcustomertoqueue |
|
Human Readable Name or Caption:
|
Add Customer to Queue |
|
Page/Function Description:
|
This method will add a customer to a specific queue |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
invoice,quote,customer |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | CUSTOMER_ID | Numeric | 0 | Pass in the customer id number to add customer to the queue. | Yes | ||
| Arguments | QUEUE_NOTES | String | Pass in the queue notes. It can be up to 255 characters long. OK to leave blank. | Yes | |||
| Arguments | SUB_QUEUE_ID | Numeric | 1 | Pass in the sub queue id number. Use the value of 1 if unknown. Use the getSubQueueDetails API to get sub queue id number. | Yes | ||
| Arguments | QUEUE_TYPE_ID | Numeric | 2 | Pass in the queue type id. 1=Dummy, 2=Started/Waiting, 3=Invoiced, 4=Quoted, 5=Auto Closed/Finished, 6=Manual Closed/Finished, 7=Tied To Time, 8=In Progress, 9=Closed/Finished, 10=Pending/Other. If unknown, use 2. | Yes | ||
| Arguments | INVOICE_NUMBER | Numeric | 0 | Pass in the invoice number. If unknown use 0. | Yes | ||
| Arguments | QUOTE_NUMBER | Numeric | 0 | Pass in the quote number. If unknown use 0. | Yes | ||
| Arguments | TIME_ID | Numeric | 0 | Pass in the time id. If unknown use 0. | Yes | ||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_CALL_FUNCTION_NAME":"addCustomerToQueue","API_USER_PASSWORD":1234,"API_URL_ENCODING":"AUTO","API_INPUT_OUTPUT_TYPE":"JSON","CUSTOMER_ID":311105,"INVOICE_NUMBER":0,"API_CURRENT_PAYEE_ID":3191,"API_USER_NAME":"DEMO","SUB_QUEUE_ID":2,"QUOTE_NUMBER":3023,"API_CORP_KEY_ID":"PLA-0053","TIME_ID":0,"QUEUE_NOTES":"notes go here","QUEUE_TYPE_ID":2}
|