[WIP] Add organ donor compensation

openfisca_aotearoa/tests/live_organ_donor_compensation.yaml

@@ -0,0 +1,23 @@
+# We can run this test on our command line using `openfisca-run-test openfisca_aotearoa/tests/live_organ_donor_compensation.yaml`
+
+- name: An employee earning mixed salary for the last 52 weeks not enrolled in Kiwisaver, no ACC payment in past year
+  period: 2018
+  absolute_error_margin: 0.0001
+  input_variables:
+    sum_of_earnings_in_last_52_weeks: 62500
+    earnings_period_in_weeks: 52
+    kiwisaver_member: no
+  output_variables:
+    weekly_compensation_before_tax: 1201.92
+
+- name: An employee earning mixed salary for the last 52 weeks not enrolled in Kiwisaver, with ACC over 6 weeks
+  period: 2018
+  absolute_error_margin: 0.0001
+  input_variables:
+    sum_of_earnings_in_last_52_weeks: 62500
+    earnings_period_in_weeks: 52
+    sum_of_earnings_during_compensation_period_in_last_52_weeks: 6000
+    compensation_period_in_weeks: 6
+    kiwisaver_member: no
+  output_variables:
+    weekly_compensation_before_tax: 1228.26

openfisca_aotearoa/variables/live_organ_donor_compensation.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+
+# Import from openfisca-core the common python objects used to code the legislation in OpenFisca
+from openfisca_core.model_api import *
+# Import the entities specifically defined for this tax and benefit system
+from openfisca_aotearoa.entities import Person
+from numpy import round
+
+class weekly_compensation_before_tax(Variable):
+    value_type = float
+    entity = Person
+    definition_period = YEAR # TODO - determine whether we need to get WEEK to work
+    label = u"The amount payable as compensation per week before tax"
+    def formula(persons, period, parameters):
+        earnings_amount = persons('sum_of_earnings_in_last_52_weeks', period) 
+        compensation_amount = persons('sum_of_earnings_during_compensation_period_in_last_52_weeks', period)
+        earnings_excluding_compensation_amount = earnings_amount - compensation_amount
+        earnings_period = persons('earnings_period_in_weeks', period)
+        compensation_period = persons('compensation_period_in_weeks', period)
+        earnings_excluding_compensation_period = earnings_period - compensation_period
+        return round(earnings_excluding_compensation_amount / earnings_excluding_compensation_period , 2)
+
+# class PayFrequency(Enum):
+#     weekly = u'Weekly'
+#     fortnightly = u'Fortnightly'
+#     four_weekly = u'Four Weekly'
+#     monthly = u'Monthly'
+
+# class pay_frequency(Variable):
+#     value_type = Enum
+#     possible_values = PayFrequency
+#     default_value = PayFrequency.weekly  # The default is mandatory
+#     entity = Person
+#     definition_period = YEAR
+#     label = u"The frequency at which a person is paid"
+
+# class salary_per_pay(Variable):
+#     value_type = float
+#     entity = Person
+#     definition_period = YEAR # TODO - determine whether we need to get WEEK to work
+#     label = u"The salary earned by a person before tax"
+
+class kiwisaver_member(Variable):
+    value_type = bool
+    default_value = True
+    entity = Person
+    label = u"Whether the person currently pays into Kiwisaver"
+    definition_period = YEAR
+
+class sum_of_earnings_in_last_52_weeks(Variable):
+    value_type = float
+    entity = Person
+    label = u"Total earnings over last 52 weeks"
+    definition_period = YEAR
+
+class earnings_period_in_weeks(Variable):
+    value_type = int
+    entity = Person
+    label = u"The number of weeks over which earnings have been earned"
+    definition_period = YEAR
+
+class sum_of_earnings_during_compensation_period_in_last_52_weeks(Variable):
+    value_type = float
+    entity = Person
+    label = u"Earnings during the period in which the donor was entitled to weekly compensation (as defined in section 6(1) of the Accident Compensation Act 2001)"
+    definition_period = YEAR
+
+class compensation_period_in_weeks(Variable):
+    value_type = int
+    entity = Person
+    label = u"The number of weeks in which the donor was entitled to weekly compensation (as defined in section 6(1) of the Accident Compensation Act 2001) over the last 52 weeks"
+    definition_period = YEAR
+