Check Balances or Get Vacation Policy

/getBalance

Returns detailed balance information for an employee, including vacation days, PTO, and other time-off related data across different policy cycles. Can also be used to get applied Vacation policy data.

Request parameters

{
  "employeeSnapshotOrId": "example",
  "arbitraryDate": "1970-01-14",
  "employeeStartDate": "1970-01-14",
  "employeePayType": "Salary",
  "vacationPolicyDataOrId": "example",
  "timeOffRequests": [
    {
      "employee": "example",
      "startDate": "1970-01-14",
      "endDate": "1970-01-14",
      "type": "Paid Vacation",
      "status": "pending",
      "fiveDaysNotPaid": true,
      "halfDay": true,
      "sickDayPaid": true,
      "holidays": [
        {
          "date": "1970-01-14",
          "name": "example",
          "isPaid": true,
          "unpaidAsPTO": true,
          "holidayRef": "example"
        }
      ],
      "notes": "example"
    }
  ],
  "balanceAdjustments": [
    {
      "type": "adjust",
      "days": 87,
      "notes": "example",
      "adjustedAt": "1971-04-26T12:26:06Z",
      "adjustedById": "example",
      "cycleStartDate": "1970-01-14",
      "fromCycle": "1970-01-14",
      "toCycle": "1970-01-14"
    }
  ]
}

Responses

{
  "thisCycleStart": "1970-01-14",
  "thisCycleEnd": "1970-01-14",
  "nextCycleStart": "1970-01-14",
  "nextCycleEnd": "1970-01-14",
  "policyPtoAllowanceThisCycle": 87,
  "adjustmentsThisCycle": 87,
  "totalPtoAllowanceThisCycle": 87,
  "ptoTakenThisCycle": 87,
  "remainingPtoThisCycle": 87,
  "utoTakenThisCycle": 87,
  "policyPtoAllowanceNextCycle": 87,
  "adjustmentsNextCycle": 87,
  "totalPtoAllowanceNextCycle": 87,
  "ptoTakenNextCycle": 87,
  "remainingPtoNextCycle": 87,
  "utoTakenNextCycle": 87,
  "nextPtoUpgradeDate": "1970-01-14",
  "nextPtoUpgradeValue": 87
}

Authentication

Use a bearer token for authentication. The API key can be found in our Firestore collection.

26 March 2025