fire++ adding multiple missing fire properties

SuadeLabs · Dec 6, 2023 · de684de · de684de
1 parent 14131d9
commit de684de
Show file tree

Hide file tree

Showing 15 changed files with 174 additions and 14 deletions.
diff --git a/documentation/properties/accrued_interest_balance.md b/documentation/properties/accrued_interest_balance.md
@@ -0,0 +1,13 @@
+---
+layout:     property
+title:      "accrued_interest_balance"
+schemas:    [loan]
+---
+
+# accrued_interest_balance
+
+---
+
+The **accrued interest balance** is the accrued interest due at the next payment date. 
+
+Monetary type represented as a naturally positive integer number of cents/pence.
diff --git a/documentation/properties/behavioral_curve_id.md b/documentation/properties/behavioral_curve_id.md
@@ -0,0 +1,11 @@
+---
+layout:     property
+title:      "behavioral_curve_id"
+schemas:    [account, loan]
+---
+
+# behavioral_curve_id
+
+---
+
+The **behavioral curve id** is the unique identifier for the behavioral curve used by the financial institution.
diff --git a/documentation/properties/ccf.md b/documentation/properties/ccf.md
@@ -0,0 +1,11 @@
+---
+layout:     property
+title:      "ccf"
+schemas:    [loan, account]
+---
+
+# ccf
+
+---
+
+The **credit conversion factor** is what indicates the proportion of the undrawn amount that would be drawn down on default.
diff --git a/documentation/properties/customers.md b/documentation/properties/customers.md
@@ -0,0 +1,21 @@
+---
+layout:     property
+title:      "customers"
+schemas:    [loan]
+---
+
+# customers
+
+---
+
+The list of customers for this loan.
+
+It is a composition of id and income_amount providing a information about each customer.
+
+## id
+The unique identifier for the customer/s within the financial institution.
+
+## income_amount
+The reference income used for the customer(s) for this loan. Monetary type represented as an integer number of cents/pence.
+
+
diff --git a/documentation/properties/encumbrance_end_date.md b/documentation/properties/encumbrance_end_date.md
@@ -0,0 +1,13 @@
+---
+layout:     property
+title:      "encumbrance_end_date"
+schemas:    [loan]
+---
+
+# encumbrance_end_date
+
+---
+
+The **encumbrance end date** is the date when encumbrance amount goes to zero. 
+
+It is in date-time format in accordance with the ISO 8601 standard (YYYY-MM-DDTHH:MM:SSZ).
diff --git a/documentation/properties/facility_currency_code.md b/documentation/properties/facility_currency_code.md
@@ -0,0 +1,11 @@
+---
+layout:     property
+title:      "facility_currency_code"
+schemas:    [loan]
+---
+
+# facility_currency_code
+
+---
+
+The **facility currency code** is the currency of the credit facility when it is not the same as "currency_code" of the loan.
diff --git a/documentation/properties/guarantor_id.md b/documentation/properties/guarantor_id.md
@@ -0,0 +1,11 @@
+---
+layout:     property
+title:      "guarantor_id"
+schemas:    [loan, account, agreement]
+---
+
+# guarantor_id
+
+---
+
+The **guarantor id** is the unique identifier for the guarantor within the financial institution.
diff --git a/documentation/properties/intra_group.md b/documentation/properties/intra_group.md
@@ -0,0 +1,11 @@
+---
+layout:     property
+title:      "intra_group"
+schemas:    [entity]
+---
+
+# intra_group
+
+---
+
+The **intra group** is a flag to indicate that the entity should be considered an intra-group.
diff --git a/documentation/properties/issuer_id.md b/documentation/properties/issuer_id.md
@@ -0,0 +1,12 @@
+---
+layout:     property
+title:      "issuer_id"
+schemas:    [loan, derivative, security]
+---
+
+# issuer_id
+
+---
+
+The **issuer id** is a unique identifier used by the financial institution to identify the underlying reference issuer for this product.
+
diff --git a/documentation/properties/ledger_code.md b/documentation/properties/ledger_code.md
@@ -0,0 +1,11 @@
+---
+layout:     property
+title:      "ledger_code"
+schemas:    [loan, account, derivative, security]
+---
+
+# ledger_code
+
+---
+
+The **ledger code** is an internal ledger code or line item name.
diff --git a/documentation/properties/legal_entity_name.md b/documentation/properties/legal_entity_name.md
@@ -0,0 +1,11 @@
+---
+layout:     property
+title:      "legal_entity_name"
+schemas:    [entity]
+---
+
+# legal_entity_name
+
+---
+
+The **legal entity name** is the official legal name of the entity.
diff --git a/documentation/properties/national_reporting_code.md b/documentation/properties/national_reporting_code.md
@@ -0,0 +1,11 @@
+---
+layout:     property
+title:      "national_reporting_code"
+schemas:    [entity]
+---
+
+# national_reporting_code
+
+---
+
+The **national reporting code** is the unique identifier established by the national reporting system.
diff --git a/documentation/properties/next_repricing_date.md b/documentation/properties/next_repricing_date.md
@@ -0,0 +1,14 @@
+---
+layout:     property
+title:      "next_repricing_date"
+schemas:    [loan, account, security]
+---
+
+# next_repricing_date
+
+---
+
+The **next repricing date** is the date on which the interest rate of the security will be re-calculated. 
+
+It is in date-time format in accordance with the ISO 8601 standard (YYYY-MM-DDTHH:MM:SSZ).
+
diff --git a/documentation/properties/vol_adj.md b/documentation/properties/vol_adj.md
@@ -0,0 +1,13 @@
+---
+layout:     property
+title:      "vol_adj"
+schemas:    [loan, collateral]
+---
+
+# vol_adj
+
+---
+
+The **volatility adjustment** is an adjustment to the basic risk-free rate that reflects a proportion of the additional return that an insurer may expect to earn from investing in government and corporate bonds, rather than risk-free equivalents.
+
+[volatility adjustment]:https://www.bankofengland.co.uk/prudential-regulation/key-initiatives/solvency-ii/technical-information
diff --git a/tests/test_docs.py b/tests/test_docs.py
@@ -17,38 +17,25 @@ def test_property_has_docs(self):
         """
         exceptions = [
             "account_ids",
-            "accrued_interest_balance",
-            "behavioral_curve_id",
             "cb_haircut",
-            "ccf",
             "col",
             "comment",
             "contribution_amount",
             "contribution_text",
-            "customers",
             "data",
             "delta",
             "derivative_id",
-            "encumbrance_end_date",
-            "facility_currency_code",
             "forward_rate",
             "gamma",
-            "guarantor_id",
             "insolvency_rank",
-            "intra_group",
-            "issuer_id",
-            "ledger_code",
             "leg",
-            "legal_entity_name",
             "links",
             "loan_id",
             "loan_ids",
-            "national_reporting_code",
             "next_exercise_date",
             "next_payment_amount",
             "next_receive_amount",
             "next_receive_date",
-            "next_repricing_date",
             "next_reset_date",
             "page",
             "payment_date",
@@ -66,7 +53,6 @@ def test_property_has_docs(self):
             "underlying_strike",
             "values",
             "vega",
-            "vol_adj",
             "vol_adj_fx",
         ]