Merge branch 'master' of https://github.com/folio-org/acq-models

folio-org · Oct 14, 2024 · 42b4c14 · 42b4c14
2 parents 4ab02c9 + d117c82
commit 42b4c14
Show file tree

Hide file tree

Showing 37 changed files with 234 additions and 9 deletions.
diff --git a/mod-finance/examples/budget.sample b/mod-finance/examples/budget.sample
@@ -8,6 +8,7 @@
   "netTransfers": 0,
   "awaitingPayment": 3500,
   "available": 10000,
+  "credits": 3000,
   "encumbered": 2000,
   "expenditures": 4500,
   "unavailable": 10000,

diff --git a/mod-finance/examples/budget_expense_class_totals.sample b/mod-finance/examples/budget_expense_class_totals.sample
@@ -5,6 +5,7 @@
   "expenseClassStatus": "Active",
   "encumbered": "30.05",
   "awaitingPayment": "0.0",
+  "credited": "0.0",
   "expended": "103.0",
   "percentageExpended": "51.5"
 }
diff --git a/mod-finance/examples/budget_expense_class_totals_collection.sample b/mod-finance/examples/budget_expense_class_totals_collection.sample
@@ -6,6 +6,7 @@
       "expenseClassStatus": "Active",
       "encumbered": "30.05",
       "awaitingPayment": "0.0",
+      "credited": "30.0",
       "expended": "103.0",
       "percentageExpended": "51.5"
     }

diff --git a/mod-finance/examples/group_expense_class_totals.sample b/mod-finance/examples/group_expense_class_totals.sample
@@ -3,6 +3,7 @@
   "expenseClassName": "Electronic",
   "encumbered": "30.05",
   "awaitingPayment": "13.0",
+  "credited": "50.0",
   "expended": "103.0",
   "percentageExpended": "51.5"
 }
diff --git a/mod-finance/examples/group_expense_class_totals_collection.sample b/mod-finance/examples/group_expense_class_totals_collection.sample
@@ -5,6 +5,7 @@
       "expenseClassName": "Electronic",
       "encumbered": "30.05",
       "awaitingPayment": "13.0",
+      "credited": "40.0",
       "expended": "103.0",
       "percentageExpended": "51.5"
     }

diff --git a/mod-finance/examples/group_fiscal_year_summary.sample b/mod-finance/examples/group_fiscal_year_summary.sample
@@ -9,6 +9,7 @@
   "netTransfers": 2500,
   "unavailable": 10,
   "expenditures": 10,
+  "credits": 0,
   "encumbered": 0,
   "awaitingPayment": 0,
   "overEncumbrance": 0,

diff --git a/mod-finance/examples/group_fiscal_year_summary_collection.sample b/mod-finance/examples/group_fiscal_year_summary_collection.sample
@@ -10,6 +10,7 @@
       "available": 21990,
       "netTransfers": 2500,
       "unavailable": 10,
+      "credits": 2500,
       "expenditures": 10,
       "encumbered": 0,
       "awaitingPayment": 0,
@@ -28,6 +29,7 @@
       "available": 2199,
       "netTransfers": 250,
       "unavailable": 1,
+      "credits": 250,
       "expenditures": 1,
       "encumbered": 0,
       "awaitingPayment": 0,

diff --git a/mod-finance/examples/ledger.sample b/mod-finance/examples/ledger.sample
@@ -12,6 +12,7 @@
   "available": 21990,
   "netTransfers": 2500,
   "unavailable": 10,
+  "credits": 1500,
   "expenditures": 10,
   "encumbered": 0,
   "awaitingPayment": 0,

diff --git a/mod-finance/examples/ledger_fiscal_year_rollover_budget.sample b/mod-finance/examples/ledger_fiscal_year_rollover_budget.sample
@@ -50,6 +50,7 @@
   "netTransfers": 0,
   "awaitingPayment": 3500,
   "available": 10000,
+  "credits": 3000,
   "encumbered": 2000,
   "expenditures": 4500,
   "unavailable": 10000,

diff --git a/mod-finance/examples/ledger_fiscal_year_rollover_budget_collection.sample b/mod-finance/examples/ledger_fiscal_year_rollover_budget_collection.sample
@@ -52,6 +52,7 @@
       "netTransfers": 0,
       "awaitingPayment": 3500,
       "available": 10000,
+      "credits": 0,
       "encumbered": 2000,
       "expenditures": 4500,
       "unavailable": 10000,

diff --git a/mod-finance/examples/shared_budget.sample b/mod-finance/examples/shared_budget.sample
@@ -7,6 +7,7 @@
   "allocated": 20000,
   "awaitingPayment": 3500,
   "available": 10000,
+  "credits": 3000,
   "encumbered": 2000,
   "expenditures": 4500,
   "unavailable": 10000,

