all data is live and searchable
|
Main Web API Documentation Information
|
|
|
Actual Page/Function Name:
|
getPayeePayrollInfo |
|
Human Readable Name or Caption:
|
Get Payee Payroll Info |
|
Page/Function Description:
|
This method will get the payee personal payroll info and pay rates. |
|
Page/Function Output Type:
|
API - JSON or WDDX |
|
Categories:
|
payroll |
|
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. | Yes | ||
| Arguments | DEPARTMENT_ID | Numeric | 0 | Pass in the department id number. | Yes | ||
| Arguments | PAYEE_ID | Numeric | 0 | Pass in the payee id number. | Yes | ||
|
Results
|
||||
| RET_STATUS | RET_MAIN_MESSAGE | RET_SECOND_MESSAGE | Redirect Link | Description |
| ok | success | This assumes that everything went well. | ||
| dataIn | Unable to get payee pay rates and personal payroll information. Missing some data. | Use your back button and try again. | This is returned if missing one or more of the following arguments: CORP_ID, DEPARTMENT_ID, PAYEE_ID. | |
| db | Unable to connect to the database. Missing the payee personal pay rates and information. | Use your back button and try again. | This is a catch for any errors that occur while accessing the database. | |
| zero | Unable to find a matching payee in the database. | Use your back button and try again. | This is returned if no pay rates could be found associated with the CORP_ID, DEPARTMENT_ID, and PAYEE_ID. | |
|
Samples
|
|
| Caption | Text |
| JSON |
{
"API_CALL_FUNCTION_NAME": "getPayeePayrollInfo",
"CORP_ID": 53,
"DEPARTMENT_ID": 138,
"PAYEE_ID": 3191,
"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"
}
|