balance
API resource to retrieve employee absence balance information.
Method GET
Path: /balance/{emplid}/{emplrcd}
| Request Parameters | Description |
|---|---|
|
emplid |
Employee ID |
|
emplrcd |
Employee record |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
asofdate |
Success |
Absence balance as of date. |
|
balance |
Success |
Absence balance. |
|
balancestring |
Success |
Absence balance string. |
|
entbalname |
Success |
Absence entitlement balance name. |
|
entbalnbr |
Success |
Absence entitlement balance number. |
|
msgout |
Success |
Message out. This is the message returned after the API is executed. |
|
unittype |
Success |
Unit type for absence balance (days, hours). |
Method: GET
Path: /balance/{emplid}/{emplrcd}/{pintakenum}
Get the employee's current absence balance for the given absence type.
| Request Parameters | Description |
|---|---|
|
emplid |
Employee ID. |
|
emplrcd |
Employee record. |
|
pintakenum |
Pin take number. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
asofdate |
Success |
Absence balance as of date. |
|
balance |
Success |
Absence balance. |
|
balancestring |
Success |
Absence balance string. |
|
entbalname |
Success |
Absence entitlement balance name. |
|
entbalnbr |
Success |
Absence entitlement balance number. |
|
msgout |
Success |
Message out. This is the message returned after the API is executed. |
|
unittype |
Success |
Unit type for absence balance (days, hours). |
Method: GET
Path: /balance/{emplid}/{emplrcd}/{pintakenum}/{fcstdate}
Get the employee's future absence balance for the given absence type.
| Request Parameters | Description |
|---|---|
|
emplid |
Employee ID. |
|
emplrcd |
Employee record. |
|
fcstdate |
Forecast date. |
|
pintakenum |
Pin take number. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
asofdate |
Success |
Absence balance as of date. |
|
balance |
Success |
Absence balance. |
|
balancestring |
Success |
Absence balance string. |
|
entbalname |
Success |
Absence entitlement balance name. |
|
entbalnbr |
Success |
Absence entitlement balance number. |
|
msgout |
Success |
Message out. This is the message returned after the API is executed. |
|
unittype |
Success |
Unit type for absence balance (days, hours). |