Block a time slot in a team member's calendar so nobody books it.

Adds blocked time as Add > Blocked time in the calendar does: one block on one day for one team member, with a title and a note for the team. It does not repeat. Clients cannot book it online unless allow_online_booking is true. Nobody is told.

Add a client to the business's client list.

Adds a client as Add client in the Client list does: name, email, mobile and gender. With appointment_messages (default true) Fresha sends the client booking confirmations and reminders to the email and mobile given; marketing (default false) records consent to marketing messages. Nothing is sent when the client is added.

Add a note to a client's profile, seen by the team only.

Adds a note to the client's Notes tab for all locations, as the profile's Add note does. Only the team sees it; the client is not told. Line breaks become paragraphs.

Cancel an appointment without a charge, optionally telling the client.

Cancels the appointment as Cancel in its drawer does, with one of the business's cancellation reasons. With notify_client (default true) Fresha sends the client a cancellation message, so this can reach the client; false cancels quietly. whole_series also cancels the later appointments of a repeating series. An appointment with a cancellation fee or a paid deposit is refused: cancel it in Fresha. It cannot be undone here.

Book an appointment for a client: services, team member and start time.

Books the services one after another from start_at with one team member, as New appointment in the calendar does, at each service's catalogue price. Fresha may send the client a booking confirmation by their notification settings (get_client), so this can reach the client. Find free times with find_available_slots first: Fresha books over other appointments and returns its warnings.

Free start times for one or more services with a team member, day by day.

Asks the calendar for free start times as New appointment does, for the services done one after another, with one team member, over up to 14 days. Times are wall clock in the business's time zone; closed days have no times. Book a time with create_appointment.

One appointment: client, services, team member, times, status, price and notes.

Reads the appointment as its drawer in the calendar shows it: status, start and end (wall clock in the business's time zone), the client, each booked service with its team member and length, the total and what is left to pay, and the appointment notes.

One client: contact, notification settings, booking stats, upcoming appointments, notes.

Reads the client profile as the client's page shows it: name, email, mobile, gender, birthday, whether Fresha sends them appointment messages and marketing by email, SMS and WhatsApp, booking and sales totals, the next 10 appointments and the latest 10 notes.

Sales summary for a period: sales, refunds, discounts, taxes and payments by type.

Reads Reports > Sales summary for the days given: one row per sale type (services, products, memberships, gift cards and so on) with Fresha's own columns (gross and net sales, discounts, refunds, taxes) and a totals row. columns names each key. A period without sales has no rows. Amounts are in the business's currency.

Appointments in a date range, with client, service, team member, price and status.

Lists appointments as Sales > Appointments shows them, latest first: one row per booked service with its appointment id, reference, start (wall clock in the business's time zone), length, client, team member, price, status and channel (online or offline). Cancelled appointments are included with their status. Page with next_cursor. The report itself has no status, team member or client filter, so those three apply to the first 100 rows of the date range: for a busy range, narrow the dates.

Clients of the business, searchable by name, email or phone.

Lists clients as the Client list shows them, newest first by default, with email, mobile, gender, total sales, review count and whether they are blocked. search matches name, email or phone. total is the number of matching clients. Page with next_cursor.

Client reviews of the business with rating, text and replies.

Lists reviews as Online reputation shows them, newest first: star rating, text, author, the client and appointment it is about, source (Fresha or Google) and the replies. Filter by rating, source, words or reviews still without a reply. Page with next_cursor.

Sales (invoices) in a date range: number, date, client, status and totals.

Lists sales as Sales > Sales list shows them for the days given, one row per sale with Fresha's columns (sale number, date, client, status, gross total and so on; linked records come with an _id). Amounts are in the business's currency. Page with next_cursor.

Services of the business with category, duration and price.

Lists the active services of the business's location as the Catalogue shows them, with their category, duration in minutes, price and whether clients can book them online. A service with several prices (by length or level) lists each as a pricing level; bookings use the first one. Use service_id in find_available_slots and create_appointment.

Team members with role, contact, services they do and whether they take bookings.

Lists the team as Team members shows it: name, email, mobile, role (owner, manager, basic), job title, whether they take bookings and online bookings, the services assigned to them and their location. Also lists the business's locations. Use team_member_id in the calendar tools.

Post a public reply to a client's review.

Posts a reply under the review as Reply in Online reputation does, signed as the business or the team member. The reply is public on the business's Fresha page and the client is told, so this reaches people. It needs a review that exists: take review_id from list_reviews.

Move an appointment to a new start time, optionally to another team member.

Moves every service of the appointment by the same amount so the first starts at start_at, as Reschedule in the appointment drawer does; lengths and prices stay. team_member_id moves all services to that team member. With notify_client (default true) Fresha sends the client a reschedule message by their notification settings; false moves it quietly. Cancelled, completed and no-show appointments are refused.