FlowmageDocs

Get time off balance

BetaReads data

Reads a HiBob employee's leave balance on a date.

Settings

SettingWhat it is
ConnectionRequiredThe HiBob connection the step signs in with.
Employee idRequiredPicked from the list HiBob offers.
Policy typeRequiredThe name Bob gives the leave type, exactly as the List time off policy types node spells it.
On dateRequiredYYYY-MM-DD. The balance is the one that holds on that day, accruals to date included.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `hibob`)
employeeIdtexta value from the vendor's own list
policyTypetext
datetext

Output

FieldType
balanceBalance, as Bob answered itobject
totalBalanceAsOfDateBalance on that datenumber
startingBalancenumber
totalTakenTakennumber
totalAdminAdjustmentsAdjusted by an adminnumber
totalSystemAdjustmentsAdjusted by Bobnumber
annualAllowancenumber
currentAssignmentAssigned or Unassigned — Unassigned means the person was not on this policystring
Sample output, and the expression for each field
  • annualAllowance25
  • balance
    • policy"Holiday 25"
  • currentAssignment"Assigned"
  • startingBalance25
  • totalAdminAdjustments0
  • totalBalanceAsOfDate12.5
  • totalSystemAdjustments0
  • totalTaken12.5

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "connection": "<connection id>",
    "date": "<on date>",
    "employeeId": "<employee id>",
    "policyType": "<policy type>"
  },
  "label": "Get time off balance",
  "type": "hibob.getTimeOffBalance",
  "version": 1
}