all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
getAllVendors |
|
Human Readable Name or Caption:
|
Get All Vendors |
|
Page/Function Description:
|
This will return a list of all vendors by a specified corp id. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
general |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| Arguments | CORP_ID | Numeric | 0 | Pass in the corp id. | Yes | ||
| INCLUDE_INACTIVE | Numeric | 0 | Pass in a 1 to also include inactive records. | Yes | |||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
| ok | success | none | ||
|
Samples
|
|
| Caption | Text |
| JSON |
{"API_CALL_FUNCTION_NAME":"getAllVendors","API_USER_PASSWORD":1234,"API_CORP_KEY_ID":"PLA-0053","API_URL_ENCODING":"AUTO","API_INPUT_OUTPUT_TYPE":"JSON","CORP_ID":53,"API_CURRENT_PAYEE_ID":3,"API_USER_NAME":"demo"}
|