Get Employee Balance List

get

https://api.data-basics.net/apihub/apis/getEmployeeBalanceList

Get paged data of EmployeeBalance

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

effectiveDate

string

Effective Date/Period Start Date - Format YYYY-MM-DD

emplyId

string

Employee ID the leave accrual applies to. Max 20 characters. A valid employee ID must exist in the Employee table

payCodeGrp

string

Time Code Group ID that the leave balance applies to - Max size 20 Characters. A valid value must exist in the PayCodeGrp table

manualAdded

number

Leave Hours Adjustments. Max size 9 characters. Format XX.00

lastUpdate

string

Used to analyze if timesheet was updated and balance need to be changed. YYYY-MM-DD

lockedStatus

string

Locked Status = Y - Locked and N - Locked. No changes are applied to locked periods.

text

string

Full-Text Search Lookup typically returns matches of name or ID.

takenPrevPeriod

number

Hours taken last period

postedBankHours

number

Posted Bank hours applied to this period. Max size 9 characters. Format XX.00

unpaidDaysNumber

number

Unpaid Number of Days

notes

string

Optional notes. Max size 1000 characters.

accrualPeriod

number

Accrual Hours for period. Max size 9 characters. Format XX.00

enteredBy

string

Entered by- Who inserted/updated balance from profile or in admin. Max size 20 characters. A valid ID must exist in the employee table.

carryOver

number

Leave Carry Over, used if carry over from previous year exists. Sets to 0 when carry over expires.. Format XX.00, Max size 10 characters.

sysNotes

string

Internal System Message

leaveSource

string

Leave Source Code - Manually or Computed. Used to analyze if timesheet was updated and balance need to be changed. Max size 5 characters

compHours

number

Used only for comp time, hours eligible for comp accrual

dtstamp

string

When balance was inserted/updated.

noHours

number

Number of Leave Hours, number of characters 9. Format XX.00

noLimitHours

number

Number of Limited Hours. it is used with Keep Accrual, to restore balance if user took hours and balance became less than limit, if there is no keep accrual it is the same as the NoHours. Max size 9 characters, format XX.00

limit

integer

Return number of records per page. Default page size is 20 rows. If you want to run 100 rows per page set it to 100. Max is 1000 per page.

start

integer

Start defines which record to begin from in the response. If the response has 20 records and you only want to return the last 10, then set the start equal to 9 to only return records 10 through 20.

Response

200successful operation