Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The HiBob connection the step signs in with. |
| Employee idRequired | Picked from the list HiBob offers. |
| Policy typeRequired | The name Bob gives the leave type, exactly as the List time off policy types node spells it. |
| On dateRequired | YYYY-MM-DD. The balance is the one that holds on that day, accruals to date included. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `hibob`) |
employeeId | texta value from the vendor's own list |
policyType | text |
date | text |
Output
| Field | Type |
|---|---|
balanceBalance, as Bob answered it | object |
totalBalanceAsOfDateBalance on that date | number |
startingBalance | number |
totalTakenTaken | number |
totalAdminAdjustmentsAdjusted by an admin | number |
totalSystemAdjustmentsAdjusted by Bob | number |
annualAllowance | number |
currentAssignmentAssigned or Unassigned — Unassigned means the person was not on this policy | string |
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
}