|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
getPurchaseOrders |
|
Human Readable Name or Caption:
|
Get Purchase Orders |
|
Page/Function Description:
|
Get's all purchase orders and line items by date range and or vendor id. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
purchase order,general |
|
Extra Page/Function Notes:
|
|
|
Parameters
|
|||||||
| Scope | Name | Type | Default | Description | Required | Alternates | Known Values |
| CORP_ID | Numeric | 0 | Pass in corp id. | Yes | |||
| Arguments | FROM_DATE | Numeric | 01/01/100 | Get's po's after from date. | Yes | ||
| Arguments | TO_DATE | Numeric | The time the request is made. | Get's all po's before to date. | Yes | ||
| Arguments | INCLUDE_LINE_ITEMS | Numeric | 0 | Pass in a 1 to include po line items. | Yes | ||
| Arguments | VENDOR_ID | Numeric | 0 | Pass in a vendor id. | Yes | ||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
|
Samples
|
|
| Caption | Text |
| JSON |
{
"API_CALL_FUNCTION_NAME": "getPurchaseOrders",
"CORP_ID": 53,
"FROM_DATE": "20250101",
"TO_DATE": "20250806",
"INCLUDE_LINE_ITEMS": 1,
"VENDOR_ID": 1234,
"API_CORP_KEY_ID": "PLA-0053",
"API_USER_NAME": "demo",
"API_USER_PASSWORD": "1234",
"API_INPUT_OUTPUT_TYPE": "JSON",
"API_CURRENT_PAYEE_ID": "3191",
"API_URL_ENCODING": "AUTO"
}
|