MODFIN-382 - Add dry-run mode for bulk FY finance updates (#496)

* [MODFIN-382] - Add update type to finance data for dry-run mode * [MODFIN-382] - Add update type to finance data for dry-run mode * Update budgetAfter Allocation field
folio-org · Dec 20, 2024 · 38ee053 · 38ee053
1 parent a8f2fef
commit 38ee053
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/mod-finance/examples/fy_finance_data_collection_put.sample b/mod-finance/examples/fy_finance_data_collection_put.sample
@@ -21,6 +21,7 @@
       "budgetAllocationChange": -50000,
       "budgetAllowableExpenditure": 80,
       "budgetAllowableEncumbrance": 90,
+      "budgetAfterAllocation": 950000,
       "budgetAcqUnitIds": ["123e4567-e89b-12d3-a456-426614174008"],
       "groupId": "123e4567-e89b-12d3-a456-426614174025",
       "groupCode": "GRP001",
@@ -50,6 +51,7 @@
       "budgetAllocationChange": -50000,
       "budgetAllowableExpenditure": 70,
       "budgetAllowableEncumbrance": 85,
+      "budgetAfterAllocation": 450000,
       "budgetAcqUnitIds": ["123e4567-e89b-12d3-a456-426614174009"],
       "groupId": "123e4567-e89b-12d3-a456-426614174026",
       "groupCode": "GRP002",
@@ -59,5 +61,6 @@
       }
     }
   ],
+  "updateType": "Commit",
   "totalRecords": 2
 }
diff --git a/mod-finance/schemas/fy_finance_data.json b/mod-finance/schemas/fy_finance_data.json
@@ -93,6 +93,10 @@
       "description": "The encumbrance percentage limit for this budget",
       "type": "number"
     },
+    "budgetAfterAllocation": {
+      "description": "The amount of the budget after the allocation",
+      "type": "number"
+    },
     "budgetAcqUnitIds": {
       "description": "List of acquisition unit IDs associated with the budget",
       "type": "array",

diff --git a/mod-finance/schemas/fy_finance_data_collection.json b/mod-finance/schemas/fy_finance_data_collection.json
@@ -12,6 +12,14 @@
         "$ref": "fy_finance_data.json"
       }
     },
+    "updateType": {
+      "description": "The type of update being performed",
+      "type": "string",
+      "enum": [
+        "Preview",
+        "Commit"
+      ]
+    },
     "totalRecords": {
       "description": "The number of objects contained in this collection",
       "type": "integer"
@@ -20,6 +28,7 @@
   "additionalProperties": false,
   "required": [
     "fyFinanceData",
+    "updateType",
     "totalRecords"
   ]
 }