Family
13 variables 5 roles
A Family represents a collection of related persons.
Family entities are required for calculations across a number of entitlements including for example "Working for families" and "Paid Parental Leave"
A family can contain a number of roles, such as 'principal_caregiver', 'partner' & 'child'.
For more information on entities, see: http://openfisca.org/doc/coding-the-legislation/50_entities.html
Families can have multiple principle_caregivers but as each entitlement is calculated in relation to the Principle Caregiver it is recommended for modelling to create multiple family sets per caregiver to describe each scenario
Example variables
- Social Security Regulation Family has a resident child who is under 5 years old, not in school and in minimum childcare hours per week
- Parental Leave /variables/parental_leave__family_includes_biological_mother_as_partner
- Social Security Family has a child
- Social Security Regulation Family has resident child aged 5 who will be enrolled in school and in minimum childcare hours per week
- Social Security Regulation Household income is below Childcare Subsidy threshold
Person
222 variables
A Person represents an individual, the minimal legal entity on which a legislation might be applied.
Example: The 'salary' and 'income_tax' variables are usually defined for the entity 'Person'.
Usage: Calculate a variable applied to a 'Person' (e.g. access the 'salary' of a specific month with person('salary', "2017-05")). Check the role of a 'Person' in a group entity (e.g. check if a the 'Person' is a 'owner' in a 'TitledProperty' entity with person.hasrole(Titled_Property.owner)).
For more information on entities, see: http://openfisca.org/doc/coding-the-legislation/50_entities.html
Example variables
- Family Scheme Is a person is qualified as eligible for the working for families
- Super New Zealand superannuation
- Social Security Is being paid a young parent payment
- Social Security Residential requirements for certain benefits
- Accommodation Supplement Income is below Accommodation Supplement threshold?
Titled_property
4 variables 2 roles
A Titled property represents a property that is owned by a Person or group of Persons.
Example usage:
Check the number of individuals of a specific role: check how many persons co-own the property: titled_properties.nb_persons(Titled_Property.OWNER).
Calculate a variable applied to each tenant of the group entity: calculate the income of each member of the Property: tenants_incomes = titled_properties.members('income', period = MONTH); tenants_total_income = titled_properties.sum(tenants_incomes).
For more information on group entities, see: http://openfisca.org/doc/coding-the-legislation/50_entities.html
Example variables
- Rates Rebates Minimum income that returns no rebate. Less than this number gets a rebate
- Rates Rebates Yearly rebate applied to housing rates.
- Rates Rebates Total rates for the property
- Rates Rebates Maximum income eligible for the full rebate, less than this number should get full rebate