Hebrew explanations of Israeli government forms, guides, letter templates and tools.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Run one calculator of the rules API and get outputs, a breakdown and every parameter used (effective date + official sources). Calculators: income-tax (Income tax by bracket (2020-2026)); net-salary (Net salary (gross to net, net to gross), 2026); credit-points (Credit points by profile (tax year 2026)); national-insurance (National Insurance + health contributions (employee, employer, self-employed), 2026); severance (Severance pay and its tax exemption); unemployment (Unemployment benefit: daily amount, max days, total (2026)); maternity (Maternity allowance (2026)); reserve-pay (Reserve duty compensation (2026)); work-injury (Work injury allowance (2026)); recuperation (Recuperation pay (private sector)); vacation-days (Annual leave days); notice-period (Notice period (dismissal or resignation)); vat (VAT add / remove (any date since 1976)); purchase-tax (Purchase tax on a home); car-benefit (Company car taxable benefit (2026)); rental-income-tax (Rental income tax: exemption, 10% or regular route (2026)); depreciation (Depreciation schedule (straight line)); employer-cost (Employer cost of a salary (2026)); withholding (Withholding at source from a supplier payment (2026)); surtax (Surtax (mas yesef), 2026). "inputs" must match the inputs schema whose title is the chosen "calc" (inputs.anyOf in this schema). Estimates under the general rules, not legal or tax advice.
Calculator id
Inputs of the chosen calculator: the anyOf branch whose title equals "calc"
Include every used parameter value and all sources (default: id, effective date and first source only)
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http nayeret https://nayeret.ai/mcp
Run one calculator of the rules API and get outputs, a breakdown and every parameter used (effective date + official sources). Calculators: income-tax (Income tax by bracket (2020-2026)); net-salary (Net salary (gross to net, net to gross), 2026); credit-points (Credit points by profile (tax year 2026)); national-insurance (National Insurance + health contributions (employee, employer, self-employed), 2026); severance (Severance pay and its tax exemption); unemployment (Unemployment benefit: daily amount, max days, total (2026)); maternity (Maternity allowance (2026)); reserve-pay (Reserve duty compensation (2026)); work-injury (Work injury allowance (2026)); recuperation (Recuperation pay (private sector)); vacation-days (Annual leave days); notice-period (Notice period (dismissal or resignation)); vat (VAT add / remove (any date since 1976)); purchase-tax (Purchase tax on a home); car-benefit (Company car taxable benefit (2026)); rental-income-tax (Rental income tax: exemption, 10% or regular route (2026)); depreciation (Depreciation schedule (straight line)); employer-cost (Employer cost of a salary (2026)); withholding (Withholding at source from a supplier payment (2026)); surtax (Surtax (mas yesef), 2026). "inputs" must match the inputs schema whose title is the chosen "calc" (inputs.anyOf in this schema). Estimates under the general rules, not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| calc* | string | Calculator id |
| inputs* | object | Inputs of the chosen calculator: the anyOf branch whose title equals "calc" |
| verbose | boolean | Include every used parameter value and all sources (default: id, effective date and first source only) |
{
"type": "object",
"required": [
"calc",
"inputs"
],
"properties": {
"calc": {
"enum": [
"income-tax",
"net-salary",
"credit-points",
"national-insurance",
"severance",
"unemployment",
"maternity",
"reserve-pay",
"work-injury",
"recuperation",
"vacation-days",
"notice-period",
"vat",
"purchase-tax",
"car-benefit",
"rental-income-tax",
"depreciation",
"employer-cost",
"withholding",
"surtax"
],
"type": "string",
"description": "Calculator id"
},
"inputs": {
"type": "object",
"anyOf": [
{
"type": "object",
"title": "income-tax",
"required": [
"income"
],
"properties": {
"sex": {
"enum": [
"m",
"f"
],
"type": "string",
"default": "m",
"description": "m = man (2.25 base points), f = woman (2.75)"
},
"year": {
"type": "integer",
"default": 2026,
"maximum": 2026,
"minimum": 2020,
"description": "Tax year"
},
"income": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Taxable income for the period (ILS)"
},
"period": {
"enum": [
"monthly",
"annual"
],
"type": "string",
"default": "monthly",
"description": "monthly or annual income"
},
"extra_points": {
"type": "number",
"default": 0,
"maximum": 30,
"minimum": 0,
"description": "Credit points beyond the base points (children, degree, ...)"
}
},
"description": "Inputs when calc = \"income-tax\": Income tax by bracket (2020-2026). Example: {\"year\":2026,\"period\":\"monthly\",\"income\":15000,\"sex\":\"m\"}",
"additionalProperties": false
},
{
"type": "object",
"title": "net-salary",
"required": [
"amount"
],
"properties": {
"sex": {
"enum": [
"m",
"f"
],
"type": "string",
"default": "m",
"description": "m = man (2.25 base points), f = woman (2.75)"
},
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"amount": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Gross (or the target net) per month, ILS"
},
"children": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2026,
"minimum": 2008,
"description": "Birth year of a child aged 0-18 in the tax year"
},
"maxItems": 15,
"description": "Birth years of the children (credit points are added for them)"
},
"direction": {
"enum": [
"gross_to_net",
"net_to_gross"
],
"type": "string",
"default": "gross_to_net",
"description": "gross_to_net or net_to_gross"
},
"parent_role": {
"enum": [
"main",
"other"
],
"type": "string",
"description": "Who gets the \"mother\" child points: main (the mother / parent receiving the child allowance) or other. Default: main for f, other for m (a couple living together)"
},
"extra_points": {
"type": "number",
"default": 0,
"maximum": 30,
"minimum": 0,
"description": "Credit points beyond the base points and the children (degree, discharge, oleh, reserve...)"
},
"credit_points": {
"type": "number",
"maximum": 40,
"minimum": 0,
"description": "Total credit points, if you already know them (overrides sex, children and extra_points)"
},
"single_parent": {
"type": "boolean",
"default": false,
"description": "\"Single parent\" (other parent deceased or not registered)"
},
"pension_percent": {
"type": "number",
"default": 6,
"maximum": 10,
"minimum": 0,
"description": "Employee pension deposit, percent of gross"
},
"study_fund_percent": {
"type": "number",
"default": 0,
"maximum": 5,
"minimum": 0,
"description": "Employee study fund deposit, percent"
}
},
"description": "Inputs when calc = \"net-salary\": Net salary (gross to net, net to gross), 2026. Example: {\"direction\":\"gross_to_net\",\"amount\":15000,\"sex\":\"f\",\"children\":[2023,2020],\"pension_percent\":6}",
"additionalProperties": false
},
{
"type": "object",
"title": "credit-points",
"required": [
"sex"
],
"properties": {
"sex": {
"enum": [
"m",
"f"
],
"type": "string",
"description": "m or f"
},
"year": {
"type": "integer",
"default": 2026,
"maximum": 2026,
"minimum": 2026,
"description": "Tax year (only 2026 is supported)"
},
"aliyah": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
"maxLength": 7,
"description": "Aliyah month YYYY-MM (new immigrant)"
},
"degree": {
"enum": [
"ba",
"ma"
],
"type": "string",
"description": "Completed degree"
},
"service": {
"type": "integer",
"default": 0,
"maximum": 2,
"minimum": 0,
"description": "Discharged soldier: 0 none, 2 full service, 1 short service (12+ months)"
},
"children": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2026,
"minimum": 2008,
"description": "Birth year of a child aged 0-18 in the tax year"
},
"default": [],
"maxItems": 15,
"description": "Birth years of the children"
},
"resident": {
"type": "boolean",
"default": true,
"description": "Israeli resident"
},
"discharge": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
"maxLength": 7,
"description": "Discharge month YYYY-MM"
},
"degree_year": {
"type": "integer",
"maximum": 2026,
"minimum": 2000,
"description": "Year the degree was completed"
},
"parent_role": {
"enum": [
"main",
"other"
],
"type": "string",
"description": "main = the mother / the parent receiving the child allowance; other = the other parent"
},
"study_years": {
"type": "integer",
"default": 3,
"maximum": 3,
"minimum": 1,
"description": "Years of study for the degree (1-3)"
},
"single_parent": {
"type": "boolean",
"default": false,
"description": "\"Single parent\" (other parent deceased or not registered)"
},
"monthly_salary": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Optional gross monthly salary, to cap the value at the tax you actually pay"
},
"reserve_combat_days": {
"type": "integer",
"default": 0,
"maximum": 366,
"minimum": 0,
"description": "Combat reserve days in the previous year"
}
},
"description": "Inputs when calc = \"credit-points\": Credit points by profile (tax year 2026). Example: {\"sex\":\"m\",\"children\":[2025,2022,2017],\"parent_role\":\"other\",\"reserve_combat_days\":95}",
"additionalProperties": false
},
{
"type": "object",
"title": "national-insurance",
"required": [
"role",
"income"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"role": {
"enum": [
"employee",
"employer",
"self_employed"
],
"type": "string",
"description": "employee, employer or self_employed"
},
"income": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Monthly gross salary, or the self-employed taxable income"
},
"period": {
"enum": [
"monthly",
"annual"
],
"type": "string",
"default": "monthly",
"description": "For self_employed: monthly or annual income"
}
},
"description": "Inputs when calc = \"national-insurance\": National Insurance + health contributions (employee, employer, self-employed), 2026. Example: {\"role\":\"self_employed\",\"income\":12000}",
"additionalProperties": false
},
{
"type": "object",
"title": "severance",
"required": [
"start",
"end",
"last_salary"
],
"properties": {
"end": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Employment end (YYYY-MM-DD)"
},
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"side": {
"enum": [
"employee",
"employer"
],
"type": "string",
"default": "employee",
"description": "employee or employer view"
},
"start": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Employment start (YYYY-MM-DD)"
},
"reason": {
"enum": [
"dismissal",
"entitled",
"resign"
],
"type": "string",
"default": "dismissal",
"description": "dismissal, entitled (resignation that entitles to severance) or resign (regular resignation)"
},
"section_14": {
"enum": [
"none",
"full",
"partial"
],
"type": "string",
"default": "none",
"description": "none, full (8.33%) or partial (6%)"
},
"job_history": {
"type": "array",
"items": {
"type": "object",
"required": [
"from",
"percent"
],
"properties": {
"from": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Change date (YYYY-MM-DD)"
},
"percent": {
"type": "number",
"maximum": 100,
"minimum": 1,
"description": "Job percent from this date"
}
},
"additionalProperties": false
},
"maxItems": 30,
"description": "Job percent changes: the percent from the start date is job_percent_at_start, each item a later change"
},
"job_percent": {
"type": "number",
"default": 100,
"maximum": 100,
"minimum": 1,
"description": "Job percent (when there is no history)"
},
"last_salary": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Last monthly gross salary (at the current job percent)"
},
"fund_balance": {
"type": "number",
"default": 0,
"maximum": 100000000,
"minimum": 0,
"description": "Severance component balance in the pension fund"
},
"job_percent_at_start": {
"type": "number",
"default": 100,
"maximum": 100,
"minimum": 1,
"description": "With job_history: job percent from the start date until the first change"
}
},
"description": "Inputs when calc = \"severance\": Severance pay and its tax exemption. Example: {\"start\":\"2016-01-01\",\"end\":\"2026-01-01\",\"last_salary\":20000}",
"additionalProperties": false
},
{
"type": "object",
"title": "unemployment",
"required": [
"wage",
"age"
],
"properties": {
"age": {
"type": "integer",
"maximum": 67,
"minimum": 18,
"description": "Age"
},
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"wage": {
"type": "number",
"maximum": 100000000,
"minimum": 0,
"description": "Monthly gross wage (average of the last 6 months), or the 6-month total"
},
"reason": {
"enum": [
"fired",
"justified",
"quit",
"halat"
],
"type": "string",
"default": "fired",
"description": "fired, justified, quit or halat (unpaid leave by the employer)"
},
"wage_mode": {
"enum": [
"monthly_average",
"six_month_total"
],
"type": "string",
"default": "monthly_average",
"description": "monthly_average or six_month_total"
},
"dependants": {
"type": "integer",
"default": 0,
"maximum": 20,
"minimum": 0,
"description": "Number of dependants"
},
"months_worked_last_18": {
"type": "integer",
"default": 18,
"maximum": 18,
"minimum": 0,
"description": "Insured months worked in the last 18"
},
"women_57_67_born_1960_plus": {
"type": "boolean",
"default": false,
"description": "Woman aged 57-67 born 1960 or later (300 days)"
}
},
"description": "Inputs when calc = \"unemployment\": Unemployment benefit: daily amount, max days, total (2026). Example: {\"wage\":6000,\"age\":30,\"dependants\":0}",
"additionalProperties": false
},
{
"type": "object",
"title": "maternity",
"required": [],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"babies": {
"type": "integer",
"default": 1,
"maximum": 8,
"minimum": 1,
"description": "Babies born"
},
"salary_3_months": {
"type": "number",
"default": 0,
"maximum": 100000000,
"minimum": 0,
"description": "Gross salary in the 3 months before leave (total)"
},
"salary_6_months": {
"type": "number",
"default": 0,
"maximum": 100000000,
"minimum": 0,
"description": "Gross salary in the 6 months before leave (total)"
},
"insured_months_of_14": {
"type": "integer",
"default": 0,
"maximum": 14,
"minimum": 0,
"description": "Insured months in the last 14"
},
"insured_months_of_22": {
"type": "integer",
"default": 0,
"maximum": 22,
"minimum": 0,
"description": "Insured months in the last 22"
}
},
"description": "Inputs when calc = \"maternity\": Maternity allowance (2026). Example: {\"insured_months_of_14\":12,\"salary_3_months\":36000,\"salary_6_months\":66000}",
"additionalProperties": false
},
{
"type": "object",
"title": "reserve-pay",
"required": [
"periods"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"type": {
"enum": [
"employee",
"hourly",
"self",
"none"
],
"type": "string",
"default": "employee",
"description": "employee, hourly, self (self-employed) or none (no income, e.g. student)"
},
"periods": {
"type": "array",
"items": {
"type": "object",
"required": [
"days"
],
"properties": {
"days": {
"type": "integer",
"maximum": 366,
"minimum": 1,
"description": "Service days"
},
"income_3_months": {
"type": "number",
"default": 0,
"maximum": 100000000,
"minimum": 0,
"description": "Gross income in the 3 months before the service (total)"
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 1,
"description": "One item per call-up"
}
},
"description": "Inputs when calc = \"reserve-pay\": Reserve duty compensation (2026). Example: {\"type\":\"employee\",\"periods\":[{\"income_3_months\":36000,\"days\":10}]}",
"additionalProperties": false
},
{
"type": "object",
"title": "work-injury",
"required": [
"income_3_months",
"days"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"days": {
"type": "integer",
"maximum": 366,
"minimum": 0,
"description": "Days of incapacity"
},
"type": {
"enum": [
"employee",
"self"
],
"type": "string",
"default": "employee",
"description": "employee or self (self-employed)"
},
"income_3_months": {
"type": "number",
"maximum": 100000000,
"minimum": 0,
"description": "Income in the 3 months before the injury (total)"
}
},
"description": "Inputs when calc = \"work-injury\": Work injury allowance (2026). Example: {\"type\":\"employee\",\"income_3_months\":30000,\"days\":7}",
"additionalProperties": false
},
{
"type": "object",
"title": "recuperation",
"required": [
"seniority_year"
],
"properties": {
"scope": {
"type": "number",
"default": 100,
"maximum": 400,
"minimum": 0,
"description": "Job percent, weekly hours or average monthly hours"
},
"months": {
"type": "number",
"default": 12,
"maximum": 12,
"minimum": 0,
"description": "Months of the year worked"
},
"scope_mode": {
"enum": [
"percent",
"weekly_hours",
"monthly_hours"
],
"type": "string",
"default": "percent",
"description": "percent, weekly_hours or monthly_hours"
},
"seniority_year": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Year of work at the employer (1 = first year; 20 = 20 and above)"
},
"recuperation_year": {
"type": "integer",
"default": 2026,
"maximum": 2027,
"minimum": 2024,
"description": "Recuperation year (e.g. 2026 = 1.7.2025 to 30.6.2026)"
},
"completed_first_year": {
"type": "boolean",
"default": true,
"description": "Completed a full year at the employer (required for payment)"
}
},
"description": "Inputs when calc = \"recuperation\": Recuperation pay (private sector). Example: {\"recuperation_year\":2026,\"seniority_year\":10,\"scope_mode\":\"weekly_hours\",\"scope\":18}",
"additionalProperties": false
},
{
"type": "object",
"title": "vacation-days",
"required": [
"seniority_year"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"span": {
"enum": [
"full_year",
"part_year"
],
"type": "string",
"default": "full_year",
"description": "full_year or part_year"
},
"week": {
"enum": [
"five_day_order",
"five_day_law",
"six_day"
],
"type": "string",
"default": "five_day_order",
"description": "five_day_order (5-day week, extension order applies), five_day_law (5-day, no order) or six_day"
},
"days_worked": {
"type": "integer",
"maximum": 366,
"minimum": 0,
"description": "Work days in the year (optional; below the minimum the entitlement is pro rata)"
},
"seniority_year": {
"type": "integer",
"maximum": 60,
"minimum": 1,
"description": "Calendar year of work at the employer (14 = 14 and above)"
}
},
"description": "Inputs when calc = \"vacation-days\": Annual leave days. Example: {\"seniority_year\":8,\"week\":\"five_day_order\",\"days_worked\":150}",
"additionalProperties": false
},
{
"type": "object",
"title": "notice-period",
"required": [
"start",
"notice_date"
],
"properties": {
"start": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Employment start (YYYY-MM-DD)"
},
"pay_type": {
"enum": [
"monthly",
"hourly"
],
"type": "string",
"default": "monthly",
"description": "monthly or hourly (hourly/daily paid)"
},
"notice_date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Date the notice is given (YYYY-MM-DD)"
},
"unpaid_leave_months": {
"type": "integer",
"default": 0,
"maximum": 600,
"minimum": 0,
"description": "Months of unpaid leave to exclude"
}
},
"description": "Inputs when calc = \"notice-period\": Notice period (dismissal or resignation). Example: {\"start\":\"2025-07-01\",\"notice_date\":\"2026-04-08\",\"pay_type\":\"monthly\"}",
"additionalProperties": false
},
{
"type": "object",
"title": "vat",
"required": [
"amount"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Transaction date for the rate (default today) (YYYY-MM-DD)"
},
"mode": {
"enum": [
"add",
"remove"
],
"type": "string",
"default": "add",
"description": "add or remove"
},
"amount": {
"type": "number",
"maximum": 100000000000,
"minimum": 0,
"description": "Amount (ILS)"
},
"custom_rate": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Custom rate in percent (overrides the date)"
}
},
"description": "Inputs when calc = \"vat\": VAT add / remove (any date since 1976). Example: {\"mode\":\"remove\",\"amount\":1180}",
"additionalProperties": false
},
{
"type": "object",
"title": "purchase-tax",
"required": [
"price"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Purchase date (default today) (YYYY-MM-DD)"
},
"buyer": {
"enum": [
"single",
"additional",
"oleh"
],
"type": "string",
"default": "single",
"description": "single (only home), additional, or oleh"
},
"price": {
"type": "number",
"maximum": 100000000000,
"minimum": 0,
"description": "Price of the whole property (ILS)"
},
"share_percent": {
"type": "number",
"default": 100,
"maximum": 100,
"minimum": 1,
"description": "Share bought, percent"
},
"oleh_only_home": {
"type": "boolean",
"default": true,
"description": "For olim: this will be the only home"
},
"oleh_arrived_before_2024_08_15": {
"type": "boolean",
"default": false,
"description": "Oleh who arrived before 15.8.2024 (may choose reg. 12)"
}
},
"description": "Inputs when calc = \"purchase-tax\": Purchase tax on a home. Example: {\"price\":2400000,\"buyer\":\"single\"}",
"additionalProperties": false
},
{
"type": "object",
"title": "car-benefit",
"required": [
"list_price"
],
"properties": {
"sex": {
"enum": [
"m",
"f"
],
"type": "string",
"default": "m",
"description": "m = man (2.25 base points), f = woman (2.75)"
},
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"fuel": {
"enum": [
"regular",
"hybrid",
"plugin",
"electric"
],
"type": "string",
"default": "regular",
"description": "regular, hybrid, plugin or electric"
},
"salary": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Optional monthly gross salary without the car"
},
"list_price": {
"type": "number",
"maximum": 100000000,
"minimum": 0,
"description": "Adjusted list price (ILS)"
},
"extra_points": {
"type": "number",
"default": 0,
"maximum": 30,
"minimum": 0,
"description": "Credit points beyond the base points"
},
"pension_percent": {
"type": "number",
"default": 6,
"maximum": 10,
"minimum": 0,
"description": "Employee pension percent of the salary"
}
},
"description": "Inputs when calc = \"car-benefit\": Company car taxable benefit (2026). Example: {\"list_price\":200000,\"fuel\":\"regular\",\"salary\":15000}",
"additionalProperties": false
},
{
"type": "object",
"title": "rental-income-tax",
"required": [
"monthly_rent"
],
"properties": {
"sex": {
"enum": [
"m",
"f"
],
"type": "string",
"default": "m",
"description": "m = man (2.25 base points), f = woman (2.75)"
},
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"months": {
"type": "integer",
"default": 12,
"maximum": 12,
"minimum": 1,
"description": "Months rented in the year"
},
"age_60_plus": {
"type": "boolean",
"default": false,
"description": "Owner aged 60 or more"
},
"monthly_rent": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Total monthly rent from residential apartments (ILS)"
},
"annual_expenses": {
"type": "number",
"default": 0,
"maximum": 1000000000,
"minimum": 0,
"description": "Deductible annual expenses on the apartment (regular route)"
},
"rent_paid_monthly": {
"type": "number",
"default": 0,
"maximum": 10000000,
"minimum": 0,
"description": "Rent the owner pays as a tenant per month"
},
"annual_work_income": {
"type": "number",
"default": 0,
"maximum": 1000000000,
"minimum": 0,
"description": "Other annual taxable income from work or business"
},
"sole_apartment_tenant": {
"type": "boolean",
"default": false,
"description": "Owns only this apartment and rents another to live in"
}
},
"description": "Inputs when calc = \"rental-income-tax\": Rental income tax: exemption, 10% or regular route (2026). Example: {\"monthly_rent\":7000}",
"additionalProperties": false
},
{
"type": "object",
"title": "depreciation",
"required": [
"cost",
"start"
],
"properties": {
"cost": {
"type": "number",
"maximum": 10000000000,
"minimum": 0,
"description": "Cost (ILS)"
},
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"start": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
"maxLength": 7,
"description": "Month put into use YYYY-MM"
},
"asset_type": {
"type": "string",
"pattern": "^[a-z0-9-]+$",
"maxLength": 40,
"description": "Asset type id from parameter tax.depreciation.rates (e.g. pc, furniture, car)"
},
"custom_rate": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Custom annual rate in percent (instead of asset_type)"
},
"business_percent": {
"type": "number",
"default": 100,
"maximum": 100,
"minimum": 0,
"description": "Business use percent"
}
},
"description": "Inputs when calc = \"depreciation\": Depreciation schedule (straight line). Example: {\"asset_type\":\"pc\",\"cost\":6000,\"start\":\"2026-03\"}",
"additionalProperties": false
},
{
"type": "object",
"title": "employer-cost",
"required": [
"amount"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"amount": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Gross salary, or the budget (ILS per month)"
},
"vacation": {
"type": "boolean",
"default": false,
"description": "Include a vacation provision"
},
"direction": {
"enum": [
"gross_to_cost",
"cost_to_gross"
],
"type": "string",
"default": "gross_to_cost",
"description": "gross_to_cost or cost_to_gross"
},
"job_percent": {
"type": "number",
"default": 100,
"maximum": 100,
"minimum": 1,
"description": "Job percent for recuperation"
},
"pension_base": {
"type": "number",
"default": 0,
"maximum": 10000000,
"minimum": 0,
"description": "Wage for pension deposits (0 = the whole gross)"
},
"recuperation": {
"type": "boolean",
"default": false,
"description": "Include a monthly recuperation provision"
},
"vacation_days": {
"type": "number",
"default": 12,
"maximum": 40,
"minimum": 0,
"description": "Vacation days per year"
},
"seniority_year": {
"type": "integer",
"default": 1,
"maximum": 50,
"minimum": 1,
"description": "Year of seniority for recuperation days"
},
"severance_percent": {
"type": "number",
"default": 6,
"maximum": 8.33,
"minimum": 0,
"description": "Severance percent"
},
"study_fund_percent": {
"type": "number",
"default": 0,
"maximum": 7.5,
"minimum": 0,
"description": "Employer study fund percent"
},
"employee_credit_points": {
"type": "number",
"default": 2.25,
"maximum": 40,
"minimum": 0,
"description": "Credit points for the employee net estimate (default 2.25 = man, no extra points)"
},
"pension_employer_percent": {
"type": "number",
"default": 6.5,
"maximum": 10,
"minimum": 0,
"description": "Employer pension percent"
}
},
"description": "Inputs when calc = \"employer-cost\": Employer cost of a salary (2026). Example: {\"amount\":10000}",
"additionalProperties": false
},
{
"type": "object",
"title": "withholding",
"required": [
"amount"
],
"properties": {
"base": {
"enum": [
"total",
"before_vat"
],
"type": "string",
"default": "total",
"description": "total (withhold from the whole payment incl. VAT) or before_vat"
},
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"amount": {
"type": "number",
"maximum": 10000000000,
"minimum": 0,
"description": "Payment amount (ILS)"
},
"one_time": {
"type": "boolean",
"default": false,
"description": "One-time payment"
},
"vat_mode": {
"enum": [
"incl",
"excl",
"none"
],
"type": "string",
"default": "incl",
"description": "incl (amount includes VAT), excl (VAT is added) or none"
},
"certificate": {
"enum": [
"rate",
"zero",
"books",
"none"
],
"type": "string",
"default": "none",
"description": "rate (certificate with a rate), zero (exemption), books (bookkeeping certificate only) or none"
},
"payment_type": {
"type": "string",
"default": "services",
"pattern": "^[a-z0-9-]+$",
"maxLength": 40,
"description": "Payment type id from parameter tax.withholding.regulation_rates (e.g. services, rent)"
},
"certificate_rate": {
"type": "number",
"maximum": 60,
"minimum": 0,
"description": "Rate on the certificate, percent (with certificate=rate)"
}
},
"description": "Inputs when calc = \"withholding\": Withholding at source from a supplier payment (2026). Example: {\"amount\":11800,\"vat_mode\":\"incl\",\"certificate\":\"books\"}",
"additionalProperties": false
},
{
"type": "object",
"title": "surtax",
"required": [],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "As-of date for the parameters. Default: today in Israel (YYYY-MM-DD)"
},
"work_income": {
"type": "number",
"default": 0,
"maximum": 10000000000,
"minimum": 0,
"description": "Annual taxable income from work / business"
},
"capital_income": {
"type": "number",
"default": 0,
"maximum": 10000000000,
"minimum": 0,
"description": "Annual taxable income from capital sources"
}
},
"description": "Inputs when calc = \"surtax\": Surtax (mas yesef), 2026. Example: {\"work_income\":300000,\"capital_income\":800000}",
"additionalProperties": false
}
],
"description": "Inputs of the chosen calculator: the anyOf branch whose title equals \"calc\""
},
"verbose": {
"type": "boolean",
"default": false,
"description": "Include every used parameter value and all sources (default: id, effective date and first source only)"
}
},
"additionalProperties": false
}Returns the verified checklist of documents and steps for an Israeli bureaucratic process (unemployment claim, maternity allowance, passport, car ownership transfer, address change, after birth, after the army, arnona discount, tax refund, opening an osek patur, police certificate and the forms we cover), with official links and sources. | רשימת מסמכים ושלבים לתהליך. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| process* | string | The process, as an id or in words (Hebrew or English), e.g. "unemployment claim", "דמי לידה", "passport renewal", "car ownership transfer", "form:1500", "checklist:after-birth". Known ids: checklist:address-change-bodies, checklist:after-army, checklist:after-birth, checklist:after-death, checklist:arnona-eligibility, checklist:car-transfer-documents, checklist:disabled-parking-documents, checklist:discounted-apartment-eligibility, checklist:driving-license-renewal-70, checklist:inheritance-order-documents, checklist:lasting-poa-prep, checklist:long-term-care-claim, checklist:passport-documents, checklist:small-claim-prep, checklist:special-ed-committee-documents, checklist:which-scholarship, form:100, form:101, form:106, form:116, form:119, form:1301, form:1312, form:135, form:1500, form:1514, form:159, form:161, form:17, form:18, form:211, form:250, form:2550, form:2600, form:283, form:3010, form:4, form:4435, form:502, form:5329, form:55, form:6101, form:672, form:7801, form:7810, form:821, form:830, form:857, form:867, form:900, form:car-test-poa, form:car-transfer-poa, form:green-form, form:police-complaint, form:traffic-ticket-objection, guide:address-change, guide:after-army, guide:after-death, guide:arnona-discount, guide:birth-certificate, guide:birth-grant, guide:bookkeeping-certificate, guide:business-license, guide:cancel-subscriptions, guide:capital-declaration, guide:car-ownership-transfer, guide:card-dispute, guide:child-savings, guide:close-osek-patur, guide:credit-points, guide:credit-report, guide:daycare-registration, guide:deposit-ceilings-2026, guide:disability-allowance, guide:disabled-parking-badge, guide:discounted-apartment, guide:donation-tax-credit, guide:driving-license-renewal, guide:electricity-discount, guide:employer-reports, guide:fixation-161d, guide:foreign-caregiver-employer, guide:household-employee, guide:id-appendix, guide:id-card, guide:income-support, guide:inheritance-order, guide:insurance-mountain, guide:lasting-power-of-attorney, guide:leaving-a-job, guide:long-term-care, guide:lower-internet-bill, guide:lower-management-fees, guide:maternity-benefits, guide:name-change, guide:old-age-pension, guide:open-osek-patur, guide:passport-renewal, guide:payslip, guide:police-certificate, guide:reserve-duty-pay, guide:residence-certificate, guide:returning-resident, guide:send-receipts-to-accountant, guide:severance-and-161, guide:small-claims, guide:special-education-committee, guide:starting-a-job, guide:student-scholarships, guide:survivors-pension, guide:tax-refund, guide:unemployment-benefits, guide:unpaid-leave, guide:vat-reporting |
Lists Israeli reporting and payment deadlines for a period and returns them as a structured list plus an .ics calendar file with reminders: for a business by type (osek patur, osek murshe, company; VAT frequency, income-tax advances, employees) from the published Tax Authority and National Insurance tables, or personal tax dates (annual report, tax-refund windows, employer forms). | לוח מועדים לעסק או אישי, כקובץ ליומן. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| from | string | Start of the period (default: today in Israel). The business engine always covers 12 months from this date. |
| kind* | string | business = reporting and payment duties of a business (VAT, income tax advances, withholding, National Insurance, annual reports); personal = personal tax dates (refund windows, annual report, forms from the employer) |
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| months | integer | Length of the period in months (default 12; business max 12) |
| business | object | Required when kind = business |
| reminder_days_before | integer | Add a calendar alarm this many days before each date (0 = none, default 3) |
Writes a ready-to-send Hebrew letter from one of 27 verified templates (resignation, dismissal, hearing invitation, demand, complaint, cancelling a transaction or a standing order, parking-ticket appeal, arnona discount, early lease termination, employment confirmation, recommendation and more) and returns the full text plus .docx and PDF files, the legal notice period when relevant, warnings and how to send it (e.g. registered mail). "fields" takes the chosen template's fields (its branch in the schema); missing fields stay as [label] placeholders. Nothing is sent: the person sends the letter. Same text as nayeret.ai/templates/. | מכתב מוכן מתבנית, כולל Word ו-PDF. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| tone | string | Tone id of the template (default: its first tone; ids are listed in the template's fields branch) |
| fields* | object | Field values of the chosen template, as strings: the anyOf branch whose title equals "template". Pass {} for a draft with every field as a [label] placeholder. |
| gender | object | Grammatical gender per role id of the template, e.g. {"writer":"f","to":"m"}: m, f or p (plural) |
| length | string | Length id when the template has lengths (e.g. full, whatsapp, card, short) |
Drafts an online form for an Israeli business, class, school or clinic (signup, health declaration, new employee or client details, parents' permission) from a description: Israeli field types (ID number with checksum, phone, address from the official street lists, bank and branch from the Bank of Israel list, signature, file), questions shown only after a given answer (show_if), a colour, and closing after N answers. Returns a link that opens the nayeret builder with the draft loaded; the owner reviews, types who receives the answers and publishes in their own browser, where the encryption keys are made. Answers are end-to-end encrypted: neither nayeret nor the assistant can ever read them, and this tool publishes nothing. Use it whenever someone wants a Hebrew form, a Google Forms alternative, or to collect details or signatures from people. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| intro | string | Optional short explanation shown at the top of the form. |
| theme | string | Colour of the form page (default green). |
| title* | string | Form title, e.g. "הרשמה לקייטנת קיץ". |
| fields | array | The questions in order (1-60). Leave out to start from the template. |
Full text (Markdown) of one result from search, by its id (e.g. "form:101", "guide:tax-refund"). Returns id, title, text, url and metadata.
| Argument | Type | Description |
|---|---|---|
| id* | string |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 160,
"minLength": 1
}
},
"additionalProperties": false
}Fills the official Israeli Tax Authority form 101 (טופס 101, כרטיס עובד) for tax year 2026 and returns the filled official PDF, with every value and box listed, the credit points (נקודות זיכוי) it claims and what the employee still has to sign and attach. Use when someone starting a job, or updating their details, wants form 101 filled (children, spouse, other income, credit-point reasons, tax coordination). Requires name, birth date, gender, marital status, residency and income type; the ID number is checksum-validated. The signature is never drawn. | ממלא את טופס 101 הרשמי לשנת 2026 ומחזיר PDF מוכן לחתימה. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| income* | object | Parts D and E |
| spouse | object | Part F (married employees) |
| children | array | Part C: every child under 19 in the tax year (born 2008 or later), also children who do not live with you |
| employee* | object | Part B: the employee |
| employer | object | Part A (optional, the employer usually fills it) |
Searches the verified registry of Israeli government forms by number or words and returns the current official edition, the official page, PDF and online service links, what to prepare, our plain-Hebrew guide and our filler when we have one. | חיפוש טופס רשמי: הגרסה העדכנית, קישורים ומילוי. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| limit | integer | Max results (default 5) |
| query* | string | Form number or words in Hebrew or English, e.g. "101", "טופס 161", "unemployment claim", "החזר מס" |
{
"type": "object",
"required": [
"query"
],
"properties": {
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"limit": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Max results (default 5)"
},
"query": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Form number or words in Hebrew or English, e.g. \"101\", \"טופס 161\", \"unemployment claim\", \"החזר מס\""
}
},
"additionalProperties": false
}Verified explanation of one form by its official number or id: what it is, who fills it, when, steps, documents to prepare, common mistakes, FAQ, official PDF and online-service links, sources and verification date.
| Argument | Type | Description |
|---|---|---|
| number* | string | Official form number (e.g. "101") or the id returned by search_all |
{
"type": "object",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Official form number (e.g. \"101\") or the id returned by search_all"
}
},
"additionalProperties": false
}Full text of one guide by slug (from search_all or list_guides): summary, steps, sections, FAQ, official links, sources and verification date.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Guide slug or its URL |
{
"type": "object",
"required": [
"slug"
],
"properties": {
"slug": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Guide slug or its URL"
}
},
"additionalProperties": false
}One parameter of the verified rules dataset by its dotted id (e.g. "tax.income.brackets.monthly", "credit_points.value.monthly", "btl.employee.rates", "labor.minimum_wage.monthly", "vat.rate"): the value in force on the date, its effective date, status (verified / provisional / outside coverage), full history and official source URLs.
| Argument | Type | Description |
|---|---|---|
| id* | string | Dotted parameter id (from search_parameters) |
| date | string | YYYY-MM-DD (default today). Outside the verified coverage the tool answers with an error, never a guess. |
| verbose | boolean | Full history with every value and source (default: compact history) |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Dotted parameter id (from search_parameters)"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "YYYY-MM-DD (default today). Outside the verified coverage the tool answers with an error, never a guess."
},
"verbose": {
"type": "boolean",
"default": false,
"description": "Full history with every value and source (default: compact history)"
}
},
"additionalProperties": false
}One Hebrew letter template by slug: example texts, tips, FAQ and the URL of its online generator. Example wording is general, not legal advice.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Template slug or its URL |
{
"type": "object",
"required": [
"slug"
],
"properties": {
"slug": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Template slug or its URL"
}
},
"additionalProperties": false
}From a Gregorian date of birth or death: the Hebrew date and the Gregorian dates of the Hebrew birthday, yahrzeit or bar / bat mitzvah, with the Adar and 30th-of-month rules (yahrzeit of a death in Adar of a common year in a leap year: adar1 = Ashkenazi custom, default; adar2 = Sephardi).
| Argument | Type | Description |
|---|---|---|
| adar | string | |
| date* | string | |
| from | string | List occurrences from this date (default today in Israel) |
| type* | string | |
| years | integer | |
| after_sunset | boolean |
{
"type": "object",
"required": [
"type",
"date"
],
"properties": {
"adar": {
"enum": [
"adar1",
"adar2"
],
"type": "string",
"default": "adar1"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "List occurrences from this date (default today in Israel)"
},
"type": {
"enum": [
"birthday",
"yahrzeit",
"bar_mitzvah",
"bat_mitzvah"
],
"type": "string"
},
"years": {
"type": "integer",
"default": 5,
"maximum": 50,
"minimum": 1
},
"after_sunset": {
"type": "boolean",
"default": false
}
},
"additionalProperties": false
}Business days between two dates, inclusive: Sunday to Thursday minus official rest days (Bank of Israel list incl. elections) or statutory holidays in years without a published list.
| Argument | Type | Description |
|---|---|---|
| to* | string | |
| from* | string |
{
"type": "object",
"required": [
"from",
"to"
],
"properties": {
"to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"additionalProperties": false
}Everything about one civil day in Israel: Hebrew date (and the one after sunset), holidays, fasts and national days as kept in Israel (with legal postponements), the weekly parasha (Israel), whether it is an official rest day and a business day, whether schools are closed (Ministry of Education), and optionally candle lighting / havdalah / sunrise / sunset for a city. Without a date: now in Israel (Asia/Jerusalem) and the Hebrew date in force. Each answer has answer_he / answer_en to quote and a status: computed, official (published list), statutory (law, list not yet published), unknown, estimate.
| Argument | Type | Description |
|---|---|---|
| city | string | City id for times, e.g. jerusalem, tel-aviv, haifa, beer-sheva, eilat (see the calendar page for all 24) |
| date | string | YYYY-MM-DD (omit for now in Israel) |
{
"type": "object",
"properties": {
"city": {
"type": "string",
"pattern": "^[a-z-]+$",
"maxLength": 20,
"description": "City id for times, e.g. jerusalem, tel-aviv, haifa, beer-sheva, eilat (see the calendar page for all 24)"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "YYYY-MM-DD (omit for now in Israel)"
}
},
"additionalProperties": false
}A date N days / business days / weeks / months / years after a date. Calendar periods follow the Interpretation Law 1981 s.10: the start day is not counted, month periods end on the same day number (or the last day of a shorter month), and a period whose last day is a rest day ends on the next day that is not. A specific law, court rules or a contract can set another rule; not legal advice.
| Argument | Type | Description |
|---|---|---|
| from* | string | |
| roll | string | |
| unit | string | |
| amount* | integer |
{
"type": "object",
"required": [
"from",
"amount"
],
"properties": {
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"roll": {
"enum": [
"interpretation-law",
"none"
],
"type": "string",
"default": "interpretation-law"
},
"unit": {
"enum": [
"days",
"business_days",
"weeks",
"months",
"years"
],
"type": "string",
"default": "days"
},
"amount": {
"type": "integer",
"maximum": 5000,
"minimum": -5000
}
},
"additionalProperties": false
}Holidays, fasts and national days of a Gregorian year or a Hebrew year as kept in Israel, with dates, weekdays, Hebrew dates, rest-day status and "moved_by_law" where a law postponed the day.
| Argument | Type | Description |
|---|---|---|
| year | integer | Gregorian year |
| include | string | all adds rosh chodesh, chol hamoed and each Chanukah candle |
| hebrew_year | integer | Hebrew year, e.g. 5787 |
{
"type": "object",
"properties": {
"year": {
"type": "integer",
"maximum": 2200,
"minimum": 1900,
"description": "Gregorian year"
},
"include": {
"enum": [
"main",
"all"
],
"type": "string",
"default": "main",
"description": "all adds rosh chodesh, chol hamoed and each Chanukah candle"
},
"hebrew_year": {
"type": "integer",
"maximum": 5960,
"minimum": 5660,
"description": "Hebrew year, e.g. 5787"
}
},
"additionalProperties": false
}Builds the whole personal paperwork plan for one Israeli life event: a birth, pregnancy, marriage, divorce or separation, a child starting kindergarten or school, losing or leaving a job, starting a new job, release from the IDF, long reserve duty, retirement, a death in the family, caring for an elderly parent, moving home, renting or buying a flat, buying or selling a car, aliyah or returning to Israel, opening or closing a business, or hiring a first employee. The event can be given in free words (Hebrew or English). Returns every step across all bodies (Population Authority, National Insurance, Tax Authority, employer, municipality, banks, insurers, utilities) with its class (A = Nayeret prepares the letter and the person sends it, B = co-pilot: the person files on the official site, C = a licensed professional is needed, info), the deadline computed from the official rule with its source URL, dependencies, documents to prepare, the values to copy into the official form, and an .ics calendar with reminders. Same verified data as nayeret.ai/autopilot/. | תוכנית אישית לאירוע חיים: לידה, הריון, חתונה, גירושין, גן ובית ספר, פיטורים, עבודה חדשה, שחרור, מילואים, פרישה, פטירה, הורה מבוגר, מעבר דירה, שכירת או קניית דירה, רכב, עלייה, פתיחה או סגירה של עסק, עובד ראשון, עם מועדים ממקורות רשמיים וקובץ יומן. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| date* | string | The event date (birth date, wedding, last day at work, first day at a new job, release or end of reserve service, date of death, moving or key-handover day, purchase date, the date of reaching retirement age, the day the business starts or stops, aliyah date, expected due date for a pregnancy). Past or future. |
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
List the Israeli pay, tax and benefit calculators (severance, unemployment, net salary, credit points, VAT, maternity pay and more) with the date their figures were checked.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}The change feed of the rules dataset: every parameter, form and deadline change (new tax brackets, minimum wage updates, new form editions, published deadline tables), newest detected first, with effective date, detected date and sources.
| Argument | Type | Description |
|---|---|---|
| type | string | |
| limit | integer | |
| since | string | Only changes detected on or after this date |
| offset | integer | |
| target | string | Only targets starting with this (e.g. "btl." or "101") |
| effective_to | string | Only changes that take effect on or before this date |
| effective_from | string | Only changes that take effect on or after this date (e.g. "2026-01-01" for this year) |
| include_notices | boolean | Include notices that a verified period ends (no new law) |
| include_backfill | boolean | Include history that was in the dataset when the feed started |
List every form covered, optionally only one issuer (issuer slug, e.g. tax-authority, national-insurance).
| Argument | Type | Description |
|---|---|---|
| issuer | string | Issuer slug |
{
"type": "object",
"properties": {
"issuer": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Issuer slug"
}
},
"additionalProperties": false
}List the step-by-step guides (tax refund, unemployment, severance, maternity, reserve duty and more).
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}List the Hebrew letter templates (resignation, complaint, demand, recommendation and more). Each has an online generator.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}List the in-browser tools: PDF and document tools, makers and calculators (kind: pdf, maker, calc). They run on the user's device; give the user the URL. Pass summary=true for id, name, kind and URL only, and limit/offset to page through the list.
| Argument | Type | Description |
|---|---|---|
| kind | string | |
| limit | integer | At most this many tools |
| offset | integer | |
| summary | boolean | Only id, name, kind and url per tool (much smaller) |
{
"type": "object",
"properties": {
"kind": {
"enum": [
"pdf",
"maker",
"calc"
],
"type": "string"
},
"limit": {
"type": "integer",
"default": 100,
"maximum": 100,
"minimum": 1,
"description": "At most this many tools"
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 1000,
"minimum": 0
},
"summary": {
"type": "boolean",
"default": false,
"description": "Only id, name, kind and url per tool (much smaller)"
}
},
"additionalProperties": false
}When a holiday falls next (or in the coming years), as kept in Israel. event: rh1, rh2, gedaliah, erev-yk, yk, erev-sukkot, sukkot, sukkot-chm, hoshana-raba, shmini-atzeret, oct7, zeevi, aliyah-school, rabin, sigd, ben-gurion, chanukah, chanukah8, hebrew-lang, tevet10, tubishvat, family, purim-katan, shushan-katan, esther, erev-purim, purim, shushan, aliyah, bechorot, erev-pesach, pesach, pesach-chm, pesach7, shoah, zikaron, atzmaut, herzl, pesach-sheni, lagbaomer, yerushalayim, erev-shavuot, shavuot, tammuz17, jabotinsky, erev-av, av9, tubeav, erev-rh, rc.
| Argument | Type | Description |
|---|---|---|
| after | string | YYYY-MM-DD (default today in Israel) |
| count | integer | |
| event* | string |
{
"type": "object",
"required": [
"event"
],
"properties": {
"after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "YYYY-MM-DD (default today in Israel)"
},
"count": {
"type": "integer",
"default": 3,
"maximum": 20,
"minimum": 1
},
"event": {
"enum": [
"rh1",
"rh2",
"gedaliah",
"erev-yk",
"yk",
"erev-sukkot",
"sukkot",
"sukkot-chm",
"hoshana-raba",
"shmini-atzeret",
"oct7",
"zeevi",
"aliyah-school",
"rabin",
"sigd",
"ben-gurion",
"chanukah",
"chanukah8",
"hebrew-lang",
"tevet10",
"tubishvat",
"family",
"purim-katan",
"shushan-katan",
"esther",
"erev-purim",
"purim",
"shushan",
"aliyah",
"bechorot",
"erev-pesach",
"pesach",
"pesach-chm",
"pesach7",
"shoah",
"zikaron",
"atzmaut",
"herzl",
"pesach-sheni",
"lagbaomer",
"yerushalayim",
"erev-shavuot",
"shavuot",
"tammuz17",
"jabotinsky",
"erev-av",
"av9",
"tubeav",
"erev-rh",
"rc"
],
"type": "string"
}
},
"additionalProperties": false
}Estimates an Israeli salaried employee's income-tax refund (החזר מס, טופס 135) for any of the last 6 tax years from form 106 numbers and life events, and returns the estimate per year with the bracket breakdown, a PDF worksheet of what to write in each field of form 135, the documents to attach, the filing deadline per year and the exact submission steps. Same engine as nayeret.ai/tools/tax-refund/. | בדיקת החזר מס לשכירים עם דף עזר לטופס 135. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| sex* | string | f = woman (2.75 base points), m = man (2.25) |
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| years* | array | Each tax year to check |
| exclusions | array | Situations that need an annual report (form 1301) instead of 135: business (self-employed income), controlling (controlling shareholder), foreign (foreign / trust income), other (severance spread, kibbutz member, non-listed capital gain) |
{
"type": "object",
"required": [
"sex",
"years"
],
"properties": {
"sex": {
"enum": [
"f",
"m"
],
"type": "string",
"description": "f = woman (2.75 base points), m = man (2.25)"
},
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"years": {
"type": "array",
"items": {
"type": "object",
"required": [
"year"
],
"properties": {
"year": {
"enum": [
2025,
2024,
2023,
2022,
2021,
2020
],
"type": "integer",
"description": "Tax year (2020-2025: the 6-year refund window)"
},
"events": {
"type": "array",
"items": {
"enum": [
"partial",
"multi",
"coord",
"btl",
"kids",
"single",
"soldier",
"degree",
"oleh",
"donate",
"pension",
"capital"
],
"type": "string"
},
"maxItems": 12,
"description": "What happened that year: partial (worked part of the year), multi (more than one employer), coord (did a tax coordination), btl (paid directly by National Insurance: unemployment, maternity...), kids (children up to 18), single (sole parent), soldier (discharged in the 3 years before), degree (finished a degree), oleh (new immigrant / returning resident), donate (section 46 donations), pension (own pension / life insurance deposits), capital (stock market gains/losses, form 867)",
"uniqueItems": true
},
"donations": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Section 46 donations that year, ILS"
},
"employers": {
"type": "array",
"items": {
"type": "object",
"required": [
"gross",
"tax_withheld"
],
"properties": {
"gross": {
"type": "number",
"maximum": 100000000,
"minimum": 0,
"description": "Form 106 field 158/172: taxable salary for the year, ILS"
},
"tax_withheld": {
"type": "number",
"maximum": 100000000,
"minimum": 0,
"description": "Form 106 field 042: income tax withheld, ILS"
},
"credit_points": {
"type": "number",
"maximum": 30,
"minimum": 0,
"description": "Form 106: credit points the employer gave (optional)"
}
},
"additionalProperties": false
},
"maxItems": 6,
"description": "One row per form 106"
},
"btl_payments": {
"type": "array",
"items": {
"type": "object",
"required": [
"gross",
"tax_withheld"
],
"properties": {
"gross": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Annual National Insurance payments (unemployment, maternity...), ILS"
},
"tax_withheld": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Tax withheld from them, ILS"
}
},
"additionalProperties": false
},
"maxItems": 4,
"description": "Annual certificates from National Insurance"
},
"entitled_points": {
"type": "number",
"maximum": 30,
"minimum": 0,
"description": "Credit points you were entitled to (default: the base points for sex)"
}
},
"additionalProperties": false
},
"maxItems": 6,
"description": "Each tax year to check"
},
"exclusions": {
"type": "array",
"items": {
"enum": [
"business",
"controlling",
"foreign",
"other"
],
"type": "string"
},
"maxItems": 4,
"description": "Situations that need an annual report (form 1301) instead of 135: business (self-employed income), controlling (controlling shareholder), foreign (foreign / trust income), other (severance spread, kibbutz member, non-listed capital gain)",
"uniqueItems": true
}
},
"additionalProperties": false
}Hides Israeli personal details in a text: ID numbers (checksum-validated), credit cards, bank accounts and IBAN, phone numbers, e-mails, street addresses, names after a salutation or label, car plates, birth dates. Returns the redacted text and counts per kind, never the hidden values. Use before storing, summarising or forwarding a letter or document that may contain someone's details. | הסתרת פרטים אישיים מטקסט. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| text* | string | The text to redact (up to 20000 characters). Processed in memory only; never stored or logged. |
| kinds | array | Only these kinds (default: all except case numbers). id, card, bank, iban, phone, email, address, name, plate (car), dob (birth date), caseno (case/reference numbers) |
| also_hide | array | Extra exact words or numbers to hide |
| keep_words | array | Words to leave visible even if detected (e.g. the user's own company name) |
{
"type": "object",
"required": [
"text"
],
"properties": {
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"text": {
"type": "string",
"maxLength": 20000,
"minLength": 1,
"description": "The text to redact (up to 20000 characters). Processed in memory only; never stored or logged."
},
"kinds": {
"type": "array",
"items": {
"enum": [
"id",
"card",
"bank",
"iban",
"phone",
"email",
"address",
"name",
"plate",
"dob",
"caseno"
],
"type": "string"
},
"maxItems": 11,
"description": "Only these kinds (default: all except case numbers). id, card, bank, iban, phone, email, address, name, plate (car), dob (birth date), caseno (case/reference numbers)",
"uniqueItems": true
},
"also_hide": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 20,
"description": "Extra exact words or numbers to hide"
},
"keep_words": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 20,
"description": "Words to leave visible even if detected (e.g. the user's own company name)"
}
},
"additionalProperties": false
}Runs the nayeret rights audit on a person's profile (family, work years, salary band or form 106 numbers, army service, degree, aliyah, job end, birth, disability) and returns what they are likely owed: tax refunds per year, unclaimed credit points, work grant (מענק עבודה), unemployment, maternity, reserve pay, recuperation, locality tax benefit, arnona discounts and National Insurance benefits, each with status (eligible / likely / check), amount range, deadline, documents, next actions and sources. | בדיקת זכויות: כמה כסף מגיע לי. Stateless: arguments and results are never stored, logged or shared (nayeret.ai/developers/). Not legal or tax advice.
| Argument | Type | Description |
|---|---|---|
| job | object | |
| sex* | string | |
| home | string | |
| lang | string | Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters). |
| birth | object | |
| years | object | Per tax year (2020, 2021, 2022, 2023, 2024, 2025, 2026): work status, salary band or exact form 106 numbers, benefits |
| aliyah | object | |
Search all content in Hebrew or English and return result ids for fetch. Each result has id, title and url.
| Argument | Type | Description |
|---|---|---|
| query* | string |
{
"type": "object",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}Search, in Hebrew or English, the forms, step-by-step guides, letter templates, tools/calculators and CV examples on nayeret.ai. Returns type, id, title, summary and URL; use the id with get_form, get_guide or get_template.
| Argument | Type | Description |
|---|---|---|
| type | string | Only this content type |
| limit | integer | |
| query* | string | Words or a form number, e.g. "101", "החזר מס", "severance pay" |
{
"type": "object",
"required": [
"query"
],
"properties": {
"type": {
"enum": [
"form",
"guide",
"template",
"tool",
"cv"
],
"type": "string",
"description": "Only this content type"
},
"limit": {
"type": "integer",
"default": 8,
"maximum": 20,
"minimum": 1
},
"query": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Words or a form number, e.g. \"101\", \"החזר מס\", \"severance pay\""
}
},
"additionalProperties": false
}Find Israeli government and health-fund forms by official number or words (e.g. "101", "החזר מס", "severance"). Returns number, title, issuer, summary and URL.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| query* | string |
{
"type": "object",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"default": 5,
"maximum": 20,
"minimum": 1
},
"query": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
},
"additionalProperties": false
}Search the verified rules dataset (tax brackets, credit points, National Insurance rates and ceilings, minimum wage, VAT, benefits, fees...) by words or id prefix. Returns ids, units and the value in force on a date; then call get_parameter for history and sources.
| Argument | Type | Description |
|---|---|---|
| date | string | YYYY-MM-DD (default today) |
| limit | integer | |
| query | string | Words, e.g. "minimum wage", "credit point", "unemployment", "VAT" |
| prefix | string | Id prefix, e.g. "btl." or "tax.income" |
{
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "YYYY-MM-DD (default today)"
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1
},
"query": {
"type": "string",
"maxLength": 100,
"description": "Words, e.g. \"minimum wage\", \"credit point\", \"unemployment\", \"VAT\""
},
"prefix": {
"type": "string",
"pattern": "^[a-z0-9_.]*$",
"maxLength": 100,
"description": "Id prefix, e.g. \"btl.\" or \"tax.income\""
}
},
"additionalProperties": false
}Candle lighting and havdalah for the Shabbat around a date (and the day itself when it is a yom tov), plus sunrise and sunset, for 24 Israeli cities. Sea-level sunset (Jerusalem: sunset seen from 800 m); candles by local custom (Jerusalem 40 min, Tel Aviv 22, Haifa 30, most cities 20), matching the Ministry of Religious Services table; havdalah at 8.5 degrees. Israel time, rounded to the minute.
| Argument | Type | Description |
|---|---|---|
| city | string | |
| date | string | YYYY-MM-DD (default today in Israel) |
{
"type": "object",
"properties": {
"city": {
"type": "string",
"default": "jerusalem",
"pattern": "^[a-z-]+$",
"maxLength": 20
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "YYYY-MM-DD (default today in Israel)"
}
},
"additionalProperties": false
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 17, 2026.
{
"type": "object",
"required": [
"process"
],
"properties": {
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"process": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "The process, as an id or in words (Hebrew or English), e.g. \"unemployment claim\", \"דמי לידה\", \"passport renewal\", \"car ownership transfer\", \"form:1500\", \"checklist:after-birth\". Known ids: checklist:address-change-bodies, checklist:after-army, checklist:after-birth, checklist:after-death, checklist:arnona-eligibility, checklist:car-transfer-documents, checklist:disabled-parking-documents, checklist:discounted-apartment-eligibility, checklist:driving-license-renewal-70, checklist:inheritance-order-documents, checklist:lasting-poa-prep, checklist:long-term-care-claim, checklist:passport-documents, checklist:small-claim-prep, checklist:special-ed-committee-documents, checklist:which-scholarship, form:100, form:101, form:106, form:116, form:119, form:1301, form:1312, form:135, form:1500, form:1514, form:159, form:161, form:17, form:18, form:211, form:250, form:2550, form:2600, form:283, form:3010, form:4, form:4435, form:502, form:5329, form:55, form:6101, form:672, form:7801, form:7810, form:821, form:830, form:857, form:867, form:900, form:car-test-poa, form:car-transfer-poa, form:green-form, form:police-complaint, form:traffic-ticket-objection, guide:address-change, guide:after-army, guide:after-death, guide:arnona-discount, guide:birth-certificate, guide:birth-grant, guide:bookkeeping-certificate, guide:business-license, guide:cancel-subscriptions, guide:capital-declaration, guide:car-ownership-transfer, guide:card-dispute, guide:child-savings, guide:close-osek-patur, guide:credit-points, guide:credit-report, guide:daycare-registration, guide:deposit-ceilings-2026, guide:disability-allowance, guide:disabled-parking-badge, guide:discounted-apartment, guide:donation-tax-credit, guide:driving-license-renewal, guide:electricity-discount, guide:employer-reports, guide:fixation-161d, guide:foreign-caregiver-employer, guide:household-employee, guide:id-appendix, guide:id-card, guide:income-support, guide:inheritance-order, guide:insurance-mountain, guide:lasting-power-of-attorney, guide:leaving-a-job, guide:long-term-care, guide:lower-internet-bill, guide:lower-management-fees, guide:maternity-benefits, guide:name-change, guide:old-age-pension, guide:open-osek-patur, guide:passport-renewal, guide:payslip, guide:police-certificate, guide:reserve-duty-pay, guide:residence-certificate, guide:returning-resident, guide:send-receipts-to-accountant, guide:severance-and-161, guide:small-claims, guide:special-education-committee, guide:starting-a-job, guide:student-scholarships, guide:survivors-pension, guide:tax-refund, guide:unemployment-benefits, guide:unpaid-leave, guide:vat-reporting"
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"kind"
],
"properties": {
"from": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Start of the period (default: today in Israel). The business engine always covers 12 months from this date."
},
"kind": {
"enum": [
"business",
"personal"
],
"type": "string",
"description": "business = reporting and payment duties of a business (VAT, income tax advances, withholding, National Insurance, annual reports); personal = personal tax dates (refund windows, annual report, forms from the employer)"
},
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"months": {
"type": "integer",
"maximum": 24,
"minimum": 1,
"description": "Length of the period in months (default 12; business max 12)"
},
"business": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"patur",
"murshe",
"company"
],
"type": "string",
"description": "patur = osek patur (exempt dealer), murshe = osek murshe (licensed dealer), company = company (Ltd)"
},
"employees": {
"type": "integer",
"maximum": 9999,
"minimum": 0,
"description": "Number of employees (adds withholding and employer reports)"
},
"detailed_vat": {
"type": "boolean",
"description": "Files the detailed VAT report (PCN874)"
},
"vat_frequency": {
"enum": [
"monthly",
"bimonthly"
],
"type": "string",
"description": "VAT reporting frequency (not for patur). Default bimonthly"
},
"business_start": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Business opening date (no duties before it)"
},
"micro_business": {
"type": "boolean",
"description": "Osek patur that is a \"small business\" (עסק זעיר) with the simplified annual report"
},
"online_reporting": {
"type": "boolean",
"description": "Reports online (later online due dates). Default true"
},
"income_tax_advances": {
"enum": [
"monthly",
"bimonthly",
"none"
],
"type": "string",
"description": "Income tax advance payments. Default monthly"
},
"withholding_frequency": {
"enum": [
"monthly",
"bimonthly"
],
"type": "string"
},
"pays_national_insurance": {
"type": "boolean",
"description": "Pays National Insurance as self-employed (default true; not for companies)"
}
},
"description": "Required when kind = business",
"additionalProperties": false
},
"reminder_days_before": {
"type": "integer",
"maximum": 30,
"minimum": 0,
"description": "Add a calendar alarm this many days before each date (0 = none, default 3)"
}
},
"additionalProperties": false
}| formats | array | Files to attach (default docx + pdf). The text is always in the answer. |
| template* | string | Letter template id. apology-letter = מכתב התנצלות; arnona-discount-request = מכתב בקשה להנחה בארנונה; birthday-letter = מכתב ליום הולדת; cancel-insurance-policy = מכתב ביטול פוליסת ביטוח; cancel-standing-order = מכתב ביטול מנוי והוראת קבע; cancel-transaction-letter = מכתב ביטול עסקה; card-dispute-letter = מכתב הכחשת עסקה בכרטיס אשראי; complaint-letter = מכתב תלונה; condolence-letter = מכתב תנחומים; demand-letter = מכתב התראה לפני תביעה; dismissal-decision = מכתב החלטה לאחר שימוע; dismissal-letter = מכתב פיטורים; employment-confirmation = אישור העסקה; employment-termination = מכתב סיום העסקה; farewell-letter = מכתב פרידה; flight-compensation-claim = מכתב דרישה לפיצוי מחברת תעופה; formal-letter = מכתב רשמי; hearing-invitation = הזמנה לשימוע; hearing-protocol = פרוטוקול שימוע; lease-early-termination = הודעה על סיום חוזה שכירות לפני הזמן; management-fees-request = מכתב בקשה להפחתת דמי ניהול; parking-ticket-appeal = בקשה לביטול דוח חניה; raise-request-letter = מכתב בקשה להעלאה בשכר; recommendation-letter = מכתב המלצה; resignation-letter = מכתב התפטרות; resignation-warning-letter = מכתב התראה למעסיק לפני התפטרות; thank-you-letter = מכתב תודה |
{
"type": "object",
"required": [
"template",
"fields"
],
"properties": {
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"tone": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Tone id of the template (default: its first tone; ids are listed in the template's fields branch)"
},
"fields": {
"type": "object",
"anyOf": [
{
"type": "object",
"title": "apology-letter",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "שם. e.g. \"יעל\""
},
"kind": {
"enum": [
"partner",
"friend",
"family",
"teacher",
"work"
],
"type": "string",
"description": "למי ההתנצלות. Options: partner = לבן או לבת הזוג; friend = לחבר או לחברה; family = לבן משפחה; teacher = למורה או למחנך/ת; work = לעמית, ללקוח או למנהל/ת"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם שלכם. e.g. \"עומר\""
},
"what": {
"type": "string",
"maxLength": 2000,
"description": "מה קרה. במשפט מלא, בלי להקטין. e.g. \"ביום שישי לא הגעתי לארוחה שהבטחתי, ולא עניתי לטלפון כל הערב.\""
},
"change": {
"type": "string",
"maxLength": 2000,
"description": "מה תעשו אחרת. לא חובה. e.g. \"מעכשיו, אם משהו משתנה, אני מודיע מיד, גם בהודעה קצרה.\""
},
"impact": {
"type": "string",
"maxLength": 2000,
"description": "מה זה גרם לצד השני. לא חובה, אבל זה מה שעושה את ההבדל. e.g. \"השארתי אותך לחכות ולדאוג, מול כל המשפחה.\""
}
},
"description": "Fields when template = \"apology-letter\" (מכתב התנצלות). All optional: a missing field stays as a [label] placeholder. tone: heart|formal; length: whatsapp|full; gender roles: writer, to.",
"additionalProperties": false
},
{
"type": "object",
"title": "arnona-discount-request",
"properties": {
"city": {
"type": "string",
"maxLength": 200,
"description": "שם הרשות המקומית. e.g. \"עיריית דוגמה\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך (YYYY-MM-DD)"
},
"docs": {
"type": "string",
"maxLength": 2000,
"description": "המסמכים שמצורפים. e.g. \"אישור מהמוסד לביטוח לאומי על קבלת קצבה; צילום תעודת זהות וספח\""
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "לבקש את ההנחה החל מ. ריק = מהשנה הנוכחית (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"רחל לוי\""
},
"idnum": {
"type": "string",
"maxLength": 200,
"description": "מספר תעודת זהות. e.g. \"000000000\""
},
"retro": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "לבקש גם הנחה רטרואקטיבית לתקופה שבה הייתי זכאי/ת ולא ביקשתי"
},
"ground": {
"enum": [
"senior_income",
"senior_support",
"senior_allowance",
"disability",
"disabled_child",
"nursing",
"immigrant",
"single_parent",
"low_income",
"needy",
"soldier",
"reserve",
"other"
],
"type": "string",
"description": "העילה להנחה. Options: senior_income = אזרח/ית ותיק/ה עם הכנסה עד השכר הממוצע במשק; senior_support = אזרח/ית ותיק/ה עם השלמת הכנסה; senior_allowance = מקבל/ת קצבת זקנה או שאירים; disability = נכות (קצבת נכות או נכות רפואית); disabled_child = הורה לילד עם גמלת ילד נכה; nursing = מקבל/ת גמלת סיעוד; immigrant = עולה חדש/ה; single_parent = הורה עצמאי (הורה יחיד); low_income = הכנסה נמוכה (מבחן הכנסה); needy = מצוקה: הוצאות רפואיות חריגות או הרעה פתאומית במצב הכלכלי; soldier = חייל/ת בשירות חובה או עד 4 חודשים מהשחרור; reserve = משרת/ת מילואים פעיל/ה; other = עילה אחרת"
},
"people": {
"type": "string",
"maxLength": 40,
"description": "מספר הנפשות בדירה. כולל אתכם. e.g. \"3\". only when ground=low_income|needy|senior_income (a number, as text)"
},
"account": {
"type": "string",
"maxLength": 200,
"description": "מספר משלם או מספר נכס בארנונה. מופיע בחשבון הארנונה. e.g. \"123456789\""
},
"address": {
"type": "string",
"maxLength": 200,
"description": "כתובת הנכס. e.g. \"רחוב הדקל 5 דירה 3\""
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "טלפון או מייל לתשובה. e.g. \"050-0000000\""
},
"needy_reason": {
"type": "string",
"maxLength": 2000,
"description": "מה קרה, בקצרה. e.g. \"בחודש מרץ פוטרתי מעבודתי, ובאותה תקופה אובחנה אצלי מחלה שמחייבת טיפולים שאינם בסל.\". only when ground=needy"
},
"other_ground": {
"type": "string",
"maxLength": 200,
"description": "העילה במילים שלכם. e.g. \"בן משפחה של חלל צה\"ל\". only when ground=other"
}
},
"description": "Fields when template = \"arnona-discount-request\" (מכתב בקשה להנחה בארנונה). All optional: a missing field stays as a [label] placeholder. tone: formal; gender roles: writer.",
"additionalProperties": false
},
{
"type": "object",
"title": "birthday-letter",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "שם או כינוי. e.g. \"נועה\""
},
"age": {
"type": "string",
"maxLength": 200,
"description": "הגיל החדש. לא חובה. e.g. \"16\""
},
"rel": {
"enum": [
"child",
"parent",
"partner",
"friend",
"sibling"
],
"type": "string",
"description": "למי המכתב. Options: child = מהורה לילד/ה, למשל מאמא לבת; parent = לאמא או לאבא; partner = לבן או לבת הזוג; friend = לחבר או לחברה; sibling = לאח או לאחות"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "חתימה. e.g. \"אמא\""
},
"wish": {
"type": "string",
"maxLength": 2000,
"description": "מה אתם מאחלים. לא חובה. e.g. \"שתמשיכי להיות בדיוק את, גם כשקשה.\""
},
"memory": {
"type": "string",
"maxLength": 2000,
"description": "זיכרון אחד. הכי חשוב במכתב. e.g. \"כשהיית בת חמש התעקשת לאפות לבד עוגה ליום ההולדת שלי. היא הייתה מלוחה, ואכלתי שתי פרוסות.\""
},
"quality": {
"type": "string",
"maxLength": 200,
"description": "מה הכי מיוחד בו או בה. e.g. \"הצחוק המתגלגל והלב הגדול\""
}
},
"description": "Fields when template = \"birthday-letter\" (מכתב ליום הולדת). All optional: a missing field stays as a [label] placeholder. tone: moving|light; length: card|whatsapp|full; gender roles: writer, to.",
"additionalProperties": false
},
{
"type": "object",
"title": "cancel-insurance-policy",
"properties": {
"so": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "דמי הביטוח נגבים בהוראת קבע או בכרטיס אשראי"
},
"to": {
"type": "string",
"maxLength": 200,
"description": "שם חברת הביטוח. e.g. \"חברת ביטוח דוגמה בע\"מ\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך ההודעה (YYYY-MM-DD)"
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך הביטול. לא מוקדם מ-3 ימים אחרי שההודעה תגיע לחברה. only when when=date (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"מיכל לוי\""
},
"when": {
"enum": [
"now",
"date"
],
"type": "string",
"description": "ממתי לבטל. Options: now = מיד, לפי המועד שבחוק; date = מתאריך מסוים"
},
"ptype": {
"enum": [
"health",
"illness",
"ltc",
"life",
"car",
"home",
"other"
],
"type": "string",
"description": "סוג הביטוח. Options: health = ביטוח בריאות (ניתוחים, תרופות, השתלות); illness = מחלות קשות או תאונות אישיות; ltc = ביטוח סיעודי; life = ביטוח חיים; car = ביטוח רכב (מקיף או צד שלישי); home = ביטוח דירה או מבנה; other = אחר"
},
"idlast": {
"type": "string",
"maxLength": 200,
"description": "4 הספרות האחרונות של תעודת הזהות. לא חובה. עוזר לזהות אתכם. e.g. \"1234\""
},
"policy": {
"type": "string",
"maxLength": 200,
"description": "מספר הפוליסה. מופיע בדף הפרטים של הפוליסה, באזור האישי או בהר הביטוח. e.g. \"123456789\""
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "טלפון או מייל לאישור. לא חובה. e.g. \"050-0000000\""
}
},
"description": "Fields when template = \"cancel-insurance-policy\" (מכתב ביטול פוליסת ביטוח). All optional: a missing field stays as a [label] placeholder. tone: formal; gender roles: writer.",
"additionalProperties": false
},
{
"type": "object",
"title": "cancel-standing-order",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "שם העסק, הבנק או חברת האשראי. e.g. \"מועדון כושר דוגמה\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך ההודעה (YYYY-MM-DD)"
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "להפסיק את החיוב מתאריך. ריק = בהקדם. only when kind=provider|card (YYYY-MM-DD)"
},
"kind": {
"enum": [
"provider",
"bank",
"card"
],
"type": "string",
"description": "למי כותבים. Options: provider = לעסק שנותן את השירות: חדר כושר, סלולר, טלוויזיה, אפליקציה; bank = לבנק: ביטול הוראת קבע (הרשאה לחיוב חשבון); card = לחברת כרטיסי האשראי: הפסקת חיוב קבוע בכרטיס"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"דנה כהן\""
},
"told": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "כבר הודעתי לעסק עצמו על ביטול המנוי. only when kind=bank|card"
},
"card4": {
"type": "string",
"maxLength": 200,
"description": "4 הספרות האחרונות של הכרטיס. אף פעם לא את המספר המלא. e.g. \"1234\". only when kind=card"
},
"idnum": {
"type": "string",
"maxLength": 200,
"description": "מספר תעודת זהות. בביטול עסקה מתמשכת יש לציין שם ומספר זהות. e.g. \"000000000\""
},
"payee": {
"type": "string",
"maxLength": 200,
"description": "שם בית העסק שגובה את הכסף. e.g. \"חברת דוגמה תקשורת בע\"מ\". only when kind=bank|card"
},
"refund": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "לבטל גם חיוב שכבר ירד (עד 3 ימי עסקים מיום החיוב). only when kind=bank"
},
"account": {
"type": "string",
"maxLength": 200,
"description": "מספר סניף וחשבון. e.g. \"סניף 123, חשבון 456789\". only when kind=bank"
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "טלפון או מייל לאישור. לא חובה. e.g. \"050-0000000\""
},
"service": {
"type": "string",
"maxLength": 200,
"description": "המנוי או השירות. e.g. \"מנוי חודשי לחדר הכושר\". only when kind=provider"
},
"auth_ref": {
"type": "string",
"maxLength": 200,
"description": "מספר ההרשאה או האסמכתא. מופיע בדף החשבון או באתר הבנק. לא חובה. e.g. \"12345678\". only when kind=bank"
},
"customer": {
"type": "string",
"maxLength": 200,
"description": "מספר לקוח או מנוי. e.g. \"78910\". only when kind=provider"
},
"charge_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך החיוב לביטול. only when kind=bank&refund (YYYY-MM-DD)"
},
"charge_amount": {
"type": "string",
"maxLength": 200,
"description": "סכום החיוב. e.g. \"149 ₪\". only when kind=bank&refund"
}
},
"description": "Fields when template = \"cancel-standing-order\" (מכתב ביטול מנוי והוראת קבע). All optional: a missing field stays as a [label] placeholder. tone: formal.",
"additionalProperties": false
},
{
"type": "object",
"title": "cancel-transaction-letter",
"properties": {
"pay": {
"enum": [
"credit",
"cash",
"standing"
],
"type": "string",
"description": "איך שילמתם. Options: credit = כרטיס אשראי; cash = מזומן או העברה; standing = הוראת קבע"
},
"cust": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"דנה כהן\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך ההודעה (YYYY-MM-DD)"
},
"deal": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך העסקה (YYYY-MM-DD)"
},
"from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "להפסיק את החיוב מתאריך. השאירו ריק כדי להפסיק בהקדם. only when kind=ongoing (YYYY-MM-DD)"
},
"item": {
"type": "string",
"maxLength": 200,
"description": "המוצר או השירות. e.g. \"שואב אבק אלחוטי, דגם X\""
},
"kind": {
"enum": [
"distance",
"ongoing",
"store"
],
"type": "string",
"description": "סוג העסקה. Options: distance = רכישה באינטרנט או בטלפון (אתר ישראלי); ongoing = ביטול מנוי או עסקה מתמשכת: חדר כושר, סלולר, טלוויזיה; store = רכישה בחנות"
},
"what": {
"enum": [
"product",
"service"
],
"type": "string",
"description": "מה נקנה. only when kind=distance. Options: product = מוצר; service = שירות"
},
"idnum": {
"type": "string",
"maxLength": 200,
"description": "מספר תעודת זהות. בביטול עסקה מתמשכת יש לציין שם ומספר זהות. e.g. \"000000000\". only when kind=ongoing"
},
"order": {
"type": "string",
"maxLength": 200,
"description": "מספר הזמנה, לקוח או מנוי. e.g. \"123456\""
},
"amount": {
"type": "string",
"maxLength": 200,
"description": "סכום ששולם. e.g. \"899 ₪\". only when kind=distance|store"
},
"reason": {
"enum": [
"",
"defect",
"late",
"mismatch"
],
"type": "string",
"description": "סיבת הביטול. only when kind=distance|store. Options: \"\" = בלי סיבה, זכות הביטול הרגילה; defect = פגם במוצר; late = לא סופק במועד שנקבע; mismatch = לא תואם למה שהוזמן"
},
"senior": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "אני בן/בת 65 ומעלה, אדם עם מוגבלות או עולה חדש/ה, והעסקה נעשתה בשיחה עם נציג. only when kind=distance"
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "טלפון או מייל לחזרה. לא חובה. e.g. \"050-0000000\""
},
"business": {
"type": "string",
"maxLength": 200,
"description": "שם בית העסק. e.g. \"חנות דוגמה בע\"מ\""
},
"received": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך קבלת המוצר. only when kind=distance|store (YYYY-MM-DD)"
}
},
"description": "Fields when template = \"cancel-transaction-letter\" (מכתב ביטול עסקה). All optional: a missing field stays as a [label] placeholder. tone: formal; gender roles: writer.",
"additionalProperties": false
},
{
"type": "object",
"title": "card-dispute-letter",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "חברת האשראי או הבנק. e.g. \"חברת כרטיסי אשראי דוגמה\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"מיכל לוי\""
},
"card4": {
"type": "string",
"maxLength": 200,
"description": "4 ספרות אחרונות של הכרטיס. e.g. \"1234\""
},
"idnum": {
"type": "string",
"maxLength": 200,
"description": "מספר זהות. e.g. \"000000000\""
},
"tdate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך העסקה (YYYY-MM-DD)"
},
"agreed": {
"type": "string",
"maxLength": 200,
"description": "הסכום שהסכמתי לו (₪). only when reason=amount"
},
"amount": {
"type": "string",
"maxLength": 200,
"description": "הסכום שחויב (₪). e.g. \"249\""
},
"reason": {
"enum": [
"notme",
"double",
"amount",
"cancelled"
],
"type": "string",
"description": "מה קרה. Options: notme = לא ביצעתי את העסקה; double = חויבתי פעמיים על אותה עסקה; amount = הסכום גבוה ממה שהסכמתי; cancelled = ביטלתי, והחיוב ממשיך"
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "מייל או טלפון לתשובה"
},
"merchant": {
"type": "string",
"maxLength": 200,
"description": "שם בית העסק כפי שמופיע בפירוט. e.g. \"חנות לדוגמה\""
},
"cancel_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "מתי ביטלתם. only when reason=cancelled (YYYY-MM-DD)"
}
},
"description": "Fields when template = \"card-dispute-letter\" (מכתב הכחשת עסקה בכרטיס אשראי). All optional: a missing field stays as a [label] placeholder. tone: formal.",
"additionalProperties": false
},
{
"type": "object",
"title": "complaint-letter",
"properties": {
"ref": {
"type": "string",
"maxLength": 200,
"description": "מספר הזמנה, לקוח או פנייה. לא חובה. e.g. \"ORD-77812\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"days": {
"enum": [
"14",
"7"
],
"type": "string",
"description": "תשובה בתוך. Options: 14 = 14 ימים; 7 = 7 ימים"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"שרון אבידן\""
},
"want": {
"enum": [
"fix",
"replace",
"refund",
"credit",
"cancel",
"other"
],
"type": "string",
"description": "מה אתם מבקשים. Options: fix = תיקון; replace = החלפה; refund = החזר כספי; credit = זיכוי בחשבון; cancel = ביטול שירות; other = אחר"
},
"attach": {
"type": "string",
"maxLength": 200,
"description": "מסמכים מצורפים. לא חובה. e.g. \"חשבונית, דוח הטכנאי, תמונות של התקלה\""
},
"company": {
"type": "string",
"maxLength": 200,
"description": "שם החברה והמחלקה. e.g. \"שירות לקוחות, חברת דוגמה בע\"מ\""
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "טלפון או מייל. e.g. \"050-0000000\""
},
"problem": {
"type": "string",
"maxLength": 2000,
"description": "מה קרה. e.g. \"המכונה הפסיקה לעבוד אחרי שבועיים. טכנאי הגיע ביום 22.09.2026 ולא תיקן, ומאז שתי פניות לא נענו.\""
},
"product": {
"type": "string",
"maxLength": 200,
"description": "על מה התלונה. e.g. \"מכונת כביסה שנרכשה ביום 02.09.2026\""
}
},
"description": "Fields when template = \"complaint-letter\" (מכתב תלונה). All optional: a missing field stays as a [label] placeholder. tone: formal|firm.",
"additionalProperties": false
},
{
"type": "object",
"title": "condolence-letter",
"properties": {
"dg": {
"enum": [
"m",
"f"
],
"type": "string",
"description": "הנפטר/ת. Options: m = נפטר; f = נפטרה"
},
"to": {
"type": "string",
"maxLength": 200,
"description": "שם האבל/ה או המשפחה. e.g. \"משפחת אברהם\""
},
"aud": {
"enum": [
"fam",
"one"
],
"type": "string",
"description": "המכתב מופנה אל. Options: fam = משפחה או כמה אנשים; one = אדם אחד"
},
"org": {
"type": "string",
"maxLength": 200,
"description": "שם מקום העבודה או הצוות. רק לנוסח הרשמי, בלשון רבים. e.g. \"הנהלת ועובדי חברת דוגמה\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך (YYYY-MM-DD)"
},
"help": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "להציע עזרה מעשית"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם שלכם. e.g. \"ליאת\""
},
"memory": {
"type": "string",
"maxLength": 2000,
"description": "זיכרון או מילה טובה. לא חובה, אבל זה מה שנשאר. e.g. \"תמיד היה הראשון להציע עזרה, והצחוק שלו מילא כל חדר.\""
},
"blessing": {
"enum": [
"trad",
"sec",
""
],
"type": "string",
"description": "ברכת סיום. Options: trad = המקום ינחם; sec = שלא תדעו עוד צער; \"\" = בלי ברכה"
},
"deceased": {
"type": "string",
"maxLength": 200,
"description": "שם הנפטר/ת. e.g. \"משה אברהם ז\"ל\""
}
},
"description": "Fields when template = \"condolence-letter\" (מכתב תנחומים). All optional: a missing field stays as a [label] placeholder. tone: warm|formal; gender roles: writer.",
"additionalProperties": false
},
{
"type": "object",
"title": "demand-letter",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "שם החייב/ת או העסק. e.g. \"יוסי מזרחי\""
},
"pay": {
"type": "string",
"maxLength": 200,
"description": "איך לשלם. לא חובה. e.g. \"העברה בנקאית לחשבון שמופיע בחשבונית, או בביט למספר 050-0000000\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"days": {
"enum": [
"14",
"7",
"30"
],
"type": "string",
"description": "כמה זמן לתת. Options: 14 = 14 ימים; 7 = 7 ימים; 30 = 30 ימים"
},
"kind": {
"enum": [
"unpaid",
"refund",
"deposit",
"damage",
"other"
],
"type": "string",
"description": "על מה החוב. Options: unpaid = לקוח שלא שילם על עבודה או שירות; refund = החזר כספי שלא התקבל; deposit = פיקדון שכירות שלא הוחזר; damage = נזק שלא שולם עליו פיצוי; other = אחר"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"גלית אורן\""
},
"basis": {
"type": "string",
"maxLength": 200,
"description": "על מה מדובר, במשפט אחד. e.g. \"עיצוב אתר לפי הצעת מחיר מיום 03.05.2026, חשבונית מספר 1043\""
},
"amount": {
"type": "string",
"maxLength": 40,
"description": "הסכום בשקלים. e.g. \"6400\" (a number, as text)"
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "טלפון לתיאום. לא חובה. e.g. \"050-0000000\""
}
},
"description": "Fields when template = \"demand-letter\" (מכתב התראה לפני תביעה). All optional: a missing field stays as a [label] placeholder. tone: formal|warm.",
"additionalProperties": false
},
{
"type": "object",
"title": "dismissal-decision",
"properties": {
"pay": {
"enum": [
"monthly",
"hourly"
],
"type": "string",
"description": "אופן תשלום השכר. only when outcome=dismiss. Options: monthly = משכורת חודשית; hourly = שכר לפי שעה או יום"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"last": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "יום העבודה האחרון. לפי ימי ההודעה המוקדמת. only when outcome=dismiss (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "שם העובד/ת. e.g. \"אורי שמעוני\""
},
"plan": {
"type": "string",
"maxLength": 2000,
"description": "מה נדרש או מה משתנה. e.g. \"הגעה בזמן לכל המשמרות, והעברת הדוח החודשי עד ה-5 בכל חודש.\". only when outcome=warn|change"
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"רכז מכירות\""
},
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך תחילת העבודה. לחישוב ההודעה המוקדמת. only when outcome=dismiss (YYYY-MM-DD)"
},
"notice": {
"enum": [
"work",
"pay"
],
"type": "string",
"description": "ההודעה המוקדמת. only when outcome=dismiss. Options: work = העובד/ת ממשיך/ה לעבוד עד היום האחרון; pay = ויתור על עבודה ותשלום חלף הודעה מוקדמת"
},
"review": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "מועד בחינה מחדש. only when outcome=warn (YYYY-MM-DD)"
},
"signer": {
"type": "string",
"maxLength": 200,
"description": "שם החותם ותפקידו. e.g. \"מיכל ברק, מנהלת משאבי אנוש\""
},
"hearing": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך השימוע (YYYY-MM-DD)"
},
"outcome": {
"enum": [
"dismiss",
"warn",
"change",
"stay"
],
"type": "string",
"description": "ההחלטה. Options: dismiss = סיום העסקה; warn = המשך העסקה, עם התראה ותוכנית שיפור; change = המשך העסקה בתפקיד או בתנאים אחרים; stay = המשך העסקה ללא שינוי"
},
"written": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "העובד/ת מסר/ה גם טענות או מסמכים בכתב"
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה או המעסיק. e.g. \"חברת דוגמה בע\"מ\""
},
"effective": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "מועד השינוי. only when outcome=change (YYYY-MM-DD)"
},
"considered": {
"type": "string",
"maxLength": 2000,
"description": "התייחסות לטענות העובד/ת. הכי חשוב: מה נשקל ומה השפיע. e.g. \"שקלנו את ההסבר לגבי האיחור ב-3.9 וקיבלנו אותו. לגבי האיחור ב-17.9 והדוח החודשי, לא הוצג הסבר שמשנה את התמונה.\""
}
},
"description": "Fields when template = \"dismissal-decision\" (מכתב החלטה לאחר שימוע). All optional: a missing field stays as a [label] placeholder. tone: formal|considerate; gender roles: to.",
"additionalProperties": false
},
{
"type": "object",
"title": "dismissal-letter",
"properties": {
"pay": {
"enum": [
"monthly",
"hourly"
],
"type": "string",
"description": "אופן תשלום השכר. Options: monthly = משכורת חודשית; hourly = שכר לפי שעה או יום"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"last": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "יום העבודה האחרון. לפי ימי ההודעה המוקדמת (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "שם העובד/ת. e.g. \"אורי שמעוני\""
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"רכז מכירות\""
},
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך תחילת העבודה. לחישוב ההודעה המוקדמת (YYYY-MM-DD)"
},
"notice": {
"enum": [
"work",
"pay"
],
"type": "string",
"description": "ההודעה המוקדמת. Options: work = העובד/ת ממשיך/ה לעבוד עד היום האחרון; pay = ויתור על עבודה ותשלום חלף הודעה מוקדמת"
},
"reason": {
"enum": [
"",
"cut",
"fit",
"close"
],
"type": "string",
"description": "סיבה כללית. לא חובה. הפירוט המלא ניתן בשימוע. Options: \"\" = בלי לציין סיבה; cut = צמצום או שינוי מבני; fit = אי התאמה לתפקיד; close = סגירת הסניף או הפעילות"
},
"signer": {
"type": "string",
"maxLength": 200,
"description": "שם החותם ותפקידו. e.g. \"מיכל ברק, מנהלת משאבי אנוש\""
},
"hearing": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך השימוע. המכתב נכתב אחרי השימוע (YYYY-MM-DD)"
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה או המעסיק. e.g. \"חברת דוגמה בע\"מ\""
},
"severance": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "העובד/ת עבד/ה שנה ומעלה (פיצויי פיטורים וטופס 161)"
}
},
"description": "Fields when template = \"dismissal-letter\" (מכתב פיטורים). All optional: a missing field stays as a [label] placeholder. tone: formal|warm; gender roles: to.",
"additionalProperties": false
},
{
"type": "object",
"title": "employment-confirmation",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "למי האישור. ריק = לכל מאן דבעי. e.g. \"בנק דוגמה, סניף 123\""
},
"end": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "יום העבודה האחרון. only when status=ended (YYYY-MM-DD)"
},
"pct": {
"type": "string",
"maxLength": 40,
"description": "אחוז משרה. מספר בלבד, למשל 60. e.g. \"60\". only when scope=part (a number, as text)"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך (YYYY-MM-DD)"
},
"idno": {
"type": "string",
"maxLength": 200,
"description": "מספר תעודת זהות. לא חובה. e.g. \"000000000\""
},
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"description": "שפת האישור. באנגלית: מלאו שמות ותפקיד באנגלית. Options: he = עברית; en = English"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "שם העובד/ת. e.g. \"מיכל ברק\""
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"מנהלת חשבונות\""
},
"phone": {
"type": "string",
"maxLength": 200,
"description": "טלפון או מייל לבירורים. לא חובה. e.g. \"03-0000000\""
},
"scope": {
"enum": [
"full",
"part",
"hourly",
""
],
"type": "string",
"description": "היקף המשרה. Options: full = משרה מלאה; part = משרה חלקית; hourly = לפי שעות; \"\" = לא לציין"
},
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תחילת העבודה (YYYY-MM-DD)"
},
"salary": {
"type": "string",
"maxLength": 200,
"description": "שכר חודשי ברוטו. לא חובה. ריק = בלי שכר באישור. e.g. \"12,500 ₪\""
},
"signer": {
"type": "string",
"maxLength": 200,
"description": "שם החותם ותפקידו. e.g. \"דנה אלון, מנהלת משאבי אנוש\""
},
"status": {
"enum": [
"current",
"ended"
],
"type": "string",
"description": "סוג האישור. Options: current = עובד/ת היום; ended = עובד/ת לשעבר (תקופת העסקה שהסתיימה)"
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה או המעסיק. e.g. \"חברת דוגמה בע\"מ\""
},
"employer_id": {
"type": "string",
"maxLength": 200,
"description": "ח\"פ או מספר עוסק. לא חובה. e.g. \"510000000\""
}
},
"description": "Fields when template = \"employment-confirmation\" (אישור העסקה). All optional: a missing field stays as a [label] placeholder. tone: formal; gender roles: emp.",
"additionalProperties": false
},
{
"type": "object",
"title": "employment-termination",
"properties": {
"end": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "יום העבודה האחרון (YYYY-MM-DD)"
},
"how": {
"enum": [
"",
"term",
"agree",
"resign",
"fired"
],
"type": "string",
"description": "איך הסתיימה ההעסקה. אפשר לא לציין. Options: \"\" = לא לציין; term = תום חוזה לתקופה קצובה; agree = סיום בהסכמה; resign = התפטרות; fired = ביוזמת המעסיק"
},
"pay": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "לציין שהתשלומים ומסמכי הגמר יועברו. only when purpose=end"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"idno": {
"type": "string",
"maxLength": 200,
"description": "מספר תעודת זהות. לא חובה. e.g. \"000000000\""
},
"name": {
"type": "string",
"maxLength": 200,
"description": "שם העובד/ת. e.g. \"יעל נחום\""
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"עוזרת מחקר\""
},
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תחילת העבודה (YYYY-MM-DD)"
},
"signer": {
"type": "string",
"maxLength": 200,
"description": "שם החותם ותפקידו. e.g. \"רונית כץ, מנהלת משאבי אנוש\""
},
"purpose": {
"enum": [
"end",
"later"
],
"type": "string",
"description": "מתי נותנים את המכתב. לעובד שעדיין עובד אצלכם מתאים אישור העסקה, לא המכתב הזה. Options: end = עם סיום העבודה, לפני תלוש הגמר; later = אחרי שהכל שולם, כאישור על תקופת עבודה שהסתיימה"
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה או המעסיק. e.g. \"חברת דוגמה בע\"מ\""
}
},
"description": "Fields when template = \"employment-termination\" (מכתב סיום העסקה). All optional: a missing field stays as a [label] placeholder. tone: formal|warm.",
"additionalProperties": false
},
{
"type": "object",
"title": "farewell-letter",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "למי. שם, או \"הצוות\". e.g. \"הצוות\""
},
"mode": {
"enum": [
"leaving",
"colleague",
"manager",
"friend"
],
"type": "string",
"description": "איזו פרידה. Options: leaving = אני עוזב/ת: מכתב פרידה לצוות; colleague = פרידה מעמית/ה שעוזב/ת; manager = פרידה ממנהל/ת שעוזב/ת; friend = פרידה מחבר/ה שעובר/ת רחוק"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם שלכם. e.g. \"מיכל\""
},
"next": {
"type": "string",
"maxLength": 200,
"description": "לאן ממשיכים. לא חובה. e.g. \"לתפקיד חדש בחיפה\". only when mode=leaving"
},
"place": {
"type": "string",
"maxLength": 200,
"description": "מקום העבודה. e.g. \"מחלקת השירות\". only when mode=leaving|colleague|manager"
},
"years": {
"type": "string",
"maxLength": 200,
"description": "כמה זמן הייתם יחד. e.g. \"חמש שנים\""
},
"memory": {
"type": "string",
"maxLength": 2000,
"description": "זיכרון משותף אחד. הכי חשוב במכתב. e.g. \"הלילה שבו נשארנו עד אחת כדי להעלות את האתר, ומישהו הזמין פיצה לכל הקומה.\""
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "איך לשמור על קשר. לא חובה. e.g. \"050-0000000\". only when mode=leaving"
}
},
"description": "Fields when template = \"farewell-letter\" (מכתב פרידה). All optional: a missing field stays as a [label] placeholder. tone: warm|light; length: card|whatsapp|full; gender roles: writer, to.",
"additionalProperties": false
},
{
"type": "object",
"title": "flight-compensation-claim",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "חברת התעופה. e.g. \"שם חברת התעופה, מחלקת שירות לקוחות\""
},
"bank": {
"type": "string",
"maxLength": 200,
"description": "פרטי חשבון להעברה. לא חובה. אפשר גם לבקש החזר לכרטיס האשראי. e.g. \"בנק, סניף, מספר חשבון, שם בעל החשבון\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"days": {
"enum": [
"45",
"21"
],
"type": "string",
"description": "תוך כמה זמן לשלם. Options: 45 = 45 ימים, המועד בחוק לפיצוי; 21 = 21 ימים, המועד בחוק להחזר"
},
"kind": {
"enum": [
"cancel",
"delay8",
"denied",
"delay5"
],
"type": "string",
"description": "מה קרה. Options: cancel = הטיסה בוטלה; delay8 = עיכוב של 8 שעות או יותר; denied = לא העלו אותנו לטיסה; delay5 = עיכוב של 5 עד 8 שעות (החזר בלבד)"
},
"want": {
"enum": [
"both",
"comp",
"refund"
],
"type": "string",
"description": "מה מבקשים. Options: both = פיצוי כספי והחזר מחיר הכרטיס; comp = פיצוי כספי בלבד (קיבלנו טיסה חלופית); refund = החזר מחיר הכרטיס בלבד"
},
"fdate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך הטיסה המקורי (YYYY-MM-DD)"
},
"names": {
"type": "string",
"maxLength": 200,
"description": "שם הנוסע או שמות הנוסעים. e.g. \"דנה לוי, אורי לוי\""
},
"route": {
"type": "string",
"maxLength": 200,
"description": "מסלול. e.g. \"תל אביב - אתונה\""
},
"amount": {
"type": "string",
"maxLength": 40,
"description": "סכום הפיצוי לכל הנוסעים (₪). לפי מחשבון הפיצוי: הסכום לנוסע כפול מספר הנוסעים. e.g. \"3060\". only when want=both|comp (a number, as text)"
},
"flight": {
"type": "string",
"maxLength": 200,
"description": "מספר טיסה. e.g. \"XX 123\""
},
"refund": {
"type": "string",
"maxLength": 40,
"description": "סכום ההחזר (₪). מה ששילמתם על הכרטיסים שלא נוצלו. e.g. \"2480\". only when want=both|refund (a number, as text)"
},
"booking": {
"type": "string",
"maxLength": 200,
"description": "קוד הזמנה. e.g. \"AB12CD\""
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "טלפון או מייל לתשובה. e.g. \"050-0000000\""
},
"details": {
"type": "string",
"maxLength": 2000,
"description": "פרטים נוספים במשפט או שניים. לא חובה. e.g. \"ההודעה על הביטול הגיעה ב-SMS יום לפני הטיסה. לא הוצעה לנו טיסה חלופית, וקנינו כרטיסים בחברה אחרת.\""
}
},
"description": "Fields when template = \"flight-compensation-claim\" (מכתב דרישה לפיצוי מחברת תעופה). All optional: a missing field stays as a [label] placeholder. tone: formal|warm; gender roles: pax.",
"additionalProperties": false
},
{
"type": "object",
"title": "formal-letter",
"properties": {
"org": {
"type": "string",
"maxLength": 200,
"description": "לאיזה גוף, ולידי מי. e.g. \"עיריית דוגמה, מחלקת הארנונה, לידי גב' שרה לוין\""
},
"ref": {
"type": "string",
"maxLength": 200,
"description": "מספר לקוח, תיק או נכס. לא חובה. e.g. \"123456\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"דניאל כהן\""
},
"attach": {
"type": "string",
"maxLength": 200,
"description": "מסמכים מצורפים. לא חובה. e.g. \"חוזה שכירות, תשריט הדירה\""
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "טלפון או מייל לחזרה. e.g. \"050-0000000\""
},
"request": {
"type": "string",
"maxLength": 200,
"description": "מה אתם מבקשים. e.g. \"לתקן את השטח בחשבון ולזכות אותי על ההפרש\""
},
"subject": {
"type": "string",
"maxLength": 200,
"description": "הנדון, במשפט אחד. e.g. \"בקשה לתיקון חיוב ארנונה\""
},
"deadline": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תשובה עד תאריך. לא חובה (YYYY-MM-DD)"
},
"background": {
"type": "string",
"maxLength": 2000,
"description": "הרקע, בשניים שלושה משפטים. e.g. \"ביום 01.08.2026 עברתי לדירה ברחוב הדוגמה 5. בחשבון הארנונה לחודשים אוגוסט וספטמבר חויבתי לפי שטח של 110 מ\"ר, בעוד ששטח הדירה לפי היתר הבנייה הוא 85 מ\"ר.\""
}
},
"description": "Fields when template = \"formal-letter\" (מכתב רשמי). All optional: a missing field stays as a [label] placeholder. tone: formal.",
"additionalProperties": false
},
{
"type": "object",
"title": "hearing-invitation",
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"docs": {
"type": "string",
"maxLength": 200,
"description": "מסמכים מצורפים. לא חובה. e.g. \"דוחות נוכחות לספטמבר 2026, מייל מיום 23.9.2026\""
},
"name": {
"type": "string",
"maxLength": 200,
"description": "שם העובד/ת. e.g. \"אורי שמעוני\""
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"רכז מכירות\""
},
"time": {
"type": "string",
"maxLength": 200,
"description": "שעה. e.g. \"10:00\""
},
"place": {
"type": "string",
"maxLength": 200,
"description": "מקום. e.g. \"חדר הישיבות בקומה 2, משרדי החברה\""
},
"topic": {
"enum": [
"end",
"change"
],
"type": "string",
"description": "על מה השימוע. Options: end = שקילת סיום העסקה; change = שינוי מהותי בתנאים"
},
"signer": {
"type": "string",
"maxLength": 200,
"description": "שם החותם ותפקידו. e.g. \"מיכל ברק, מנהלת משאבי אנוש\""
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "למי לפנות. לדחיית מועד, לעיון במסמכים ולתגובה בכתב. e.g. \"מיכל ברק, 03-0000000\""
},
"hearing": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "מועד השימוע (YYYY-MM-DD)"
},
"reasons": {
"type": "string",
"maxLength": 2000,
"description": "הטענות, עם אירועים ומועדים. לא אמירות כלליות. כל טענה עם תאריך. e.g. \"1. ב-3.9.2026 וב-17.9.2026 הגעת למשמרת באיחור של יותר משעה, בלי הודעה מראש.\n2. ב-22.9.2026 לא הועבר דוח המכירות החודשי במועד.\""
},
"receipt": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "להוסיף שורת אישור קבלה לחתימת העובד/ת"
},
"written": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "לאפשר להגיש טענות גם בכתב"
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה או המעסיק. e.g. \"חברת דוגמה בע\"מ\""
}
},
"description": "Fields when template = \"hearing-invitation\" (הזמנה לשימוע). All optional: a missing field stays as a [label] placeholder. tone: formal|considerate; gender roles: to.",
"additionalProperties": false
},
{
"type": "object",
"title": "hearing-protocol",
"properties": {
"rep": {
"type": "string",
"maxLength": 200,
"description": "נציג מטעם העובד/ת. השאירו ריק אם הגיע/ה בלי נציג. e.g. \"עו\"ד שרון אבני\""
},
"docs": {
"type": "string",
"maxLength": 200,
"description": "מסמכים שהעובד/ת הגיש/ה. לא חובה. e.g. \"צילום הודעת וואטסאפ מ-3.9.2026\""
},
"more": {
"type": "string",
"maxLength": 2000,
"description": "מה העובד/ת הוסיף/ה כשנשאל/ה אם יש עוד משהו. השאירו ריק אם לא הוסיף/ה דבר. e.g. \"ביקש שיישקל מעבר למשמרת צהריים.\". only when asked_more"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "שם העובד/ת. e.g. \"אורי שמעוני\""
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"רכז מכירות\""
},
"time": {
"type": "string",
"maxLength": 200,
"description": "שעה. e.g. \"10:00\""
},
"notes": {
"type": "string",
"maxLength": 2000,
"description": "הערות נוספות. לא חובה. e.g. \"העובד ביקש שיישקל מעבר למשמרת צהריים.\""
},
"place": {
"type": "string",
"maxLength": 200,
"description": "מקום. e.g. \"חדר הישיבות, משרדי החברה\""
},
"claims": {
"type": "string",
"maxLength": 2000,
"description": "הטענות שהוצגו בשיחה. e.g. \"הוצגו שתי הטענות שפורטו בהזמנה: האיחורים ב-3.9 וב-17.9, והדוח החודשי שלא הועבר במועד.\""
},
"review": {
"enum": [
"",
"approved",
"copy",
"refused"
],
"type": "string",
"description": "מה קרה עם הפרוטוקול בסוף השיחה. בחרו רק מה שקרה בפועל. בלי בחירה נשארות שורות לסימון ביד. Options: \"\" = להשאיר שורות לסימון ביד; approved = העובד/ת עיין/ה, אישר/ה את הנוסח וקיבל/ה עותק; copy = העובד/ת קיבל/ה עותק ולא אישר/ה את הנוסח; refused = העובד/ת סירב/ה לחתום"
},
"signer": {
"type": "string",
"maxLength": 200,
"description": "רשם/ה את הפרוטוקול. e.g. \"מיכל ברק, מנהלת משאבי אנוש\""
},
"hearing": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך השימוע (YYYY-MM-DD)"
},
"invited": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "מתי נמסרה ההזמנה (YYYY-MM-DD)"
},
"present": {
"type": "string",
"maxLength": 200,
"description": "נוכחים מטעם המעסיק. e.g. \"מיכל ברק, מנהלת משאבי אנוש; גיל נחום, מנהל המכירות\""
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה או המעסיק. e.g. \"חברת דוגמה בע\"מ\""
},
"prepared": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "העובד/ת אישר/ה שהיה לו/לה זמן להתכונן"
},
"response": {
"type": "string",
"maxLength": 2000,
"description": "מה העובד/ת השיב/ה. במילים של העובד/ת, בלי פרשנות. e.g. \"העובד מסר שב-3.9 ההגעה התעכבה בגלל תאונה בכביש 4, והציג צילום הודעה למנהל מאותו בוקר...\""
},
"asked_more": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "בסוף השיחה העובד/ת נשאל/ה אם יש עוד מה להוסיף"
}
},
"description": "Fields when template = \"hearing-protocol\" (פרוטוקול שימוע). All optional: a missing field stays as a [label] placeholder. tone: formal; gender roles: to, rec.",
"additionalProperties": false
},
{
"type": "object",
"title": "lease-early-termination",
"properties": {
"end": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "סוף תקופת החוזה המקורית. רלוונטי כשאין סעיף יציאה (YYYY-MM-DD)"
},
"cand": {
"type": "string",
"maxLength": 200,
"description": "שוכר/ים חלופיים שכבר נמצאו. לא חובה. e.g. \"זוג צעיר, אורן ושחר, שראו את הדירה ומעוניינים בה\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך ההודעה (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "שם השוכר/ים. e.g. \"עדי ותומר ברגר\""
},
"cdate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך חתימת החוזה (YYYY-MM-DD)"
},
"leave": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך הפינוי. לפי ימי ההודעה שבחוזה (YYYY-MM-DD)"
},
"clause": {
"enum": [
"exit",
"replace",
"none"
],
"type": "string",
"description": "מה כתוב בחוזה. Options: exit = יש סעיף יציאה מוקדמת עם הודעה מראש; replace = יציאה מותרת אם מביאים שוכר חלופי; none = אין סעיף יציאה, מבקשים הסכמה"
},
"address": {
"type": "string",
"maxLength": 200,
"description": "כתובת הדירה. e.g. \"רחוב הדוגמה 14, דירה 6, רמת גן\""
},
"deposit": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "לבקש החזרת הבטוחה (פיקדון, ערבות או שטר)"
},
"landlord": {
"type": "string",
"maxLength": 200,
"description": "שם המשכיר/ה. e.g. \"אהרון לוי\""
}
},
"description": "Fields when template = \"lease-early-termination\" (הודעה על סיום חוזה שכירות לפני הזמן). All optional: a missing field stays as a [label] placeholder. tone: formal|warm; gender roles: tenant.",
"additionalProperties": false
},
{
"type": "object",
"title": "management-fees-request",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "שם הקרן או הגוף המנהל. e.g. \"קרן פנסיה דוגמה בע\"מ\""
},
"acc": {
"type": "string",
"maxLength": 200,
"description": "דמי ניהול היום מהצבירה (%). e.g. \"0.3\""
},
"avg": {
"type": "string",
"maxLength": 200,
"description": "הממוצע בענף, כפי שמופיע במחשבון. לא חובה. מופיע במחשבון דמי הניהול. e.g. \"1.54% מההפקדות ו-0.145% מהצבירה (רשות שוק ההון, 08/2026)\""
},
"dep": {
"type": "string",
"maxLength": 200,
"description": "דמי ניהול היום מההפקדה (%). e.g. \"2.5\". only when product=pension|provident|invest|managers"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"מיכל לוי\""
},
"tacc": {
"type": "string",
"maxLength": 200,
"description": "מבקשים מהצבירה (%). e.g. \"0.15\""
},
"tdep": {
"type": "string",
"maxLength": 200,
"description": "מבקשים מההפקדה (%). e.g. \"1.5\". only when product=pension|provident|invest|managers"
},
"idnum": {
"type": "string",
"maxLength": 200,
"description": "מספר זהות. הקרן צריכה אותו כדי לאתר את החשבון. e.g. \"000000000\""
},
"account": {
"type": "string",
"maxLength": 200,
"description": "מספר חשבון או פוליסה. e.g. \"123456\""
},
"contact": {
"type": "string",
"maxLength": 200,
"description": "מייל או טלפון לתשובה. e.g. \"[email protected]\""
},
"product": {
"enum": [
"pension",
"study",
"provident",
"invest",
"managers"
],
"type": "string",
"description": "המוצר. Options: pension = קרן פנסיה; study = קרן השתלמות; provident = קופת גמל; invest = קופת גמל להשקעה; managers = ביטוח מנהלים"
}
},
"description": "Fields when template = \"management-fees-request\" (מכתב בקשה להפחתת דמי ניהול). All optional: a missing field stays as a [label] placeholder. tone: formal; gender roles: writer.",
"additionalProperties": false
},
{
"type": "object",
"title": "parking-ticket-appeal",
"properties": {
"city": {
"type": "string",
"maxLength": 200,
"description": "הרשות המקומית. e.g. \"עיריית דוגמה\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"idno": {
"type": "string",
"maxLength": 200,
"description": "מספר תעודת זהות. רוב הרשויות מבקשות. e.g. \"000000000\""
},
"name": {
"type": "string",
"maxLength": 200,
"description": "שם בעל/ת הרכב. e.g. \"רועי אלון\""
},
"plate": {
"type": "string",
"maxLength": 200,
"description": "מספר הרכב. e.g. \"12-345-67\""
},
"tdate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך הדוח (YYYY-MM-DD)"
},
"attach": {
"type": "string",
"maxLength": 200,
"description": "מסמכים מצורפים. e.g. \"צילום הדוח, צילום מסך מהאפליקציה, צילום תעודת זהות\""
},
"ground": {
"enum": [
"app",
"sign",
"mark",
"permit",
"emergency",
"other"
],
"type": "string",
"description": "סיבת הבקשה. Options: app = החניה שולמה באפליקציה או במדחן; sign = שילוט חסר, מוסתר או לא ברור; mark = סימון דהוי על המדרכה; permit = יש תו חניה בתוקף; emergency = מצב חירום רפואי; other = סיבה אחרת"
},
"ticket": {
"type": "string",
"maxLength": 200,
"description": "מספר הדוח. e.g. \"40123456\""
},
"details": {
"type": "string",
"maxLength": 2000,
"description": "פרטים נוספים. מקום, שעות, מה קרה ומה מצורף. e.g. \"התשלום הופעל בשעה 09:12 והדוח נרשם בשעה 09:40. מצורף צילום מסך מהאפליקציה.\""
}
},
"description": "Fields when template = \"parking-ticket-appeal\" (בקשה לביטול דוח חניה). All optional: a missing field stays as a [label] placeholder. tone: formal.",
"additionalProperties": false
},
{
"type": "object",
"title": "raise-request-letter",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "למי. e.g. \"יוסי כהן, מנהל המחלקה\""
},
"ask": {
"type": "string",
"maxLength": 200,
"description": "מה אתם מבקשים. e.g. \"העלאה של 10% בשכר הבסיס\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך (YYYY-MM-DD)"
},
"last": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "עדכון השכר האחרון. לא חובה (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם שלכם. e.g. \"רוני אביב\""
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"מנהלת תיקי לקוחות\""
},
"wins": {
"type": "string",
"maxLength": 2000,
"description": "הישגים, במספרים אם אפשר. e.g. \"הובלתי את המעבר למערכת החדשה, שקיצר את זמן הטיפול בפנייה מ-3 ימים ליום אחד.\nשימור לקוחות בתיק שלי עלה מ-82% ל-91%.\""
},
"basis": {
"enum": [
"results",
"scope",
"market",
"tenure"
],
"type": "string",
"description": "על מה הבקשה נשענת. Options: results = תוצאות והישגים; scope = הרחבת התפקיד; market = השוואה לשכר בשוק; tenure = ותק וניסיון"
},
"scope": {
"type": "string",
"maxLength": 2000,
"description": "אחריות חדשה. לא חובה. e.g. \"מאז ינואר אני אחראית גם על חפיפת עובדים חדשים בצוות.\""
},
"since": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "בתפקיד מאז (YYYY-MM-DD)"
},
"meeting": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "לבקש פגישה כדי לדבר על זה"
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה. e.g. \"חברת דוגמה בע\"מ\""
}
},
"description": "Fields when template = \"raise-request-letter\" (מכתב בקשה להעלאה בשכר). All optional: a missing field stays as a [label] placeholder. tone: formal|direct; gender roles: writer.",
"additionalProperties": false
},
{
"type": "object",
"title": "recommendation-letter",
"properties": {
"g": {
"enum": [
"f",
"m"
],
"type": "string",
"description": "לשון המכתב. Options: f = לשון נקבה; m = לשון זכר"
},
"org": {
"type": "string",
"maxLength": 200,
"description": "שם הארגון או המוסד. e.g. \"חברת דוגמה בע\"מ\""
},
"cand": {
"type": "string",
"maxLength": 200,
"description": "שם המומלץ/ת. e.g. \"תמר אדלר\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך (YYYY-MM-DD)"
},
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"description": "שפת המכתב. באנגלית: מלאו את השדות באנגלית. Options: he = עברית; en = English"
},
"crole": {
"type": "string",
"maxLength": 200,
"description": "תפקיד, קורס או מסגרת. e.g. \"רכזת פרויקטים\""
},
"phone": {
"type": "string",
"maxLength": 200,
"description": "טלפון לבירורים. לא חובה, אבל מחזק את ההמלצה. e.g. \"050-0000000\""
},
"period": {
"type": "string",
"maxLength": 200,
"description": "תקופה. e.g. \"מרץ 2023 עד אוגוסט 2026\""
},
"writer": {
"type": "string",
"maxLength": 200,
"description": "השם שלכם ותפקידכם. e.g. \"אבי מור, מנהל התפעול\""
},
"example": {
"type": "string",
"maxLength": 2000,
"description": "דוגמה אחת למשהו שעשה/תה. הכי חשוב במכתב. e.g. \"הובילה את המעבר למערכת הזמנות חדשה, ובתוך חצי שנה זמן הטיפול בהזמנה ירד בשליש.\""
},
"strengths": {
"type": "string",
"maxLength": 200,
"description": "חוזקות בולטות. e.g. \"האחריות, יחסי האנוש והיכולת ללמוד מהר\""
}
},
"description": "Fields when template = \"recommendation-letter\" (מכתב המלצה). All optional: a missing field stays as a [label] placeholder. tone: formal|warm.",
"additionalProperties": false
},
{
"type": "object",
"title": "resignation-letter",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "למי המכתב. לא חובה. e.g. \"יוסי כהן, מנהל המחלקה\""
},
"pay": {
"enum": [
"monthly",
"hourly"
],
"type": "string",
"description": "אופן תשלום השכר. Options: monthly = משכורת חודשית; hourly = שכר לפי שעה או יום"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"docs": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "לבקש מסמכי גמר (טופס 161, אישור העסקה, מכתב שחרור לקופות)"
},
"last": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "יום העבודה האחרון. לפי ימי ההודעה המוקדמת (YYYY-MM-DD)"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"נועה לוי\""
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"מנהלת לקוחות\""
},
"birth": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך הלידה או קבלת הילד. only when reason=child (YYYY-MM-DD)"
},
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך תחילת העבודה. לחישוב ההודעה המוקדמת והוותק (YYYY-MM-DD)"
},
"detail": {
"type": "string",
"maxLength": 2000,
"description": "פירוט קצר. עובדות בלבד: מה, ממתי, ובמה זה פוגע. e.g. \"מאז יולי 2026 השכר משולם באיחור של שלושה שבועות ויותר.\". only when reason=health_self|health_family|relocation|worse"
},
"reason": {
"enum": [
"",
"job",
"move",
"study",
"family",
"personal",
"health_self",
"health_family",
"relocation",
"child",
"worse"
],
"type": "string",
"description": "סיבה. לא חובה לכתוב סיבה. הסיבות המסומנות עשויות לזכות בפיצויים. Options: \"\" = בלי סיבה; job = מעבר לעבודה חדשה; move = מעבר דירה (בלי לבקש פיצויים); study = יציאה ללימודים; family = סיבות משפחתיות; personal = סיבות אישיות; health_self = מצב בריאותי שלי (עשוי לזכות בפיצויים); health_family = מצב בריאותי של בן משפחה (עשוי לזכות בפיצויים); relocation = מעבר מגורים מרוחק בנסיבות שבחוק (עשוי לזכות בפיצויים); child = טיפול בילד בתוך 9 חודשים מהלידה (עשוי לזכות בפיצויים); worse = הרעה מוחשית בתנאי העבודה (עשויה לזכות בפיצויים)"
},
"warned": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך מכתב ההתראה ששלחתם. לפני התפטרות בגלל הרעה בתנאים צריך להתריע ולתת הזדמנות לתקן. only when reason=worse (YYYY-MM-DD)"
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה או המעסיק. e.g. \"חברת דוגמה בע\"מ\""
},
"handover": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "להציע עזרה בחפיפה ובהעברת התפקיד"
},
"newplace": {
"type": "string",
"maxLength": 200,
"description": "מקום המגורים החדש. e.g. \"קריית שמונה\". only when reason=relocation"
}
},
"description": "Fields when template = \"resignation-letter\" (מכתב התפטרות). All optional: a missing field stays as a [label] placeholder. tone: formal|warm; length: full|short; gender roles: writer.",
"additionalProperties": false
},
{
"type": "object",
"title": "resignation-warning-letter",
"properties": {
"to": {
"type": "string",
"maxLength": 200,
"description": "למי המכתב. רצוי מי שמוסמך לתקן. e.g. \"אבי לוי, מנכ\"ל\""
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך המכתב (YYYY-MM-DD)"
},
"days": {
"enum": [
"7",
"14",
"30"
],
"type": "string",
"description": "תוך כמה ימים לתקן. החוק לא קובע מספר ימים. בחרו זמן סביר. Options: 7 = 7 ימים; 14 = 14 ימים; 30 = 30 ימים"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם המלא שלכם. e.g. \"שני דהן\""
},
"role": {
"type": "string",
"maxLength": 200,
"description": "תפקיד. e.g. \"טכנאית שירות\""
},
"issue": {
"enum": [
"wages",
"cut",
"rights",
"place",
"abuse",
"privacy",
"other"
],
"type": "string",
"description": "מה השתנה לרעה. Options: wages = השכר לא משולם, או משולם באיחור; cut = הפחתת שכר, הורדה בדרגה או שינוי מהותי בשעות; rights = זכויות לא משולמות: הבראה, חופשה, הפרשות לפנסיה; place = העברת מקום העבודה; abuse = יחס משפיל או התעמרות; privacy = מצלמות או מעקב שפוגעים בפרטיות; other = אחר"
},
"since": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "ממתי (YYYY-MM-DD)"
},
"start": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך תחילת העבודה. הזכות לפיצויים דורשת בדרך כלל שנת עבודה לפחות (YYYY-MM-DD)"
},
"demand": {
"type": "string",
"maxLength": 2000,
"description": "מה אתם מבקשים שיתוקן. e.g. \"לשלם את משכורת ספטמבר במלואה, ולשלם מעתה את השכר עד ה-9 בכל חודש.\""
},
"detail": {
"type": "string",
"maxLength": 2000,
"description": "מה קרה, בעובדות. תאריכים, סכומים, מקרים. בלי תיאורים כלליים. e.g. \"משכורות יולי ואוגוסט 2026 שולמו ב-28 לחודש, ומשכורת ספטמבר טרם שולמה.\""
},
"employer": {
"type": "string",
"maxLength": 200,
"description": "שם החברה או המעסיק. e.g. \"חברת דוגמה בע\"מ\""
}
},
"description": "Fields when template = \"resignation-warning-letter\" (מכתב התראה למעסיק לפני התפטרות). All optional: a missing field stays as a [label] placeholder. tone: formal|polite; gender roles: writer.",
"additionalProperties": false
},
{
"type": "object",
"title": "thank-you-letter",
"properties": {
"cc": {
"type": "string",
"maxLength": 200,
"description": "העתק אל. כדי שהתודה תגיע גם להנהלה. e.g. \"מנהלת המחלקה, פניות הציבור\". only when recipient=service|doctor|staff&tone=formal"
},
"to": {
"type": "string",
"maxLength": 200,
"description": "שם הנמען/ת. e.g. \"רונית\""
},
"org": {
"type": "string",
"maxLength": 200,
"description": "ארגון, מחלקה, עסק או קרן. e.g. \"קרן דוגמה\". only when recipient=doctor|staff|service|donor|manager"
},
"who": {
"enum": [
"parent",
"partner",
"friend",
"mentor"
],
"type": "string",
"description": "למי בדיוק. only when recipient=all. Options: parent = להורים; partner = לבן או לבת הזוג; friend = לחבר או לחברה; mentor = למנטור/ית"
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "תאריך (YYYY-MM-DD)"
},
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"description": "שפת המכתב. תורמי מלגות רבים קוראים אנגלית. only when recipient=donor. Options: he = עברית; en = English"
},
"name": {
"type": "string",
"maxLength": 200,
"description": "השם שלכם. e.g. \"משפחת לוי\""
},
"what": {
"type": "string",
"maxLength": 2000,
"description": "פרט אישי אחד שזכור לכם. הכי חשוב במכתב. למכתב באנגלית כתבו באנגלית. e.g. \"תמיד מצאת זמן להסביר בסבלנות כל שלב, גם כשהיינו מבוהלים.\""
},
"child": {
"type": "string",
"maxLength": 200,
"description": "שם הילד/ה. למורה, לגננת או למטפל/ת של הילד/ה. e.g. \"עומר\". only when recipient=teacher|therapist"
},
"study": {
"type": "string",
"maxLength": 200,
"description": "מה לומדים ואיפה. למכתב באנגלית כתבו באנגלית, למשל Nursing. e.g. \"סיעוד, במכללה האקדמית דוגמה\". only when recipient=donor&donor_kind=scholarship"
},
"therapy": {
"enum": [
"end",
"mid",
"child",
"couple"
],
"type": "string",
"description": "איזה שלב בטיפול. only when recipient=therapist. Options: end = סיום טיפול; mid = באמצע הדרך; child = מטפל/ת של הילד/ה (מההורים); couple = טיפול זוגי"
},
"recipient": {
"enum": [
"therapist",
"teacher",
"doctor",
"manager",
"staff",
"service",
"all",
"donor"
],
"type": "string",
"description": "למי המכתב. Options: therapist = פסיכולוג/ית או מטפל/ת; teacher = מורה או גננת; doctor = רופא/ה וצוות רפואי; manager = המנהל/ת שלי (בעבודה הנוכחית או הקודמת); staff = לעובד/ת או לצוות שלי (כשאני המנהל/ת); service = נותן/ת שירות: טכנאי, עורכת דין, נציג; all = תודה על הכל: הורים, בן/בת זוג, חבר/ה, מנטור/ית; donor = תורם/ת או תורם/ת מלגה"
},
"donor_kind": {
"enum": [
"scholarship",
"general"
],
"type": "string",
"description": "על מה התודה. only when recipient=donor. Options: scholarship = מלגת לימודים; general = תרומה לעמותה או לארגון"
}
},
"description": "Fields when template = \"thank-you-letter\" (מכתב תודה). All optional: a missing field stays as a [label] placeholder. tone: warm|formal; length: card|whatsapp|full; gender roles: writer, to.",
"additionalProperties": false
}
],
"description": "Field values of the chosen template, as strings: the anyOf branch whose title equals \"template\". Pass {} for a draft with every field as a [label] placeholder.",
"maxProperties": 40
},
"gender": {
"type": "object",
"description": "Grammatical gender per role id of the template, e.g. {\"writer\":\"f\",\"to\":\"m\"}: m, f or p (plural)",
"maxProperties": 4,
"additionalProperties": {
"enum": [
"m",
"f",
"p"
],
"type": "string"
}
},
"length": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Length id when the template has lengths (e.g. full, whatsapp, card, short)"
},
"formats": {
"type": "array",
"items": {
"enum": [
"docx",
"pdf",
"txt"
],
"type": "string"
},
"maxItems": 3,
"description": "Files to attach (default docx + pdf). The text is always in the answer.",
"uniqueItems": true
},
"template": {
"enum": [
"apology-letter",
"arnona-discount-request",
"birthday-letter",
"cancel-insurance-policy",
"cancel-standing-order",
"cancel-transaction-letter",
"card-dispute-letter",
"complaint-letter",
"condolence-letter",
"demand-letter",
"dismissal-decision",
"dismissal-letter",
"employment-confirmation",
"employment-termination",
"farewell-letter",
"flight-compensation-claim",
"formal-letter",
"hearing-invitation",
"hearing-protocol",
"lease-early-termination",
"management-fees-request",
"parking-ticket-appeal",
"raise-request-letter",
"recommendation-letter",
"resignation-letter",
"resignation-warning-letter",
"thank-you-letter"
],
"type": "string",
"description": "Letter template id. apology-letter = מכתב התנצלות; arnona-discount-request = מכתב בקשה להנחה בארנונה; birthday-letter = מכתב ליום הולדת; cancel-insurance-policy = מכתב ביטול פוליסת ביטוח; cancel-standing-order = מכתב ביטול מנוי והוראת קבע; cancel-transaction-letter = מכתב ביטול עסקה; card-dispute-letter = מכתב הכחשת עסקה בכרטיס אשראי; complaint-letter = מכתב תלונה; condolence-letter = מכתב תנחומים; demand-letter = מכתב התראה לפני תביעה; dismissal-decision = מכתב החלטה לאחר שימוע; dismissal-letter = מכתב פיטורים; employment-confirmation = אישור העסקה; employment-termination = מכתב סיום העסקה; farewell-letter = מכתב פרידה; flight-compensation-claim = מכתב דרישה לפיצוי מחברת תעופה; formal-letter = מכתב רשמי; hearing-invitation = הזמנה לשימוע; hearing-protocol = פרוטוקול שימוע; lease-early-termination = הודעה על סיום חוזה שכירות לפני הזמן; management-fees-request = מכתב בקשה להפחתת דמי ניהול; parking-ticket-appeal = בקשה לביטול דוח חניה; raise-request-letter = מכתב בקשה להעלאה בשכר; recommendation-letter = מכתב המלצה; resignation-letter = מכתב התפטרות; resignation-warning-letter = מכתב התראה למעסיק לפני התפטרות; thank-you-letter = מכתב תודה"
}
},
"additionalProperties": false
}| template | string | Optional starting template when you give no fields: class (signup for a class or kindergarten), employee (new employee details, without form 101), health (health declaration for an activity, with a "details" question shown only after a yes), client (new client for a tradesperson), trip (parents' permission for a school trip), rsvp (event attendance), contact (leave details for a call back), appointment (request an appointment), job (job application with a CV), feedback (satisfaction survey), volunteer (volunteer signup). |
| max_answers | integer | Optional: close the form automatically after this many answers (places in a class or on a trip). |
{
"type": "object",
"required": [
"title"
],
"properties": {
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"intro": {
"type": "string",
"maxLength": 1200,
"minLength": 1,
"description": "Optional short explanation shown at the top of the form."
},
"theme": {
"enum": [
"green",
"blue",
"violet",
"rose",
"amber",
"slate"
],
"type": "string",
"description": "Colour of the form page (default green)."
},
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Form title, e.g. \"הרשמה לקייטנת קיץ\"."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"label"
],
"properties": {
"help": {
"type": "string",
"maxLength": 600,
"minLength": 1,
"description": "Optional hint under the field."
},
"type": {
"enum": [
"text",
"textarea",
"number",
"date",
"choice",
"multi",
"select",
"checkbox",
"signature",
"file",
"il_id",
"phone",
"email",
"bank",
"address",
"info"
],
"type": "string",
"description": "Field type. text/textarea: free text; number; date; choice: one of options; multi: several of options; select: dropdown; checkbox: one consent or yes/no tick (its answer is \"כן\" or \"לא\"); signature: drawn signature; file: an upload (image, PDF, Word, up to 5 MB); il_id: Israeli ID number (checksum-validated); phone: Israeli phone; email; bank: bank + branch from the Bank of Israel list + account number; address: locality + street from the official lists + house number; info: a paragraph of explanation, no answer."
},
"label": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "What the person filling it sees, in the form language (usually Hebrew). For info: the paragraph itself."
},
"options": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"maxItems": 50,
"description": "For choice, multi and select: 2-50 options."
},
"show_if": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"equals"
],
"properties": {
"field": {
"type": "integer",
"maximum": 60,
"minimum": 1,
"description": "1-based number of an EARLIER field of type choice, multi, select or checkbox."
},
"equals": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "The answer that shows this field: one of that field's options, or \"כן\" / \"לא\" for a checkbox."
}
},
"additionalProperties": false
},
"maxItems": 5,
"description": "Show this field only when ANY of these answers was given (e.g. \"details\" only after \"yes\")."
},
"required": {
"type": "boolean",
"description": "Whether an answer is required (default false). A required field that is hidden by show_if is not required."
}
},
"additionalProperties": false
},
"maxItems": 60,
"description": "The questions in order (1-60). Leave out to start from the template."
},
"template": {
"enum": [
"class",
"employee",
"health",
"client",
"trip",
"rsvp",
"contact",
"appointment",
"job",
"feedback",
"volunteer"
],
"type": "string",
"description": "Optional starting template when you give no fields: class (signup for a class or kindergarten), employee (new employee details, without form 101), health (health declaration for an activity, with a \"details\" question shown only after a yes), client (new client for a tradesperson), trip (parents' permission for a school trip), rsvp (event attendance), contact (leave details for a call back), appointment (request an appointment), job (job application with a CV), feedback (satisfaction survey), volunteer (volunteer signup)."
},
"max_answers": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Optional: close the form automatically after this many answers (places in a class or on a trip)."
}
},
"additionalProperties": false
}| tax_year | integer | Tax year of the form. Only 2026 (official revision 11.2025) is available. |
| credit_reasons | object | Part H: credit points and reliefs. Item 1 (resident) is ticked from employee.israeli_resident. |
| declaration_date | string | Date next to the signature (default: today in Israel) |
| tax_coordination | object | Part I (optional) |
| apply_suggestions | boolean | Default true: also tick the credit items that clearly follow from the details (1 resident, 7 or 8 children, 4 aliyah, 13, 14, 15, 16) like the website filler suggests. Items that need a judgement (3, 5, 6) are only ticked when asked. |
{
"type": "object",
"required": [
"employee",
"income"
],
"properties": {
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"income": {
"type": "object",
"required": [
"type",
"has_other_income"
],
"properties": {
"type": {
"enum": [
"monthly",
"additional",
"partial",
"daily",
"pension",
"scholarship"
],
"type": "string",
"description": "What I get from THIS employer: monthly (regular salary, most people), additional (this is a second job), partial (up to 5 hours a day), daily (paid per day, under 18 days a month), pension, scholarship"
},
"start_date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Start date at this employer in the tax year (worked there before 2026? use 2026-01-01)"
},
"has_other_income": {
"type": "boolean",
"description": "Part E: true if I have another salary, pension or scholarship now (a job that ended before this one does not count)"
},
"credit_points_here": {
"type": "boolean",
"description": "With other income: true = give me the credit points and tax brackets HERE (and not at the other income); false = at the other income"
},
"other_income_types": {
"type": "array",
"items": {
"enum": [
"monthly",
"additional",
"partial",
"daily",
"pension",
"scholarship"
],
"type": "string"
},
"maxItems": 6,
"description": "Kinds of the other income",
"uniqueItems": true
},
"no_pension_on_other": {
"type": "boolean",
"description": "No pension / disability insurance / severance deposits on the other income (or they are added to it)"
},
"no_study_fund_on_other": {
"type": "boolean",
"description": "No study-fund deposits on the other income (or they are added to it)"
}
},
"description": "Parts D and E",
"additionalProperties": false
},
"spouse": {
"type": "object",
"required": [
"has_income"
],
"properties": {
"passport": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"id_number": {
"type": "string",
"pattern": "^[0-9]{5,9}$",
"maxLength": 9,
"description": "Spouse ID (optional)"
},
"last_name": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"birth_date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "YYYY-MM-DD"
},
"first_name": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"has_income": {
"type": "boolean",
"description": "Does the spouse have any income"
},
"aliyah_date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "YYYY-MM-DD"
},
"income_other": {
"type": "boolean",
"description": "Other spouse income (pension, allowance...)"
},
"income_from_work": {
"type": "boolean",
"description": "Spouse income from work / business / salary"
}
},
"description": "Part F (married employees)",
"additionalProperties": false
},
"children": {
"type": "array",
"items": {
"type": "object",
"required": [
"first_name",
"birth_date",
"in_my_custody",
"i_receive_child_allowance"
],
"properties": {
"id_number": {
"type": "string",
"pattern": "^[0-9]{5,9}$",
"maxLength": 9,
"description": "Child ID (optional)"
},
"birth_date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Child birth date"
},
"first_name": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Child first name"
},
"in_my_custody": {
"type": "boolean",
"description": "Column 1: the child lives with me / is in my custody"
},
"i_receive_child_allowance": {
"type": "boolean",
"description": "Column 2: I receive the National Insurance child allowance for this child"
}
},
"additionalProperties": false
},
"maxItems": 13,
"description": "Part C: every child under 19 in the tax year (born 2008 or later), also children who do not live with you"
},
"employee": {
"type": "object",
"required": [
"first_name",
"last_name",
"birth_date",
"gender",
"marital_status",
"israeli_resident"
],
"properties": {
"zip": {
"type": "string",
"pattern": "^[0-9]{5,7}$",
"maxLength": 7,
"description": "Postal code, 7 digits"
},
"city": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "City or town"
},
"email": {
"type": "string",
"pattern": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
"maxLength": 80,
"description": "Email"
},
"phone": {
"type": "string",
"pattern": "^[0-9+()\\- ]{7,20}$",
"maxLength": 20,
"description": "Israeli phone, e.g. 050-1234567"
},
"gender": {
"enum": [
"m",
"f"
],
"type": "string",
"description": "m = male, f = female (women get an extra half credit point)"
},
"mobile": {
"type": "string",
"pattern": "^[0-9+()\\- ]{7,20}$",
"maxLength": 20,
"description": "Israeli phone, e.g. 050-1234567"
},
"street": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Street or neighbourhood"
},
"kibbutz": {
"enum": [
"no",
"yes_transferred",
"yes_not_transferred"
],
"type": "string",
"description": "Kibbutz/cooperative moshav member; income from this employer transferred to the kibbutz or not"
},
"passport": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Only if there is no Israeli ID number"
},
"id_number": {
"type": "string",
"pattern": "^[0-9]{5,9}$",
"maxLength": 9,
"description": "Israeli ID number (9 digits with the check digit). Checksum-validated in memory, never stored."
},
"last_name": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Last name as on the ID card"
},
"birth_date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Birth date YYYY-MM-DD"
},
"first_name": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "First name as on the ID card"
},
"aliyah_date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Aliyah date (new immigrants only)"
},
"health_fund": {
"enum": [
"clalit",
"maccabi",
"meuhedet",
"leumit",
"none"
],
"type": "string",
"description": "Kupat holim membership"
},
"house_number": {
"type": "string",
"maxLength": 8,
"minLength": 1
},
"marital_status": {
"enum": [
"single",
"married",
"divorced",
"widowed",
"separated"
],
"type": "string",
"description": "separated only with a tax assessor approval"
},
"israeli_resident": {
"type": "boolean",
"description": "Israeli resident (center of life in Israel). Almost every employee in Israel: true"
}
},
"description": "Part B: the employee",
"additionalProperties": false
},
"employer": {
"type": "object",
"required": [],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"phone": {
"type": "string",
"pattern": "^[0-9+()\\- ]{7,20}$",
"maxLength": 20,
"description": "Israeli phone, e.g. 050-1234567"
},
"address": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"deductions_file": {
"type": "string",
"pattern": "^9?[0-9]{8}$",
"maxLength": 9,
"description": "Withholding file number (9 digits starting with 9)"
}
},
"description": "Part A (optional, the employer usually fills it)",
"additionalProperties": false
},
"tax_year": {
"enum": [
2026
],
"type": "integer",
"default": 2026,
"description": "Tax year of the form. Only 2026 (official revision 11.2025) is available."
},
"credit_reasons": {
"type": "object",
"required": [],
"properties": {
"sole_parent": {
"type": "boolean",
"description": "9: sole parent (the other parent died or is not registered)"
},
"age_16_to_18": {
"type": "boolean",
"description": "13: I or my spouse turned 16 and not yet 18 in the tax year"
},
"new_immigrant": {
"type": "object",
"required": [],
"properties": {
"no_income_until": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "No Israeli income from the start of the year until (optional)"
}
},
"description": "4: new immigrant (uses employee.aliyah_date)",
"additionalProperties": false
},
"academic_degree": {
"type": "object",
"required": [
"kind",
"finished_year"
],
"properties": {
"kind": {
"enum": [
"ba",
"ma",
"pro"
],
"type": "string",
"description": "ba = bachelor, ma = master, pro = professional studies"
},
"finished_year": {
"type": "integer",
"maximum": 2026,
"minimum": 1990,
"description": "Year the studies ended"
}
},
"description": "15: finished a degree or professional studies (needs form 119)",
"additionalProperties": false
},
"disabled_children": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "11: number of children with disabilities (under 19) for whom I get the disabled child allowance"
},
"discharged_soldier": {
"type": "object",
"required": [
"service_start",
"service_end",
"full_service"
],
"properties": {
"service_end": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Discharge / end of national service"
},
"full_service": {
"type": "boolean",
"description": "true = full regular service (2 points a year), false = short service (1 point)"
},
"service_start": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "YYYY-MM-DD"
}
},
"description": "14: discharged soldier / national service in the last 3 years",
"additionalProperties": false
},
"children_in_custody": {
"type": "boolean",
"description": "7: credit for my children in my custody (single parent receiving the allowance, married woman, or sole parent)"
},
"reserve_combat_days": {
"type": "integer",
"maximum": 400,
"minimum": 1,
"description": "16: days of combat reserve duty in 2025 (credit from 30 days)"
},
"alimony_for_children": {
"type": "boolean",
"description": "10: children not in my custody whom I support by a court order"
},
"alimony_to_ex_spouse": {
"type": "boolean",
"description": "12: I pay alimony to a former spouse (remarried)"
},
"disabled_100_or_blind": {
"type": "boolean",
"description": "2a: 100% disabled or permanently blind"
},
"qualifying_settlement": {
"type": "object",
"required": [
"name",
"since"
],
"properties": {
"name": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Settlement name"
},
"since": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Living there since"
}
},
"description": "3: permanent resident of a qualifying locality (needs form 1312a)",
"additionalProperties": false
},
"spouse_without_income": {
"type": "boolean",
"description": "5: spouse lives with me and has no income AND (retirement age or spouse disabled/blind)"
},
"children_not_in_custody": {
"type": "boolean",
"description": "8: credit for my children (a parent who did not tick 7, e.g. a married father)"
},
"disability_compensation": {
"type": "boolean",
"description": "2b: also receives a monthly allowance under the Disabled Persons law or the hostile-acts victims law (only with 2a)"
},
"single_parent_living_separately": {
"type": "boolean",
"description": "6: single-parent family living separately, children in my custody and I receive their child allowance"
}
},
"description": "Part H: credit points and reliefs. Item 1 (resident) is ticked from employee.israeli_resident.",
"additionalProperties": false
},
"declaration_date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Date next to the signature (default: today in Israel)"
},
"tax_coordination": {
"type": "object",
"required": [],
"properties": {
"other_incomes": {
"type": "array",
"items": {
"type": "object",
"required": [
"payer_name",
"monthly_income"
],
"properties": {
"address": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"payer_name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"income_type": {
"type": "string",
"maxLength": 30,
"minLength": 1,
"description": "e.g. משכורת, קצבה"
},
"tax_withheld": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "ILS withheld per month"
},
"monthly_income": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "ILS per month"
},
"deductions_file": {
"type": "string",
"pattern": "^9?[0-9]{8}$",
"maxLength": 9
}
},
"additionalProperties": false
},
"maxItems": 3,
"description": "T2: other salary incomes"
},
"assessor_approval": {
"type": "boolean",
"description": "T3: the tax assessor approved a coordination (attach the approval)"
},
"no_income_since_year_start": {
"type": "boolean",
"description": "T1: no income from the start of the tax year until starting this job"
}
},
"description": "Part I (optional)",
"additionalProperties": false
},
"apply_suggestions": {
"type": "boolean",
"description": "Default true: also tick the credit items that clearly follow from the details (1 resident, 7 or 8 children, 4 aliyah, 13, 14, 15, 16) like the website filler suggests. Items that need a judgement (3, 5, 6) are only ticked when asked."
}
},
"additionalProperties": false
}| as_of | string | Which steps are "for today" (default: today in Israel) |
| event* | string | The life event, as an id or in words (Hebrew or English). Ids: aliyah, army-release, birth, buy-home, car, close-business, death, divorce, elderly-parent, first-employee, job-loss, marriage, moving, new-business, new-job, pregnancy, rent-home, reserve-duty, retirement, school-start. |
| answers | object | Optional answers that shape the plan (anything missing takes the default). Per event: aliyah: status (oleh|returning|senior_returning), city, address, tenure (tenant|owner|family), employed (yes|no), license (yes|no); army-release: service_len (full|12plus|under12), next (work|study|search|other), job_start (YYYY-MM-DD), arnona_payer (yes|no), city, address; birth: place (hospital|home|abroad), name_given (yes|no), married (yes|no), mother_work (employee|self|none), leave_start (YYYY-MM-DD), extend_unpaid (yes|no|maybe), employer_name, partner_work (employee|self|none|na), daycare (yes|maybe|no), passport (yes|no); buy-home: home_type (single|replacement|additional), seller (second|contractor), mortgage (yes|no), live (yes|no), move_date (YYYY-MM-DD), from_city, to_city, old_tenure (tenant|owner|parents), old_address, new_address; car: role (buy|sell), counterpart (private|dealer), online (yes|no), badge (yes|no), kvish6 (yes|no|unknown), car_number; close-business: type (patur|murshe|company), had_employees (yes|no), assets (no|yes), premises (home|rented), city, premises_address, next (employee|none); death: relation (parent|spouse|other), deceased_name, spouse_alive (yes|no), kids_under18 (yes|no), had_allowance (yes|no|unknown), will (yes|no|unknown), home (family|empty|none), city, home_address, car (yes|no), mortgage (yes|no), worked (yes|no), carer (yes|no), firearm (yes|no), dispute (no|yes); divorce: stage (separated|divorced), kids (yes|no), kids_with (me|other|split|shared), housing (i_leave|i_stay|none), move_date (YYYY-MM-DD), arnona_mine (yes|no|unknown), from_city, to_city, old_address, new_address, employed (yes|no), name_back (yes|no|later), old_name, new_name; elderly-parent: lives_alone (yes|no), adl (yes|some|no), ltc (yes|no), old_age (yes|supplement|no), caregiver (foreign|israeli|company|unknown), hire_date (YYYY-MM-DD), car (yes|no), city, address; first-employee: biz (patur|murshe|company), emp_pension (yes|no|unknown), payroll (self|rep), business_name; job-loss: how (fired|resigned|ended), tenure (under1|1plus), work_months (under12|12|16|17|18), next_job (yes|no), unemployment (yes|no), group_health (yes|no|unknown), dispute (no|yes), employer_name, start_date (YYYY-MM-DD); marriage: where (religious|abroad), name (yes|no|later), old_name, new_name, employed (yes|no), prenup (yes|maybe|no); moving: from_city, to_city, tenure (tenant|owner), old_tenure (tenant|owner|parents), old_address, new_address, kids (yes|no), car (yes|no), gas (yes|no|unknown), employed (yes|no); new-business: type (patur|murshe|unsure), employee_too (yes|no), hire (yes|no), premises (home|rented), license (no|yes|unknown), age_band (under21|21-60|over60); new-job: other_income (second|earlier|no), had_pension (yes|no|unknown), employer_name; pregnancy: work (employee|self|none), tenure (lt6|6to12|12plus), employer_name, leave_start (YYYY-MM-DD), risk (yes|no); rent-home: lease_end (YYYY-MM-DD), option (yes|no), broker (yes|no), from_city, to_city, old_tenure (tenant|owner|parents), old_address, new_address; reserve-duty: service_start (YYYY-MM-DD), long (yes|no), work (employee|self|both|student|none), student (yes|no), combat (yes|no), employer_name, dismissed (no|yes), arnona_payer (yes|no), city, address; retirement: sex (m|f), age_67 (YYYY-MM-DD), work_after (no|yes|part), work_pension (yes|no), payers (one|more), low_income (yes|no|unknown), city, address, employer_name; school-start: stage (daycare|gan|first|other), city, moved (yes|no), move_date (YYYY-MM-DD), new_address, change_school (yes|no), after_school (yes|maybe|no). |
| for_whom | string | other = the plan is prepared by a family member for another person (labelled as such; the plan is information only and nothing is sent) |
| subject_name | string | First name of the person the plan is for, when for_whom = other |
| reminder_days_before | integer | Calendar alarm this many days before each deadline (0 = none, default 3) |
{
"type": "object",
"required": [
"event",
"date"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "The event date (birth date, wedding, last day at work, first day at a new job, release or end of reserve service, date of death, moving or key-handover day, purchase date, the date of reaching retirement age, the day the business starts or stops, aliyah date, expected due date for a pregnancy). Past or future."
},
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"as_of": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"maxLength": 10,
"description": "Which steps are \"for today\" (default: today in Israel)"
},
"event": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The life event, as an id or in words (Hebrew or English). Ids: aliyah, army-release, birth, buy-home, car, close-business, death, divorce, elderly-parent, first-employee, job-loss, marriage, moving, new-business, new-job, pregnancy, rent-home, reserve-duty, retirement, school-start."
},
"answers": {
"type": "object",
"description": "Optional answers that shape the plan (anything missing takes the default). Per event: aliyah: status (oleh|returning|senior_returning), city, address, tenure (tenant|owner|family), employed (yes|no), license (yes|no); army-release: service_len (full|12plus|under12), next (work|study|search|other), job_start (YYYY-MM-DD), arnona_payer (yes|no), city, address; birth: place (hospital|home|abroad), name_given (yes|no), married (yes|no), mother_work (employee|self|none), leave_start (YYYY-MM-DD), extend_unpaid (yes|no|maybe), employer_name, partner_work (employee|self|none|na), daycare (yes|maybe|no), passport (yes|no); buy-home: home_type (single|replacement|additional), seller (second|contractor), mortgage (yes|no), live (yes|no), move_date (YYYY-MM-DD), from_city, to_city, old_tenure (tenant|owner|parents), old_address, new_address; car: role (buy|sell), counterpart (private|dealer), online (yes|no), badge (yes|no), kvish6 (yes|no|unknown), car_number; close-business: type (patur|murshe|company), had_employees (yes|no), assets (no|yes), premises (home|rented), city, premises_address, next (employee|none); death: relation (parent|spouse|other), deceased_name, spouse_alive (yes|no), kids_under18 (yes|no), had_allowance (yes|no|unknown), will (yes|no|unknown), home (family|empty|none), city, home_address, car (yes|no), mortgage (yes|no), worked (yes|no), carer (yes|no), firearm (yes|no), dispute (no|yes); divorce: stage (separated|divorced), kids (yes|no), kids_with (me|other|split|shared), housing (i_leave|i_stay|none), move_date (YYYY-MM-DD), arnona_mine (yes|no|unknown), from_city, to_city, old_address, new_address, employed (yes|no), name_back (yes|no|later), old_name, new_name; elderly-parent: lives_alone (yes|no), adl (yes|some|no), ltc (yes|no), old_age (yes|supplement|no), caregiver (foreign|israeli|company|unknown), hire_date (YYYY-MM-DD), car (yes|no), city, address; first-employee: biz (patur|murshe|company), emp_pension (yes|no|unknown), payroll (self|rep), business_name; job-loss: how (fired|resigned|ended), tenure (under1|1plus), work_months (under12|12|16|17|18), next_job (yes|no), unemployment (yes|no), group_health (yes|no|unknown), dispute (no|yes), employer_name, start_date (YYYY-MM-DD); marriage: where (religious|abroad), name (yes|no|later), old_name, new_name, employed (yes|no), prenup (yes|maybe|no); moving: from_city, to_city, tenure (tenant|owner), old_tenure (tenant|owner|parents), old_address, new_address, kids (yes|no), car (yes|no), gas (yes|no|unknown), employed (yes|no); new-business: type (patur|murshe|unsure), employee_too (yes|no), hire (yes|no), premises (home|rented), license (no|yes|unknown), age_band (under21|21-60|over60); new-job: other_income (second|earlier|no), had_pension (yes|no|unknown), employer_name; pregnancy: work (employee|self|none), tenure (lt6|6to12|12plus), employer_name, leave_start (YYYY-MM-DD), risk (yes|no); rent-home: lease_end (YYYY-MM-DD), option (yes|no), broker (yes|no), from_city, to_city, old_tenure (tenant|owner|parents), old_address, new_address; reserve-duty: service_start (YYYY-MM-DD), long (yes|no), work (employee|self|both|student|none), student (yes|no), combat (yes|no), employer_name, dismissed (no|yes), arnona_payer (yes|no), city, address; retirement: sex (m|f), age_67 (YYYY-MM-DD), work_after (no|yes|part), work_pension (yes|no), payers (one|more), low_income (yes|no|unknown), city, address, employer_name; school-start: stage (daycare|gan|first|other), city, moved (yes|no), move_date (YYYY-MM-DD), new_address, change_school (yes|no), after_school (yes|maybe|no).",
"maxProperties": 30,
"additionalProperties": {
"type": "string",
"maxLength": 80
}
},
"for_whom": {
"enum": [
"me",
"other"
],
"type": "string",
"description": "other = the plan is prepared by a family member for another person (labelled as such; the plan is information only and nothing is sent)"
},
"subject_name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "First name of the person the plan is for, when for_whom = other"
},
"reminder_days_before": {
"type": "integer",
"maximum": 30,
"minimum": 0,
"description": "Calendar alarm this many days before each deadline (0 = none, default 3)"
}
},
"additionalProperties": false
}{
"type": "object",
"properties": {
"type": {
"enum": [
"parameter",
"form",
"deadline"
],
"type": "string"
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"since": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Only changes detected on or after this date"
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 10000,
"minimum": 0
},
"target": {
"type": "string",
"maxLength": 120,
"description": "Only targets starting with this (e.g. \"btl.\" or \"101\")"
},
"effective_to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Only changes that take effect on or before this date"
},
"effective_from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Only changes that take effect on or after this date (e.g. \"2026-01-01\" for this year)"
},
"include_notices": {
"type": "boolean",
"default": true,
"description": "Include notices that a verified period ends (no new law)"
},
"include_backfill": {
"type": "boolean",
"default": true,
"description": "Include history that was in the dataset when the feed started"
}
},
"additionalProperties": false
}| degree |
| object |
| retired | boolean |
| locality | string | Town of residence in Hebrew (for the locality tax benefit), e.g. "שדרות" |
| birth_year* | integer |
| disability | object |
| low_income | boolean | Household with a low income |
| parent_role | string | main = the children live with me / I am the mother, other = the other parent |
| army_service | object |
| nursing_care | boolean | Someone at home needs nursing care |
| owns_property | boolean | Owns real estate (excludes the work grant) |
| single_parent | string | one = sole parent (other parent died / not registered), divorced = divorced or separated parent with the children, "" = neither |
| marital_status | string |
| reserve_combat | boolean | Combat reservist |
| locality_since_year | integer |
| children_birth_years | array | Birth year of each child |
| told_employer_form_101 | string | Did you report your credit point reasons (children, degree, discharge...) on form 101 this year |
{
"type": "object",
"required": [
"sex",
"birth_year"
],
"properties": {
"job": {
"type": "object",
"required": [],
"properties": {
"ended": {
"enum": [
"none",
"fired",
"quit",
"justified"
],
"type": "string",
"description": "Last job ended: none, fired, quit, quit with a justified reason"
},
"current": {
"type": "boolean",
"description": "Employed now"
},
"monthly_wage": {
"type": "number",
"maximum": 1000000,
"minimum": 0,
"description": "Gross monthly wage now, ILS"
},
"tenure_years": {
"type": "number",
"maximum": 60,
"minimum": 0
},
"scope_percent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"ended_months_ago": {
"type": "integer",
"maximum": 120,
"minimum": 0
},
"recuperation_paid": {
"enum": [
"yes",
"no",
"old",
"unsure"
],
"type": "string",
"description": "Recuperation pay received: yes, no, at the old rate, unsure"
},
"ended_tenure_years": {
"type": "number",
"maximum": 60,
"minimum": 0
},
"unemployment_claimed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"sex": {
"enum": [
"f",
"m"
],
"type": "string"
},
"home": {
"enum": [
"rent",
"own",
"other"
],
"type": "string"
},
"lang": {
"enum": [
"he",
"en"
],
"type": "string",
"default": "he",
"description": "Language of the summary text: he (default) or en. Files stay in Hebrew (official forms and Israeli letters)."
},
"birth": {
"type": "object",
"required": [],
"properties": {
"recent": {
"type": "boolean",
"description": "Gave birth or adopted recently"
},
"claimed": {
"type": "boolean",
"description": "Maternity allowance already claimed"
},
"insured_months_of_14": {
"type": "integer",
"maximum": 14,
"minimum": 0
}
},
"additionalProperties": false
},
"years": {
"type": "object",
"description": "Per tax year (2020, 2021, 2022, 2023, 2024, 2025, 2026): work status, salary band or exact form 106 numbers, benefits",
"maxProperties": 7,
"propertyNames": {
"enum": [
"2020",
"2021",
"2022",
"2023",
"2024",
"2025",
"2026"
]
},
"additionalProperties": {
"type": "object",
"required": [
"status"
],
"properties": {
"months": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "Months worked that year"
},
"status": {
"enum": [
"full",
"part",
"self",
"mix",
"none"
],
"type": "string",
"description": "full = salaried all year, part = salaried part of the year, self = self-employed, mix = salaried + self-employed, none = no work income"
},
"donations": {
"type": "number",
"maximum": 10000000,
"minimum": 0,
"description": "Section 46 donations, ILS"
},
"employers": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "Number of employers that year"
},
"maternity": {
"type": "boolean",
"description": "Got maternity allowance that year"
},
"points_106": {
"type": "number",
"maximum": 30,
"minimum": 0,
"description": "Credit points given on form 106"
},
"salary_band": {
"enum": [
"b1",
"b2",
"b3",
"b4",
"b5",
"b6",
"b7",
"b8"
],
"type": "string",
"description": "Monthly gross salary band: b1 = עד 4,000 ₪, b2 = 4,000 עד 6,500 ₪, b3 = 6,500 עד 9,000 ₪, b4 = 9,000 עד 12,000 ₪, b5 = 12,000 עד 16,000 ₪, b6 = 16,000 עד 22,000 ₪, b7 = 22,000 עד 30,000 ₪, b8 = 30,000 עד 45,000 ₪"
},
"reserve_days": {
"type": "integer",
"maximum": 400,
"minimum": 0,
"description": "Reserve duty days that year"
},
"unemployment": {
"type": "boolean",
"description": "Got unemployment benefit that year"
},
"tax_withheld_106": {
"type": "number",
"maximum": 100000000,
"minimum": 0,
"description": "Exact: tax withheld from form 106 (field 042), ILS"
},
"annual_income_106": {
"type": "number",
"maximum": 100000000,
"minimum": 0,
"description": "Exact: taxable salary from form 106 (field 158/172), ILS"
},
"own_pension_deposits": {
"type": "boolean",
"description": "Deposited to a pension / life insurance on your own"
}
},
"additionalProperties": false
}
},
"aliyah": {
"type": "object",
"required": [
"year",
"month"
],
"properties": {
"year": {
"type": "integer",
"maximum": 2027,
"minimum": 1990
},
"month": {
"type": "integer",
"maximum": 12,
"minimum": 1
}
},
"additionalProperties": false
},
"degree": {
"type": "object",
"required": [
"kind",
"year_finished"
],
"properties": {
"kind": {
"enum": [
"ba",
"ma"
],
"type": "string"
},
"study_years": {
"type": "integer",
"maximum": 6,
"minimum": 1
},
"year_finished": {
"type": "integer",
"maximum": 2027,
"minimum": 1990
}
},
"additionalProperties": false
},
"retired": {
"type": "boolean"
},
"locality": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Town of residence in Hebrew (for the locality tax benefit), e.g. \"שדרות\""
},
"birth_year": {
"type": "integer",
"maximum": 2012,
"minimum": 1920
},
"disability": {
"type": "object",
"required": [],
"properties": {
"self": {
"type": "boolean"
},
"child": {
"type": "boolean"
}
},
"additionalProperties": false
},
"low_income": {
"type": "boolean",
"description": "Household with a low income"
},
"parent_role": {
"enum": [
"main",
"other"
],
"type": "string",
"description": "main = the children live with me / I am the mother, other = the other parent"
},
"army_service": {
"type": "object",
"required": [
"kind",
"discharge_year",
"discharge_month"
],
"properties": {
"kind": {
"enum": [
"full",
"short"
],
"type": "string"
},
"discharge_year": {
"type": "integer",
"maximum": 2027,
"minimum": 1990
},
"discharge_month": {
"type": "integer",
"maximum": 12,
"minimum": 1
}
},
"additionalProperties": false
},
"nursing_care": {
"type": "boolean",
"description": "Someone at home needs nursing care"
},
"owns_property": {
"type": "boolean",
"description": "Owns real estate (excludes the work grant)"
},
"single_parent": {
"enum": [
"one",
"divorced",
""
],
"type": "string",
"description": "one = sole parent (other parent died / not registered), divorced = divorced or separated parent with the children, \"\" = neither"
},
"marital_status": {
"enum": [
"single",
"married",
"divorced",
"widowed",
"separated"
],
"type": "string"
},
"reserve_combat": {
"type": "boolean",
"description": "Combat reservist"
},
"locality_since_year": {
"type": "integer",
"maximum": 2027,
"minimum": 1950
},
"children_birth_years": {
"type": "array",
"items": {
"type": "integer",
"maximum": 2027,
"minimum": 1990
},
"maxItems": 15,
"description": "Birth year of each child"
},
"told_employer_form_101": {
"enum": [
"yes",
"no",
"unsure"
],
"type": "string",
"description": "Did you report your credit point reasons (children, degree, discharge...) on form 101 this year"
}
},
"additionalProperties": false
}