diff --git a/mod-finance/examples/transaction_encumbrance.sample b/mod-finance/examples/transaction_encumbrance.sample
@@ -5,6 +5,7 @@
   "description": "PO_Line: History of Incas",
   "encumbrance": {
     "amountExpended": 1567.92,
+    "amountCredited": 33.42,
     "amountAwaitingPayment": 12.50,
     "initialAmountEncumbered": 1720.50,
     "status": "Unreleased",

diff --git a/mod-finance/schemas/budget.json b/mod-finance/schemas/budget.json
@@ -50,6 +50,11 @@
       "type": "number",
       "readonly": true
     },
+    "credits": {
+      "default": 0,
+      "description": "The amount currently credited for this budget",
+      "type": "number"
+    },
     "encumbered": {
       "default": 0,
       "description": "The amount currently encumbered for this budget",

diff --git a/mod-finance/schemas/budget_expense_class_totals.json b/mod-finance/schemas/budget_expense_class_totals.json
@@ -32,6 +32,14 @@
       "description": "Total awaitingPayment for expense class within a given budget",
       "type": "number"
     },
+    "credited": {
+      "description": "Total credited for expense class within a given budget",
+      "type": "number"
+    },
+    "percentageCredited": {
+      "description": "The percentage credited for the class on the total credited on a given budget",
+      "type": "number"
+    },
     "expended": {
       "description": "Total expended for expense class within a given budget",
       "type": "number"

diff --git a/mod-finance/schemas/encumbrance.json b/mod-finance/schemas/encumbrance.json
@@ -8,6 +8,11 @@
       "description": "Deprecated! Going to be removed in next release. The amount of awaiting for payment",
       "type": "number"
     },
+    "amountCredited": {
+      "default": 0,
+      "description": "The amount currently credited to this encumbrance",
+      "type": "number"
+    },
     "amountExpended": {
       "default": 0,
       "description": "The amount currently expended by this encumbrance",

diff --git a/mod-finance/schemas/fiscal_year_financial_summary.json b/mod-finance/schemas/fiscal_year_financial_summary.json
@@ -48,6 +48,11 @@
       "type": "number",
       "readonly": true
     },
+    "credits": {
+      "description": "Summary of all related to this fiscal year budgets credits",
+      "type": "number",
+      "readonly": true
+    },
     "encumbered": {
       "description": "Summary of all related to this fiscal year budgets encumbered",
       "type": "number",

diff --git a/mod-finance/schemas/group_expense_class_totals.json b/mod-finance/schemas/group_expense_class_totals.json
@@ -19,6 +19,14 @@
       "description": "Total awaitingPayment for expense class within a given group",
       "type": "number"
     },
+    "credited": {
+      "description": "Total credited for expense class within a given group",
+      "type": "number"
+    },
+    "percentageCredited": {
+      "description": "The percentage credited for the class on the total spent on a given group",
+      "type": "number"
+    },
     "expended": {
       "description": "Total expended for expense class within a given group",
       "type": "number"

diff --git a/mod-finance/schemas/group_fiscal_year_summary.json b/mod-finance/schemas/group_fiscal_year_summary.json
@@ -61,6 +61,11 @@
       "type": "number",
       "readonly": true
     },
+    "credits": {
+      "description": "Summary of all related budgets credits within a specific fiscal year",
+      "type": "number",
+      "readonly": true
+    },
     "encumbered": {
       "description": "Summary of all related budgets encumbered within a specific fiscal year",
       "type": "number",

diff --git a/mod-finance/schemas/ledger.json b/mod-finance/schemas/ledger.json
@@ -112,6 +112,11 @@
       "type": "number",
       "readonly": true
     },
+    "credits": {
+      "description": "Summary of all related to this ledger budgets credits",
+      "type": "number",
+      "readonly": true
+    },
     "encumbered": {
       "description": "Summary of all related to this ledger budgets encumbered",
       "type": "number",

diff --git a/mod-finance/schemas/ledger_fiscal_year_rollover_budget.json b/mod-finance/schemas/ledger_fiscal_year_rollover_budget.json
@@ -68,6 +68,11 @@
       "description": "The amount currently available for this budge",
       "type": "number"
     },
+    "credits": {
+      "default": 0,
+      "description": "The amount currently credited to this budget",
+      "type": "number"
+    },
     "encumbered": {
       "default": 0,
       "description": "The amount currently encumbered for this budget",

diff --git a/mod-finance/schemas/shared_budget.json b/mod-finance/schemas/shared_budget.json
@@ -48,6 +48,11 @@
       "type": "number",
       "readonly": true
     },
+    "credits": {
+      "default": 0,
+      "description": "The amount currently credited to this budget",
+      "type": "number"
+    },
     "encumbered": {
       "default": 0,
       "description": "The amount currently encumbered for this budget",