FamilyWell

Use this when the user wants to restock an item by putting it on the family's "Replenish" shopping list. Repeating it adds nothing while the item is still on the list unbought. When it is marked bought in Shopping, the stock level is topped back up automatically.

inventory_add_to_shopping

Use this when the user wants a to-do attached to a calendar event, e.g. "book hotel" for a trip. Optionally a sub-task of one of the event's to-dos, with a due date and an assignee. For one day of a multi-day event (e.g. "buy fish on day 3"), set due_date to that day: that makes it the day's to-do. Do not use for a stand-alone to-do (that is tasks_create_task).

calendar_add_todo

Use this when the user used up or restocked some of an item. Send `change` (negative = used, positive = restocked, in the item's unit) or `quantity` (the new total after counting). The change is logged in the item's history.

inventory_adjust_quantity

Use this when the user wants a file (PDF or image, up to 12 MB) added to an existing repair (added to its attachments) or document (replaces its file). Ids come from vehicles_add_repair, vehicles_add_document, vehicles_get (document_id) or vehicles_get_history ("repair-12" means repair 12). For a service invoice use vehicles_add_document with type service_invoice.

vehicles_attach_file

Use this when the user says a planned service was done. Records it in the service history, resets when it is next due, moves the odometer forward, closes its reminder task, and records any cost in Spending. An invoice file (`file`, `file_url` or `file_base64`) is filed with the car's documents.

vehicles_complete_maintenance

Use this when the user wants a new kind of event on the family calendar, e.g. "Sports" or "Doctor". Everyone in the family sees it as a filter. Then put events in it with calendar_create_event or calendar_update_event using the returned slug.

calendar_create_category

Use this when the user wants to put something on the family calendar: a trip, appointment, conference or holiday. All-day unless start_time and end_time are given. Can repeat, and can be linked to people and a project.

calendar_create_event

Use this when the user wants to add a person to the family address book, optionally with phone numbers, emails, addresses, links or other contact methods. Look the name up with contacts_list beforehand when a duplicate is possible.

contacts_create

Use this when the user wants to write something down as a note. The note belongs to this person and is visible to the family. The body supports # headings, - lists, [ ] checklists and **bold**. A folder name files it there, creating the folder if needed.

notes_create

Use this when the user wants to start a family project (a renovation, a move, a party...). The project belongs to this person and is visible to the whole family.

projects_create

Use this when the user wants to save a recipe: title, ingredients (name, amount, unit, grouped into sections if the recipe has them), steps, and servings and/or the total it makes so it can be scaled later. A photo can be attached (`file`, `file_url` or `file_base64`); when none can be passed, save without it and give the person the recipe `url` to add one. Visible to the whole family by default.

recipes_create

Use this when the user wants a new shopping list, optionally for one store. The list belongs to this person and is visible to the whole family.

shopping_create_list

Use this when the user wants a separate spending list: a trip, a budget, or a project's costs. Everyone in the family takes part. With project_id it is linked to that project and kept out of monthly spending by default (count_in_monthly false), while still totalling its own expenses.

spending_create_list

Use this when the user wants a new to-do list. The list belongs to this person and is visible to the whole family.

tasks_create_list

Use this when the user wants to add a to-do to one of the family's to-do lists, optionally as a sub-task (one level deep), with a due date and an assignee. The assignee gets a notification. Do not use for project tasks (projects_add_task) or event to-dos (calendar_add_todo).

tasks_create_task

Use this when the user wants to remove a birthday. The contact itself is kept. The birthday goes to the trash and can be restored for 30 days with birthdays_restore.

birthdays_delete

Use this when the user wants to remove a calendar event. Removes every occurrence and the event's to-dos; they go to the trash and can be restored for 30 days with calendar_restore. Only the person who created the event can delete it.

calendar_delete_event

Use this when the user wants a whole car removed, with everything recorded for it (mileage, services, repairs, fuel, documents and their files). It goes to the trash and can be restored for 30 days with vehicles_restore. Its expenses stay in Spending.

vehicles_delete_vehicle

Use this when the user wants one record of a car deleted: a mileage reading (e.g. a duplicate), a fuel fill, a repair (with its attachments), a document (with its file) or a maintenance schedule (its past services stay). Deleting the newest mileage reading sets the odometer back to the previous one. Records go to the trash and can be restored for 30 days with vehicles_restore. Do not use to delete the whole car (that is vehicles_delete_vehicle).

vehicles_delete_record

Use this when the user wants to remove a person from the address book. Their contact methods and anything other modules keep on them (e.g. their birthday) go too. Everything goes to the trash and can be restored for 30 days with contacts_restore.

contacts_delete

Use this when the user wants a day mark taken off an event's days. It goes to the trash and can be restored for 30 days with calendar_restore.

calendar_delete_mark

Use this when the user wants the note removed from one day of an event. It goes to the trash and can be restored for 30 days with calendar_restore.

calendar_delete_day_note

Use this when the user wants to remove a to-do (and its sub-tasks) from a calendar event. It goes to the trash and can be restored for 30 days with calendar_restore.

calendar_delete_todo

Use this when the user wants an expense deleted. It goes to the trash and can be restored for 30 days with spending_restore.

spending_delete_expense

Use this when the user wants to delete a note. It goes to the trash and can be restored for 30 days with notes_restore. Only the person who created the note can delete it.

notes_delete

Use this when the user wants to delete a whole project. The project and its tasks go to the trash and can be restored for 30 days with projects_restore; linked shopping and spending lists are kept. Only the person who created it can delete it.

projects_delete

Use this when the user wants to delete a task (and its sub-tasks) from a project. It goes to the trash and can be restored for 30 days with projects_restore.

projects_delete_task

Use this when the user wants to delete a recipe. It goes to the trash and can be restored for 30 days from Settings > Recently deleted in FamilyWell. Only the person who created it can delete it.

recipes_delete

Use this when the user wants an item removed from a shopping list. It goes to the trash and can be restored for 30 days with shopping_restore. Do not use to tick an item off as bought (that is shopping_update_item with bought=true).

shopping_delete_item

Use this when the user wants a whole shopping list deleted. The list and its items go to the trash and can be restored for 30 days with shopping_restore. Only the person who created the list can delete it.

shopping_delete_list

Use this when the user wants to stop tracking a stock item. The item and its history go to the trash and can be restored for 30 days with inventory_restore. A shopping-list row it added stays on that list.

inventory_delete_item

Use this when the user wants a whole to-do list deleted. The list and its tasks go to the trash and can be restored for 30 days with tasks_restore. Only the person who created the list can delete it.

tasks_delete_list

Use this when the user wants a task (and its sub-tasks) deleted. It goes to the trash and can be restored for 30 days with tasks_restore. Do not use to tick a task off (that is tasks_update_task with done=true).

tasks_delete_task

Use this when the user wants the car's full history as a PDF (e.g. to sell the car). Returns a download link to a PDF of services, repairs, fuel, documents and mileage with totals per year and category. The link works for 24 hours without signing in; give it to the person.

vehicles_export_history

Use this when the user asks about one calendar event in detail. Returns its dates, people, to-dos, linked project and repeat rule and, for an event longer than one day, its days: the marks and the note on each day. Read-only.

calendar_get_event

Use this when the user asks about one car in detail. Returns its details, maintenance schedules (recurring and one-off) with what is due by km and date, documents and their expiry, fuel consumption, and recent services and repairs. Distances in km. Read-only.

vehicles_get

Use this when the user asks what was done to a car and when, e.g. "when did we last change the oil?". Returns services, repairs, mileage readings, tyre changes, documents and expenses (costed fuel fills appear as expenses), newest first, each with date, km and cost. Read-only.

vehicles_get_history

Use this when the user asks for one person's details. Returns their contact methods plus what other enabled modules add (e.g. birthday, age, next birthday). Read-only.

contacts_get

Use this when the user asks about one expense in detail. Returns its amount, category, shop, date, who paid and its list. Read-only.

spending_get_expense

Use this when you need the family's members (ids, names, roles), which FamilyWell modules are turned on, or what this connection may read or change in each, for example to find a member id for an assignee or to explain why a module can't be reached. `not_connected` lists modules the family uses that this connection was not granted; the person can add them by reconnecting FamilyWell. Read-only.

get_family