24982 - Add additional data for filing flows

bcgov · Jan 30, 2025 · a2db5be · a2db5be
1 parent 3157729
commit a2db5be
Show file tree

Hide file tree

Showing 2 changed files with 130 additions and 34 deletions.
diff --git a/btr-api/src/btr_api/schemas/btr-bods/btr-filing.json b/btr-api/src/btr_api/schemas/btr-bods/btr-filing.json
@@ -5,6 +5,18 @@
   "description": "This is object describing significant individual filing.",
   "type": "object",
   "properties": {
+    "arFilingForYear": {
+      "type": "integer"
+    },
+    "filingType": {
+      "type": "string",
+      "default": "INITIAL_FILING",
+      "enum": [
+        "INITIAL_FILING",
+        "ANNUAL_FILING",
+        "CHANGE_FILING"
+      ]
+    },
     "businessIdentifier": {
       "type": "string"
     },
@@ -41,42 +53,61 @@
     "noSignificantIndividualsExist",
     "entityStatement",
     "personStatements",
-    "ownershipOrControlStatements"
+    "ownershipOrControlStatements",
+    "filingType"
   ],
-  "oneOf": [
+  "allOf": [
     {
-      "properties": {
-        "noSignificantIndividualsExist": {
-          "const": true
-        },
-        "personStatements": {
-          "maxItems": 0
-        },
-        "ownershipOrControlStatements": {
-          "maxItems": 0
+      "if": {
+        "properties": {
+          "filingType": {
+            "const": "ANNUAL_FILING"
+          }
         }
       },
-      "required": [
-        "businessIdentifier",
-        "effectiveDate",
-        "noSignificantIndividualsExist",
-        "entityStatement",
-        "personStatements",
-        "ownershipOrControlStatements"
-      ]
+      "then": {
+        "required": [
+          "arFilingForYear"
+        ]
+      }
     },
     {
-      "properties": {
-        "noSignificantIndividualsExist": {
-          "const": false
-        },
-        "personStatements": {
-          "minItems": 1
+      "oneOf": [
+        {
+          "properties": {
+            "noSignificantIndividualsExist": {
+              "const": true
+            },
+            "personStatements": {
+              "maxItems": 0
+            },
+            "ownershipOrControlStatements": {
+              "maxItems": 0
+            }
+          },
+          "required": [
+            "businessIdentifier",
+            "effectiveDate",
+            "noSignificantIndividualsExist",
+            "entityStatement",
+            "personStatements",
+            "ownershipOrControlStatements"
+          ]
         },
-        "ownershipOrControlStatements": {
-          "minItems": 1
+        {
+          "properties": {
+            "noSignificantIndividualsExist": {
+              "const": false
+            },
+            "personStatements": {
+              "minItems": 1
+            },
+            "ownershipOrControlStatements": {
+              "minItems": 1
+            }
+          }
         }
-      }
+      ]
     }
   ]
 }