From 8630481a0759a9fb2b31c86e5bfa774bef4d4184 Mon Sep 17 00:00:00 2001
From: SergeySkryabinP <167517734+SergeySkryabinP@users.noreply.github.com>
Date: Mon, 22 Apr 2024 15:01:21 +0200
Subject: [PATCH] Deprecate vacation_day_balance and add available_balance
 attribute to employee's Public API endpoint (#186)

* [ABSPOL-812] Deprecate vacation_day_balance and add available_balance attribute to employee's Public API endpoint
---
 personio-personnel-data-api-oa3.yaml | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/personio-personnel-data-api-oa3.yaml b/personio-personnel-data-api-oa3.yaml
index f69ef0f..2ab8225 100644
--- a/personio-personnel-data-api-oa3.yaml
+++ b/personio-personnel-data-api-oa3.yaml
@@ -3773,6 +3773,8 @@ components:
               type: string
         vacation_day_balance:
           type: object
+          deprecated: true
+          description: Substituted by available_balance in EmployeeAbsenceBalance
           properties:
             label:
               example: Vacation day balance
@@ -3889,7 +3891,15 @@ components:
                 example: custom_absence
               balance:
                 type: number
+                description: >
+                  Effective balance, as of request date; not deducting any upcoming absence periods,
+                  but only what has been taken. If the absence period is currently ongoing,
+                  the effective balance only considers the part of the period until today.
                 example: 10.5
+              available_balance:
+                type: number
+                description: Available balance is what actually left to be planned (where upcoming absence periods are already deducted).
+                example: 8.5
 
     Project:
       type: object