{"components":{"headers":{"Country-Package":{"description":"The name of the country package currently loaded in this API server","schema":{"type":"string"}},"Country-Package-Version":{"description":"The version of the country package currently loaded in this API server","schema":{"pattern":"^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","type":"string"}}},"schemas":{"Brackets":{"additionalProperties":{"format":"float","type":"number"},"type":"object"},"Entities":{"properties":{"description":{"type":"string"},"documentation":{"type":"string"},"plural":{"type":"string"},"roles":{"additionalProperties":{"$ref":"#/components/schemas/Roles"},"type":"object"}},"type":"object"},"Family":{"additionalProperties":false,"properties":{"age_of_youngest":{"additionalProperties":{"type":"integer"},"type":"object"},"best_start__family_has_children_eligible":{"additionalProperties":{"type":"boolean"},"type":"object"},"child_disability_allowance__family_has_eligible_child":{"additionalProperties":{"type":"boolean"},"type":"object"},"childcare_assistance__family_has_child_eligible_for_disability_allowance_child_under_6":{"additionalProperties":{"type":"boolean"},"type":"object"},"childcare_assistance__family_has_resident_child_under_5_not_in_school":{"additionalProperties":{"type":"boolean"},"type":"object"},"childcare_assistance__household_income_below_childcare_subsidy_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"childcare_assistance__resident_child_aged_5_will_be_enrolled_in_school":{"additionalProperties":{"type":"boolean"},"type":"object"},"children":{"items":{"type":"string"},"type":"array"},"family_scheme__dependent_children":{"additionalProperties":{"type":"boolean"},"type":"object"},"others":{"items":{"type":"string"},"type":"array"},"parental_leave__family_includes_biological_mother_as_partner":{"additionalProperties":{"type":"boolean"},"type":"object"},"parents":{"items":{"type":"string"},"type":"array"},"partners":{"items":{"type":"string"},"type":"array"},"principal":{"items":{"type":"string"},"type":"array"},"social_security__orphaned_child_in_family":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__family_has_child_under_age_limit":{"additionalProperties":{"type":"boolean"},"type":"object"},"unsupported_child__unsupported_child_in_family":{"additionalProperties":{"type":"boolean"},"type":"object"}},"type":"object"},"Formula":{"properties":{"content":{"type":"string"},"source":{"type":"string"}},"type":"object"},"Ownership":{"additionalProperties":false,"properties":{"others":{"items":{"type":"string"},"type":"array"},"owners":{"items":{"type":"string"},"type":"array"},"principal":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Parameter":{"example":{"description":null,"id":"disability_allowance","metadata":{},"source":"https://github.com/digitalaotearoa/openfisca-aotearoa/blob/21.0.1/openfisca_aotearoa/parameters/disability_allowance","subparams":{"income_limits":{"description":"Schedule 5 - Part 3 - Disability allowance income limits"},"max_weekly_benefit":{"description":"Maximum rate of disability allowance under section 85"}}},"properties":{"brackets":{"additionalProperties":{"$ref":"#/components/schemas/Brackets"},"type":"object"},"description":{"type":"string"},"id":{"format":"string","type":"integer"},"metadata":{"type":"object"},"source":{"type":"string"},"subparams":{"additionalProperties":{"properties":{"definition":{"type":"string"}},"type":"object"},"type":"object"},"values":{"$ref":"#/components/schemas/Values"}},"type":"object"},"Parameters":{"additionalProperties":{"properties":{"description":{"type":"string"},"href":{"type":"string"}},"type":"object"},"type":"object"},"Person":{"additionalProperties":false,"properties":{"acc__cover":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc__earner":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc__fullfils_purpose_of_act":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc__potential_earner":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc__promotes_measures_to_reduce_incidence_and_severity_of_personal_injury":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc__receiving_compensation":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc_part_2__suffered_personal_injury":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc_part_3__lodged_claim":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc_sched_1__engaged_fulltime_study_or_training":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc_sched_1__incapacitated_for_6_months":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc_sched_1__loe_more_than_lope":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc_sched_1__lope_eligible":{"additionalProperties":{"type":"boolean"},"type":"object"},"acc_sched_1__lope_weekly_compensation":{"additionalProperties":{"type":"number"},"type":"object"},"acc_sched_1__minimum_weekly_earnings":{"additionalProperties":{"type":"number"},"type":"object"},"acc_sched_1__weekly_earnings":{"additionalProperties":{"type":"number"},"type":"object"},"accommodation_costs":{"additionalProperties":{"type":"number"},"type":"object"},"accommodation_supplement":{"additionalProperties":{"type":"number"},"type":"object"},"accommodation_supplement__accommodation_costs":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__area_of_residence":{"additionalProperties":{"enum":["unknown","area_1","area_2","area_3","area_4"],"type":"string"},"type":"object"},"accommodation_supplement__assets_requirement":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__base":{"additionalProperties":{"type":"number"},"type":"object"},"accommodation_supplement__below_cash_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__below_income_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__beneficiary":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__cash_assets":{"additionalProperties":{"type":"integer"},"type":"object"},"accommodation_supplement__cutout":{"additionalProperties":{"type":"number"},"type":"object"},"accommodation_supplement__disability":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__non_beneficiary":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__other_funding_exclusion":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__part_of_nz":{"additionalProperties":{"type":"string"},"type":"object"},"accommodation_supplement__rate":{"additionalProperties":{"type":"number"},"type":"object"},"accommodation_supplement__rebate":{"additionalProperties":{"type":"number"},"type":"object"},"accommodation_supplement__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_supplement__situation":{"additionalProperties":{"enum":["unknown","situation_1","situation_2","situation_3","situation_4","situation_5","situation_6"],"type":"string"},"type":"object"},"accommodation_supplement__social_housing_exclusion":{"additionalProperties":{"type":"boolean"},"type":"object"},"accommodation_type":{"additionalProperties":{"enum":["unknown","rent","board","lodging","mortgage","social_housing","residential_care"],"type":"string"},"type":"object"},"age":{"additionalProperties":{"type":"integer"},"type":"object"},"age_of_partner":{"additionalProperties":{"type":"integer"},"type":"object"},"attending_school":{"additionalProperties":{"type":"boolean"},"type":"object"},"basic_grant__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"basic_grant__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"basic_grant__would_be_entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"best_start__eligibility":{"additionalProperties":{"type":"boolean"},"type":"object"},"best_start__entitlement":{"additionalProperties":{"type":"number"},"type":"object"},"best_start__tax_credit_per_child":{"additionalProperties":{"type":"number"},"type":"object"},"best_start__year_of_child":{"additionalProperties":{"type":"number"},"type":"object"},"child_disability_allowance__allowance_criteria":{"additionalProperties":{"type":"boolean"},"type":"object"},"child_disability_allowance__approved_weekly_accomodation":{"additionalProperties":{"type":"boolean"},"type":"object"},"child_disability_allowance__care_in_home":{"additionalProperties":{"type":"boolean"},"type":"object"},"child_disability_allowance__child_with_serious_disability":{"additionalProperties":{"type":"boolean"},"type":"object"},"child_disability_allowance__constant_care_exceeding_12_months":{"additionalProperties":{"type":"boolean"},"type":"object"},"child_disability_allowance__eligible":{"additionalProperties":{"type":"boolean"},"type":"object"},"child_disability_allowance__granted":{"additionalProperties":{"type":"boolean"},"type":"object"},"child_disability_allowance__payment":{"additionalProperties":{"type":"number"},"type":"object"},"child_disability_allowance__payment_to":{"additionalProperties":{"type":"boolean"},"type":"object"},"childcare_assistance__eligible_childcare_subsidy":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__5_year_presence_requirement":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__citizen":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__citizenship_by_grant_may_be_authorized":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__each_year_minimum_presence_requirements":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__intends_crown_service":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__intends_international_service":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__intends_nz_employment":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__intends_to_reside_in_nz":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__minimum_presence_requirements":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__of_good_character":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__preceeding_single_year_minimum_presence_requirement":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__sufficient_knowledge_english_language":{"additionalProperties":{"type":"boolean"},"type":"object"},"citizenship__sufficient_knowledge_responsibilities_and_privileges":{"additionalProperties":{"type":"boolean"},"type":"object"},"civil_union__civil_union":{"additionalProperties":{"type":"boolean"},"type":"object"},"community_services_card":{"additionalProperties":{"type":"boolean"},"type":"object"},"community_services_card__below_income_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"date_of_birth":{"additionalProperties":{"type":"string"},"type":"object"},"date_of_injury":{"additionalProperties":{"type":"string"},"type":"object"},"days_present_in_new_zealand_in_preceeding_5_years":{"additionalProperties":{"type":"integer"},"type":"object"},"days_present_in_new_zealand_in_preceeding_year":{"additionalProperties":{"type":"integer"},"type":"object"},"disability_allowance__below_income_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__benefit":{"additionalProperties":{"type":"number"},"type":"object"},"disability_allowance__continuing_disability":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__family_income":{"additionalProperties":{"type":"number"},"type":"object"},"disability_allowance__income_limit_clause_10":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__income_limit_clause_11":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__income_limit_clause_12":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__income_limit_clause_13":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__income_limit_clause_14":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__needs_ongoing_support":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__needs_ongoing_treatment":{"additionalProperties":{"type":"boolean"},"type":"object"},"disability_allowance__ongoing_additional_expenses":{"additionalProperties":{"type":"boolean"},"type":"object"},"due_date_of_birth":{"additionalProperties":{"type":"string"},"type":"object"},"early_childcare_hours_participation_per_week":{"additionalProperties":{"type":"integer"},"type":"object"},"emergency_benefit__base":{"additionalProperties":{"type":"number"},"type":"object"},"emergency_benefit__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"emergency_benefit__granted":{"additionalProperties":{"type":"boolean"},"type":"object"},"emergency_benefit__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__assessable_income":{"additionalProperties":{"type":"number"},"type":"object"},"family_scheme__assessable_income_for_month":{"additionalProperties":{"type":"number"},"type":"object"},"family_scheme__base_qualifies":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__caregiver_age_qualifies":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__child_tax_credit_entitlement":{"additionalProperties":{"type":"number"},"type":"object"},"family_scheme__family_tax_credit_entitlement":{"additionalProperties":{"type":"number"},"type":"object"},"family_scheme__family_tax_credit_income_under_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__full_time_earner":{"additionalProperties":{"type":"integer"},"type":"object"},"family_scheme__in_work_tax_credit_entitlement":{"additionalProperties":{"type":"number"},"type":"object"},"family_scheme__in_work_tax_credit_income_under_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__parental_tax_credit_entitlement":{"additionalProperties":{"type":"number"},"type":"object"},"family_scheme__qualifies_as_principal_carer":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__qualifies_for_child_tax_credit":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__qualifies_for_family_tax_credit":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__qualifies_for_in_work_tax_credit":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__qualifies_for_minimum_family_tax_credit":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__qualifies_for_parental_tax_credit":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__qualifies_for_working_for_families":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_scheme__working_for_families_entitlement":{"additionalProperties":{"type":"number"},"type":"object"},"family_tax_credit":{"additionalProperties":{"type":"number"},"type":"object"},"family_tax_credit__base":{"additionalProperties":{"type":"number"},"type":"object"},"family_tax_credit__dependent_child":{"additionalProperties":{"type":"number"},"type":"object"},"family_tax_credit__eldest":{"additionalProperties":{"type":"number"},"type":"object"},"family_tax_credit__eligible":{"additionalProperties":{"type":"boolean"},"type":"object"},"family_tax_credit__not_eldest":{"additionalProperties":{"type":"number"},"type":"object"},"financially_supported_by_parent_or_guardian":{"additionalProperties":{"type":"boolean"},"type":"object"},"finish_date_of_full_time_study_training_bridging_18th_birthday":{"additionalProperties":{"type":"string"},"type":"object"},"full_capacity":{"additionalProperties":{"type":"boolean"},"type":"object"},"fulltime_employment":{"additionalProperties":{"type":"boolean"},"type":"object"},"has_disability":{"additionalProperties":{"type":"boolean"},"type":"object"},"home_help__adopted_2_or_more_children":{"additionalProperties":{"type":"boolean"},"type":"object"},"home_help__eligible_for_home_help":{"additionalProperties":{"type":"boolean"},"type":"object"},"home_help__multiple_birth":{"additionalProperties":{"type":"boolean"},"type":"object"},"home_help__no_immediate_family":{"additionalProperties":{"type":"boolean"},"type":"object"},"hours_per_week_employed":{"additionalProperties":{"type":"integer"},"type":"object"},"immigration__citizen_or_resident":{"additionalProperties":{"type":"boolean"},"type":"object"},"immigration__entitled_to_indefinite_stay":{"additionalProperties":{"type":"boolean"},"type":"object"},"immigration__holds_resident_visa":{"additionalProperties":{"type":"boolean"},"type":"object"},"immigration__permanent_resident":{"additionalProperties":{"type":"boolean"},"type":"object"},"immigration__protected_person":{"additionalProperties":{"type":"boolean"},"type":"object"},"immigration__recognised_refugee":{"additionalProperties":{"type":"boolean"},"type":"object"},"immigration__resident":{"additionalProperties":{"type":"boolean"},"type":"object"},"immigration__temporary_entry_class_visa":{"additionalProperties":{"type":"boolean"},"type":"object"},"incapacity_for_employment__caused_covered_injury":{"additionalProperties":{"type":"boolean"},"type":"object"},"incapacity_for_employment__corporation_determination":{"additionalProperties":{"type":"boolean"},"type":"object"},"income_tax__annual_gross_income":{"additionalProperties":{"type":"number"},"type":"object"},"income_tax__annual_total_deduction":{"additionalProperties":{"type":"number"},"type":"object"},"income_tax__available_tax_loss":{"additionalProperties":{"type":"number"},"type":"object"},"income_tax__dependent_child":{"additionalProperties":{"type":"boolean"},"type":"object"},"income_tax__net_income":{"additionalProperties":{"type":"number"},"type":"object"},"income_tax__net_loss":{"additionalProperties":{"type":"number"},"type":"object"},"income_tax__principal_caregiver":{"additionalProperties":{"type":"boolean"},"type":"object"},"income_tax__residence":{"additionalProperties":{"type":"boolean"},"type":"object"},"income_tax__taxable_income":{"additionalProperties":{"type":"number"},"type":"object"},"independent_circumstances_grant__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"independent_circumstances_grant__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"independent_circumstances_grant__would_be_entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"is_adequately_supported_by_partner":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__age_requirement":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__available_for_work":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__base":{"additionalProperties":{"type":"number"},"type":"object"},"jobseeker_support__benefit":{"additionalProperties":{"type":"number"},"type":"object"},"jobseeker_support__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__full_employment_temporary":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__granted":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__income_52_week_period_less_than":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__limited_in_capacity":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__living_with_parent":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__losing_earnings":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__minimum_income":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__reduction":{"additionalProperties":{"type":"number"},"type":"object"},"jobseeker_support__taken_reasonable_steps":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__transferred_15_july_2013":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__willing_and_able":{"additionalProperties":{"type":"boolean"},"type":"object"},"jobseeker_support__work_gap":{"additionalProperties":{"type":"boolean"},"type":"object"},"living_with_parent_or_guardian":{"additionalProperties":{"type":"boolean"},"type":"object"},"losing_earnings_from_health_injury":{"additionalProperties":{"type":"boolean"},"type":"object"},"marriage__married":{"additionalProperties":{"type":"boolean"},"type":"object"},"monthly_income":{"additionalProperties":{"type":"number"},"type":"object"},"number_of_years_lived_in_nz":{"additionalProperties":{"type":"integer"},"type":"object"},"oranga_tamariki__child":{"additionalProperties":{"type":"boolean"},"type":"object"},"oranga_tamariki__parent":{"additionalProperties":{"type":"boolean"},"type":"object"},"orphans_benefit__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__a_person_other_than_biological_mother_or_her_spouse":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__applied_for_leave_or_stopped_working":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__biological_mother":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__eligible_employee":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__had_previous_parental_leave_in_last_six_months":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__primary_carer":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__spouse_or_partner_of_biological_mother":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__spouse_who_transferred_her_entitlement":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__taking_permanent_primary_responsibility_for_child":{"additionalProperties":{"type":"boolean"},"type":"object"},"parental_leave__threshold_tests":{"additionalProperties":{"type":"integer"},"type":"object"},"parental_leave__transferred_her_entitlement_to_spouse":{"additionalProperties":{"type":"boolean"},"type":"object"},"person_is_step_parent":{"additionalProperties":{"type":"boolean"},"type":"object"},"present_in_new_zealand":{"additionalProperties":{"type":"boolean"},"type":"object"},"property_relationships__de_facto_relationship":{"additionalProperties":{"type":"boolean"},"type":"object"},"rates_rebates__combined_income":{"additionalProperties":{"type":"number"},"type":"object"},"rates_rebates__dependants":{"additionalProperties":{"type":"integer"},"type":"object"},"schedule_4__part1_1_a":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_b":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_c":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_d":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_e":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_f":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_g":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_g_i":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_g_ii":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_h":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_h_i":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_h_ii":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_i":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_i_i":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_i_ii":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_j":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_j_i":{"additionalProperties":{"type":"boolean"},"type":"object"},"schedule_4__part1_1_j_ii":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_housing__eligible":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__a_beneficiary":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__age_youngest_dependant_child":{"additionalProperties":{"type":"integer"},"type":"object"},"social_security__awaiting_protected_person":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__awaiting_refugee":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__been_married_or_civil_union_or_de_facto_relationship":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__beneficiary":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__care_and_control":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__child":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__compelled_to_remain":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__dependent_child":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__dependent_children":{"additionalProperties":{"type":"integer"},"type":"object"},"social_security__eligible_for_community_services_card":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__employment":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__financially_independent":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__full_employment":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__fulltime_student":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__general_limitation":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__granted_main_benefit":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__in_a_relationship":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__in_receipt_of_basic_grant":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__income":{"additionalProperties":{"type":"number"},"type":"object"},"social_security__ordinarily_resident_in_country_with_reciprocity_agreement":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__ordinarily_resident_in_new_zealand":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__orphaned":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__paid_a_supported_living_payment":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__paid_a_young_parent_payment":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__paid_a_youth_payment":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__paid_an_emergency_benefit":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__paid_jobseeker_benefit":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__paid_sole_parent_support":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__parent":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__parent_of_dependent_child":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__parents_unable_to_provide_sufficient_care":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__principal_caregiver":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__principal_carer_for_one_year_from_application_date":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__received_child_disability_allowance":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__received_income_tested_benefit":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__received_orphans_benefit":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__received_residential_care_subsidy":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__received_superannuation":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__received_unsupported_childs_benefit":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__receiving_main_benefit":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__recieves_goverment_assisted_scheme_payments":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__recieves_main_benefit":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__refugee_or_protected_person":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__resided_continuously_nz_2_years_citizen_or_resident":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__residential_requirement":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__sole_parent":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__spouse_is_a_specified_beneficiary":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__temporary_ob_or_ucb_caregiver":{"additionalProperties":{"type":"boolean"},"type":"object"},"social_security__unlawfully_resident_or_present":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__age_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__base":{"additionalProperties":{"type":"number"},"type":"object"},"sole_parent_support__below_income_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__benefit":{"additionalProperties":{"type":"number"},"type":"object"},"sole_parent_support__both_primary_caregiver_by_order":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__dependent_child_requirement":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__entitled_without_split_care_requirement":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__granted":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__living_apart_and_lost_support":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__lost_regular_support":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__marriage_or_civil_union_dissolved":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__meets_relationship_qualification":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__parents_living_apart":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__partner_imprisoned":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__partner_supervision":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__principal_caregiver_before_apart":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__principal_caregiver_of_youngest":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__reduction":{"additionalProperties":{"type":"number"},"type":"object"},"sole_parent_support__requirement":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__split_care":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__spouse_or_partner_died":{"additionalProperties":{"type":"boolean"},"type":"object"},"sole_parent_support__weekly_childcare_cost":{"additionalProperties":{"type":"number"},"type":"object"},"student_allowance__approved_to_study_overseas":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__approved_to_study_parttime":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__childless":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__combined_income":{"additionalProperties":{"type":"number"},"type":"object"},"student_allowance__dependent_student":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__eligible_for_certain_allowances":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__enrolled_fulltime":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__income_before_tax":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__living_with_a_parent":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__married_or_partnered":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__meets_attendance_and_performance_requirements":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__partner_has_a_supported_child":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__partner_or_person_receiving_certain_allowances":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__person_has_spouse":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__secondary_student":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__student":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__supported_child":{"additionalProperties":{"type":"boolean"},"type":"object"},"student_allowance__tertiary_student":{"additionalProperties":{"type":"boolean"},"type":"object"},"super___eligibility_age":{"additionalProperties":{"type":"integer"},"type":"object"},"super__base":{"additionalProperties":{"type":"number"},"type":"object"},"super__being_paid_nz_superannuation":{"additionalProperties":{"type":"boolean"},"type":"object"},"super__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"super__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"supported_living_payment__base":{"additionalProperties":{"type":"number"},"type":"object"},"supported_living_payment__below_income_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"supported_living_payment__caring_for_another_person":{"additionalProperties":{"type":"boolean"},"type":"object"},"supported_living_payment__disability_self_inflicted":{"additionalProperties":{"type":"boolean"},"type":"object"},"supported_living_payment__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"supported_living_payment__granted":{"additionalProperties":{"type":"boolean"},"type":"object"},"supported_living_payment__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"supported_living_payment__restricted_work_capacity":{"additionalProperties":{"type":"boolean"},"type":"object"},"total_number_of_years_lived_in_nz_since_age_20":{"additionalProperties":{"type":"integer"},"type":"object"},"total_number_of_years_lived_in_nz_since_age_50":{"additionalProperties":{"type":"integer"},"type":"object"},"totally_blind":{"additionalProperties":{"type":"boolean"},"type":"object"},"unsupported_child__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_pension__base":{"additionalProperties":{"type":"number"},"type":"object"},"veterans_pension__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_pension__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_support__being_paid_a_veterans_pension":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_support__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_support__received_childrens_pension":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_support__received_parents_allowance":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_support__received_veterans_pension":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_support__received_weekly_compensation":{"additionalProperties":{"type":"boolean"},"type":"object"},"veterans_support__received_weekly_income_compensation":{"additionalProperties":{"type":"boolean"},"type":"object"},"was_present_in_nz_and_entitled_to_indefinite_stay":{"additionalProperties":{"type":"integer"},"type":"object"},"weekly_compensation__lodges_a_claim":{"additionalProperties":{"type":"boolean"},"type":"object"},"weekly_compensation__loss_of_earnings_payable":{"additionalProperties":{"type":"number"},"type":"object"},"will_be_enrolled_in_school":{"additionalProperties":{"type":"boolean"},"type":"object"},"work_gap":{"additionalProperties":{"type":"boolean"},"type":"object"},"yearly_income":{"additionalProperties":{"type":"number"},"type":"object"},"years_resided_continuously_in_new_zealand":{"additionalProperties":{"type":"integer"},"type":"object"},"young_parent_payment__base":{"additionalProperties":{"type":"number"},"type":"object"},"young_parent_payment__basic_requirements":{"additionalProperties":{"type":"boolean"},"type":"object"},"young_parent_payment__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"young_parent_payment__family_income_under_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"young_parent_payment__granted":{"additionalProperties":{"type":"boolean"},"type":"object"},"young_parent_payment__income_under_threshold":{"additionalProperties":{"type":"boolean"},"type":"object"},"young_parent_payment__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"young_parent_payment__relationship_requirements":{"additionalProperties":{"type":"boolean"},"type":"object"},"young_parent_payment__single_young_persons":{"additionalProperties":{"type":"boolean"},"type":"object"},"youth_payment__base":{"additionalProperties":{"type":"number"},"type":"object"},"youth_payment__entitled":{"additionalProperties":{"type":"boolean"},"type":"object"},"youth_payment__granted":{"additionalProperties":{"type":"boolean"},"type":"object"},"youth_payment__receiving":{"additionalProperties":{"type":"boolean"},"type":"object"},"youth_payment__single_young_person_exceptional_circumstances":{"additionalProperties":{"type":"boolean"},"type":"object"}},"type":"object"},"Roles":{"properties":{"description":{"type":"string"},"max":{"type":"integer"},"plural":{"type":"string"}},"type":"object"},"SituationInput":{"additionalProperties":false,"example":"No simulation example has been defined for this tax and benefit system. If you are the maintainer of Openfisca-Aotearoa, you can define an example by following this documentation: https://openfisca.org/doc/openfisca-web-api/config-openapi.html","properties":{"families":{"additionalProperties":{"$ref":"#/components/schemas/Family"},"type":"object"},"ownerships":{"additionalProperties":{"$ref":"#/components/schemas/Ownership"},"type":"object"},"persons":{"additionalProperties":{"$ref":"#/components/schemas/Person"},"type":"object"},"tenancies":{"additionalProperties":{"$ref":"#/components/schemas/Tenancy"},"type":"object"},"titled_properties":{"additionalProperties":{"$ref":"#/components/schemas/Titled_Property"},"type":"object"}},"type":"object"},"SituationOutput":{"additionalProperties":false,"example":"No simulation example has been defined for this tax and benefit system. If you are the maintainer of Openfisca-Aotearoa, you can define an example by following this documentation: https://openfisca.org/doc/openfisca-web-api/config-openapi.html","properties":{"families":{"additionalProperties":{"$ref":"#/components/schemas/Family"},"type":"object"},"ownerships":{"additionalProperties":{"$ref":"#/components/schemas/Ownership"},"type":"object"},"persons":{"additionalProperties":{"$ref":"#/components/schemas/Person"},"type":"object"},"tenancies":{"additionalProperties":{"$ref":"#/components/schemas/Tenancy"},"type":"object"},"titled_properties":{"additionalProperties":{"$ref":"#/components/schemas/Titled_Property"},"type":"object"}},"type":"object"},"Tenancy":{"additionalProperties":false,"properties":{"others":{"items":{"type":"string"},"type":"array"},"principal":{"items":{"type":"string"},"type":"array"},"tenants":{"items":{"type":"string"},"type":"array"}},"type":"object"},"Titled_Property":{"additionalProperties":false,"properties":{"others":{"items":{"type":"string"},"type":"array"},"owners":{"items":{"type":"string"},"type":"array"},"rates_rebates__maximum_income_for_full_rebate":{"additionalProperties":{"type":"number"},"type":"object"},"rates_rebates__minimum_income_for_no_rebate":{"additionalProperties":{"type":"number"},"type":"object"},"rates_rebates__rates_total":{"additionalProperties":{"type":"number"},"type":"object"},"rates_rebates__rebate":{"additionalProperties":{"type":"number"},"type":"object"}},"type":"object"},"Trace":{"example":"No simulation example has been defined for this tax and benefit system. If you are the maintainer of Openfisca-Aotearoa, you can define an example by following this documentation: https://openfisca.org/doc/openfisca-web-api/config-openapi.html","properties":{"entitiesDescription":{"additionalProperties":false,"properties":{"families":{"items":{"type":"string"},"type":"array"},"ownerships":{"items":{"type":"string"},"type":"array"},"persons":{"items":{"type":"string"},"type":"array"},"tenancies":{"items":{"type":"string"},"type":"array"},"titled_properties":{"items":{"type":"string"},"type":"array"}},"type":"object"},"requestedCalculations":{"items":{"type":"string"},"type":"array"},"trace":{"additionalProperties":{"properties":{"dependencies":{"items":{"type":"string"},"type":"array"},"parameters":{"additionalProperties":{"type":"object"},"type":"object"},"value":{"items":{},"type":"array"}},"type":"object"},"type":"object"}},"type":"object"},"Value":{"oneOf":[{"type":"boolean"},{"format":"float","type":"number"},{"items":{"oneOf":[{"type":"string"},{"type":"number"}]},"type":"array"}]},"Values":{"additionalProperties":{"$ref":"#/components/schemas/Value"},"description":"All keys are ISO dates. Values can be numbers, booleans, or arrays of a single type (number, boolean or string).","propertyNames":{"pattern":"^[12][0-9]{3}-[01][0-9]-[0-3][0-9]$"},"type":"object"},"Variable":{"example":{"defaultValue":false,"definitionPeriod":"MONTH","description":"Have or adopted twins, and already has another child under 5.","entity":"person","id":"home_help__adopted_2_or_more_children","references":["https://www.workandincome.govt.nz/map/legislation/welfare-programmes/home-help-programme/index.html"],"source":"https://github.com/digitalaotearoa/openfisca-aotearoa/blob/21.0.1/openfisca_aotearoa/variables/other/home_help.py#L17-L22","valueType":"Boolean"},"properties":{"defaultValue":{"type":"string"},"definitionPeriod":{"enum":["MONTH","YEAR","ETERNITY"],"type":"string"},"description":{"type":"string"},"entity":{"type":"string"},"formulas":{"additionalProperties":{"$ref":"#/components/schemas/Formula"},"type":"object"},"id":{"type":"string"},"reference":{"items":{"type":"string"},"type":"array"},"source":{"type":"string"},"valueType":{"enum":["Int","Float","Boolean","Date","String"],"type":"string"}},"type":"object"},"Variables":{"additionalProperties":{"properties":{"description":{"type":"string"},"href":{"type":"string"}},"type":"object"},"type":"object"}}},"info":{"contact":{"email":"contact@openfisca.org"},"description":"The OpenFisca Web API lets you get up-to-date information and formulas included in the Openfisca-Aotearoa legislation.","license":{"name":"AGPL","url":"https://www.gnu.org/licenses/agpl-3.0"},"termsOfService":"https://openfisca.org/doc/licence.html","title":"Openfisca-Aotearoa Web API","version":"21.0.1"},"openapi":"3.1.0","paths":{"/calculate":{"post":{"operationId":"calculate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SituationInput"}}},"description":"Describe the situation (persons and entities). Add the variable you wish to calculate in the proper entity, with null as the value. Learn more in our official documentation: https://openfisca.org/doc/openfisca-web-api/input-output-data.html","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SituationOutput"}}},"description":"The calculation result is sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}},"400":{"description":"The request is invalid. Details about the error are sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}},"404":{"description":"A variable mentioned in the input situation does not exist in the loaded tax and benefit system. Details are sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}}},"summary":"Run a simulation","tags":["Calculations"]}},"/entities":{"get":{"operationId":"getEntities","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entities"}}},"description":"The list of the entities as well as their information is sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}}},"summary":"List all available Entities","tags":["Entities"]}},"/parameter/{parameterID}":{"get":{"operationId":"getParameter","parameters":[{"description":"ID of parameter. IDs can be obtained by enumerating the /parameters endpoint","in":"path","name":"parameterID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}},"description":"The requested parameter's information is sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}},"404":{"description":"The requested parameter does not exist","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}}},"summary":"Get information about a specific parameter","tags":["Parameters"]}},"/parameters":{"get":{"operationId":"getParameters","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameters"}}},"description":"The list of parameters is sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}}},"summary":"List all available parameters","tags":["Parameters"]}},"/spec":{"get":{"operationId":"spec","responses":{"200":{"description":"The API documentation is sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}}},"summary":"Provide the API documentation in an OpenAPI format","tags":["Documentation"]}},"/trace":{"post":{"operationId":"trace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SituationInput"}}},"description":"Describe the situation (persons and entities). Add the variable you wish to calculate in the proper entity, with null as the value.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trace"}}},"description":"The calculation details are sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}},"400":{"description":"The request is invalid. Details about the error are sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}},"404":{"description":"A variable mentioned in the input situation does not exist in the loaded tax and benefit system. Details are sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}}},"summary":"Explore a simulation's steps in details.","tags":["Calculations"]}},"/variable/{variableID}":{"get":{"operationId":"getVariable","parameters":[{"description":"ID of a variable. IDs can be obtained by enumerating the /variables endpoint.","in":"path","name":"variableID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variable"}}},"description":"The requested variable's information is sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}},"404":{"description":"The requested variable does not exist","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}}},"summary":"Get information about a specific variable","tags":["Variables"]}},"/variables":{"get":{"operationId":"getVariables","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Variables"}}},"description":"The list of variables is sent back in the response body","headers":{"Country-Package":{"$ref":"#/components/headers/Country-Package"},"Country-Package-Version":{"$ref":"#/components/headers/Country-Package-Version"}}}},"summary":"List all available variables","tags":["Variables"]}}},"servers":[{"url":"https://openfisca-aotearoa.synco.pt"}],"tags":[{"description":"A parameter is a numeric property of the legislation that can evolve over time.","externalDocs":{"description":"Parameters documentation","url":"https://openfisca.org/doc/key-concepts/parameters.html"},"name":"Parameters"},{"description":"A variable depends on a person, or an entity (e.g. zip code, salary, income tax).","externalDocs":{"description":"Variables documentation","url":"https://openfisca.org/doc/key-concepts/variables.html"},"name":"Variables"},{"description":"An entity is a person of a group of individuals (such as a household).","externalDocs":{"description":"Entities documentation","url":"https://openfisca.org/doc/key-concepts/person,_entities,_role.html"},"name":"Entities"},{"name":"Calculations"},{"name":"Documentation"}]}