{"openapi":"3.0.0","info":{"title":"Simplybook API","version":"1.0.0","description":"This API requires two authentication headers: X-Company-Login and X-Token. The X-Company-Login contains the company identifier and X-Token contains the authentication token received from the \/public\/auth\/token endpoint.","x-authentication-examples":{"example1":{"headers":{"X-Company-Login":"your-company-login","X-Token":"your-authentication-token"},"description":"Include both headers with every request"}}},"servers":[{"url":"https:\/\/user-api-v2.simplybook.me","description":"Default server - American\/Global"},{"url":"https:\/\/user-api-v2.simplybook.it","description":"Default server - Europe\/Global"},{"url":"https:\/\/user-api-v2.simplybook.asia","description":"Default server - Asia\/Pacific"},{"url":"https:\/\/user-api-v2.simplybook.vip","description":"Enterprise VIP server"},{"url":"https:\/\/user-api-v2.simplybook.cc","description":"Enterprise CC server"},{"url":"https:\/\/user-api-v2.simplybook.us","description":"United States regional server"},{"url":"https:\/\/user-api-v2.simplybook.pro","description":"Enterprise PRO server"},{"url":"https:\/\/user-api-v2.enterpriseappointments.com","description":"Enterprise appointments server"},{"url":"https:\/\/user-api-v2.simplybook.webnode.page","description":"Webnode integration server"},{"url":"https:\/\/user-api-v2.servicebookings.net","description":"Service bookings network server"},{"url":"https:\/\/user-api-v2.booking.names.uk","description":"UK Names domain server"},{"url":"https:\/\/user-api-v2.booking.lcn.uk","description":"UK LCN domain server"},{"url":"https:\/\/user-api-v2.booking.register365.ie","description":"Ireland Register365 domain server"}],"paths":{"\/public\/auth\/token":{"post":{"tags":["auth"],"summary":"Authentication","description":"Authentication process for widget API (Smart widget custom feature has to be enabled). Returns auth token info (<a href=\"#model-PublicTokenEntity\">PublicTokenEntity<\/a>).<br>Accepts company and key data as body of request.<br>Returns 401 error if invalid credentials are provided.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicTokenEntity"}}}},"401":{"description":"Invalid credentials","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_auth_token","security":[],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"company":{"description":"identifier (login)","type":"string"},"key":{"description":"authentication key","type":"string"}}}}}}}},"\/public\/company":{"get":{"tags":["company"],"summary":"Get company information","description":"Returns general information about the company <a href=\"#model-CompanyInfoEntity\">(CompanyInfoEntity)<\/a>, including name, contact details,<br>configuration settings, and other public attributes.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanyInfoEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_company"}},"\/public\/config":{"get":{"tags":["company"],"summary":"Get application configuration","description":"Returns system configuration settings <a href=\"#model-PublicConfigEntity\">(PublicConfigEntity)<\/a> including company information,<br>date\/time formats, timezone, and various feature settings.<br>This endpoint is used to initialize client applications with necessary configuration.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicConfigEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_config"}},"\/public\/plugins":{"get":{"tags":["company"],"summary":"Get enabled plugins list","description":"Returns a list <a href=\"#model-PluginEntity\">(PluginEntity)<\/a> of plugins available in the system along with their activation status.<br>This endpoint can be used to determine which features are available for the client.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/PluginEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_plugins"}},"\/public\/countries":{"get":{"tags":["common"],"summary":"Get countries list","description":"Returns a list of all available countries <a href=\"#model-CountryEntity\">(CountryEntity)<\/a> with their ISO codes.<br>This data can be used for address forms, location filtering, and other geography-related functionality.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/CountryEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_countries"}},"\/public\/countries\/states":{"get":{"tags":["common"],"summary":"Get states\/provinces list","description":"Returns a list of states or provinces <a href=\"#model-StateEntity\">(StateEntity)<\/a> for a specified country.<br>Currently only supports US states. Returns an empty array for other countries.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/StateEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_countries_states","parameters":[{"name":"filter[country_id]","in":"query","required":true,"description":"Country ISO code (e.g., 'US')","schema":{"type":"string"}}]}},"\/public\/timezone":{"get":{"tags":["common"],"summary":"Get timezones list","description":"Returns list of timezones <a href=\"#model-TimezoneEntity\">(TimezoneEntity)<\/a> available for client to select,<br>when 'show_booking_page_in_client_timezone' option (<a href=\"#model-PublicConfigEntity\">PublicConfigEntity<\/a>) is enabled.<br>Selected timezone should be stored by POST \/public\/clients\/timezone.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/TimezoneEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_timezone"}},"\/public\/booking\/item":{"post":{"tags":["booking"],"summary":"Make new booking","description":"Make new booking and return booking result <a href=\"#model-PublicBookingResultEntity\">(PublicBookingResultEntity)<\/a>.<br>Accepts <a href=\"#model-PublicBookingBuildEntity\">(PublicBookingBuildEntity)<\/a> data as body of request.<br>Throws AccessDenied error in case user does not have access to booking.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.<br><br>When the Classes plugin is enabled and <code>service_id<\/code> is a class (<code>is_class<\/code> in service<br>data), <code>provider_id<\/code> can be omitted - the class provider is used.<br><br>When the Anti Fraud captcha feature is enabled, a <code>captcha_token<\/code> field must be included in the<br>request body. To obtain a token: call <code>GET \/public\/captcha\/challenge\/<\/code> to get the challenge,<br>then pass it to the ready-made JS widget (<code>\/v2\/js\/lib\/captcha\/captcha-widget.js<\/code>) which generates<br>the token via <code>widget.getToken()<\/code>. Full integration guide is in the Anti Fraud plugin settings.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicBookingResultEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_booking_item","requestBody":{"required":true,"description":"booking data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicBookingBuildEntity"}}}}}},"\/public\/booking\/item\/id\/{id}":{"get":{"tags":["booking"],"summary":"Get booking details","description":"Return booking item <a href=\"#model-BookingInfoEntity\">(BookingInfoEntity)<\/a> by booking id.<br>Throws AccessDenied error in case user does not have access to booking.<br>Throws NotFound error in case booking is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BookingInfoEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied or Forbidden: When user does not have access to booking","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_booking_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}},{"name":"hash","in":"query","required":false,"description":"client hash for authentication (optional)","schema":{"type":"string"}},{"name":"include","in":"query","required":false,"description":"comma-separated list of additional data to include (service,provider,category,location)","schema":{"type":"string"}}]},"delete":{"tags":["booking"],"summary":"Cancel booking","description":"Cancel booking by booking id and return canceled booking <a href=\"#model-BookingInfoEntity\">(BookingInfoEntity)<\/a>.<br>Throws AccessDenied error in case user does not have access to booking.<br>Throws NotFound error in case booking is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BookingInfoEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_booking_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}},{"name":"reason","in":"query","required":true,"description":"cancellation reason (in query)","schema":{"type":"string"}},{"name":"hash","in":"query","required":false,"description":"client hash for authentication (optional, in query)","schema":{"type":"string"}}]}},"\/public\/booking":{"get":{"tags":["booking"],"summary":"Get list of bookings","description":"Return list of bookings <a href=\"#model-PublicListBookingInfoEntity\">(PublicListBookingInfoEntity)<\/a> for the client. Can be filtered by various parameters.<br>Requires a client token (from client login) or a client hash.<br>Throws AccessDenied error in case user does not have access to view bookings.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicListBookingInfoEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_booking","parameters":[{"name":"filter[confirmed_only]","in":"query","required":false,"description":"return only confirmed bookings (0 or 1, default 1). Cancelled bookings are not confirmed, so pass 0 to include them","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[upcoming_only]","in":"query","required":false,"description":"filter by upcoming dates (0 or 1)","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[past_only]","in":"query","required":false,"description":"filter by past dates (0 or 1)","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[batch_id]","in":"query","required":false,"description":"filter by batch id (must be used together with filter[batch_type])","schema":{"type":"integer"}},{"name":"filter[batch_type]","in":"query","required":false,"description":"filter by batch type: enum['recurring','multiple','group'] (must be used together with filter[batch_id])","schema":{"type":"string","enum":["recurring","multiple","group"],"description":"filter by batch type: recurring\/multiple\/group (must be used together with filter[batch_id])"}},{"name":"order_field","in":"query","required":false,"description":"field to order by (date_start, record_date)","schema":{"type":"string"}},{"name":"order_direction","in":"query","required":false,"description":"direction to order (asc, desc)","schema":{"type":"string"}},{"name":"hash","in":"query","required":false,"description":"client hash for authentication (optional)","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/booking\/batch\/id\/{id}":{"delete":{"tags":["booking"],"summary":"Cancel batch of bookings","description":"Cancel multiple bookings in a batch and return canceled bookings <a href=\"#model-BookingInfoEntity\">(BookingInfoEntity)<\/a>.<br>Please note we pass booking id (not batch id) because we have deletion modes that work starting with specified booking and all next ones<br>Throws AccessDenied error in case user does not have access to bookings.<br>Throws NotFound error in case booking batch is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/BookingInfoEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_booking_batch_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}},{"name":"mode","in":"query","required":true,"description":"cancellation mode (recurring_batch, multiple_batch, recurring_next, multiple_next) (in query)","schema":{"type":"string"}},{"name":"reason","in":"query","required":true,"description":"cancellation reason (in query)","schema":{"type":"string"}},{"name":"hash","in":"query","required":false,"description":"client hash for authentication (optional, in query)","schema":{"type":"string"}}]}},"\/public\/booking\/validate-time":{"post":{"tags":["booking"],"summary":"Validate booking time","description":"Validate if a booking time is available and valid for the given service, provider, and time.<br>Returns validation result <a href=\"#model-Timeline_TimeValidationResultEntity\">Timeline_TimeValidationResultEntity<\/a> with available status and any error messages.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Timeline_TimeValidationResultEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_booking_validate_time","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"service_id":{"description":"Service ID or array of Service IDs","oneOf":[{"type":"integer"},{"type":"array","items":{"type":"integer"}}]},"start_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"provider_id":{"description":"Provider ID","type":"integer"},"count":{"description":"Number of bookings (for group bookings)","type":"integer"},"products":{"description":"Array of product IDs (addons)","type":"array","items":{"type":"integer"}}}}}}}}},"\/public\/booking\/ical\/id\/{id}":{"get":{"tags":["booking"],"summary":"Get iCal calendar data for booking","description":"Return iCal calendar data for booking by booking id.<br>Throws AccessDenied error in case user does not have access to booking.<br>Throws NotFound error in case booking is not found.\n\n**Return Description:** iCal calendar data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_booking_ical_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}},{"name":"batch","in":"query","required":true,"description":"include batch bookings if applicable (1 or 0)","schema":{"type":"integer","enum":[0,1]}},{"name":"hash","in":"query","required":false,"description":"client hash for authentication (optional)","schema":{"type":"string"}}]}},"\/public\/booking\/online-meeting-link\/id\/{id}":{"get":{"tags":["booking"],"summary":"Get online meeting link for booking","description":"Returns the online meeting link and online meeting ID for a specific booking.\n\n**Return Description:** Object with link (string) and online_meeting_id (integer)","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found When booking or meeting is not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_booking_online_meeting_link_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Booking ID","schema":{"type":"string"}}]}},"\/public\/booking\/reschedule\/id\/{id}":{"post":{"tags":["booking"],"summary":"Reschedule booking","description":"Reschedule a booking to a new start date\/time and return the updated booking <a href=\"#model-BookingInfoEntity\">(BookingInfoEntity)<\/a>.<br>If the booking belongs to a sequential (consecutive-services) batch, the whole batch is rescheduled<br>together: the batch's first booking moves to start_datetime and each subsequent booking shifts to<br>start right when the previous one ends. In that case an array of BookingInfoEntity is returned instead<br>of a single object.<br>Throws AccessDenied error in case user does not have access to booking.<br>Throws NotFound error in case booking is not found.<br>Throws BadRequest error in case the booking cannot be rescheduled or the new time is not available.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BookingInfoEntity"},{"type":"array","items":{"$ref":"#\/components\/schemas\/BookingInfoEntity"}}]}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_booking_reschedule_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"start_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"hash":{"description":"client hash for authentication (optional)","type":"string"}}}}}}}},"\/public\/timeline\/slots":{"get":{"tags":["booking"],"summary":"Get slots timeline","description":"Return data for slots timeline per date <a href=\"#model-Timeline_PublicSlotsDateEntity\">(Timeline_PublicSlotsDateEntity)<\/a>.<br>Throws BadRequest error in case invalid data was provided, or \"Too long period\" when the period between date_from and date_to is longer than 45 days.<br>Throws NotFound error in case no providers were found for the given location.<br><br>When client timezone is set (POST \/public\/clients\/timezone), each slot contains client_datetime.<br>Pass client_date_from\/client_date_to instead of date_from\/date_to to get slots for client dates:<br>slots are grouped by client date then (slot time and datetime are still in company timezone).\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Timeline_PublicSlotsDateEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_timeline_slots","parameters":[{"name":"service_id","in":"query","required":true,"description":"selected service id","schema":{"type":"integer"}},{"name":"date_from","in":"query","required":true,"description":"date from (YYYY-MM-DD format)","schema":{"type":"string","format":"date","description":"Date in format YYYY-MM-DD"}},{"name":"date_to","in":"query","required":true,"description":"date to (YYYY-MM-DD format), max 45 days after date_from","schema":{"type":"string","format":"date","description":"Date in format YYYY-MM-DD"}},{"name":"provider_id","in":"query","required":false,"description":"selected provider id (can be 'any' or omitted for any provider)","schema":{"type":"integer"}},{"name":"client_date_from","in":"query","required":false,"description":"date from in client timezone (YYYY-MM-DD format), instead of date_from","schema":{"type":"string"}},{"name":"client_date_to","in":"query","required":false,"description":"date to in client timezone (YYYY-MM-DD format), instead of date_to","schema":{"type":"string"}},{"name":"count","in":"query","required":false,"description":"bookings count","schema":{"type":"integer"}},{"name":"with_available_slots","in":"query","required":false,"description":"to calculate available slots count (Display Remaining Spaces custom feature required) (1 or 0)","schema":{"type":"integer","enum":[0,1]}},{"name":"booking_id","in":"query","required":false,"description":"if you want to edit existing booking, you can pass booking id","schema":{"type":"integer"}},{"name":"product_ids","in":"query","required":false,"description":"array of selected service addons ids","schema":{"type":"array","items":{"type":"integer"}}},{"name":"skip_min_max_restriction","in":"query","required":false,"description":"to skip min and max restriction","schema":{"type":"integer","enum":[0,1]}},{"name":"location_id","in":"query","required":false,"description":"selected location id (when provider_id is empty or 'any')","schema":{"type":"integer"}}]}},"\/public\/timeline\/first-available-day":{"get":{"tags":["booking"],"summary":"Get first available day","description":"Return first available day for a service and provider.<br>Throws NotFound error in case no providers were found for the given location.<br><br>When with_waiting_list is enabled and nothing is bookable, the earliest fully booked but<br>scheduled date is returned instead, mirroring the public booking page. The response stays a<br>plain date, so request that date's slots to tell the two cases apart: an empty slot list means<br>the date is waiting list only and the client can join the waiting list for it.\n\n**Return Description:** First available date (YYYY-MM-DD format)","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: When check_membership is used and no client is authenticated","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_timeline_first_available_day","parameters":[{"name":"service_id","in":"query","required":true,"description":"selected service id","schema":{"type":"integer"}},{"name":"provider_id","in":"query","required":false,"description":"selected provider id (can be 'any' or omitted for any provider)","schema":{"type":"integer"}},{"name":"start_datetime","in":"query","required":false,"description":"starting date\/time to search from (YYYY-MM-DD HH:MM:SS format), default: now + minimum time before booking","schema":{"type":"string","format":"date-time","description":"Date and time in format YYYY-MM-DD HH:MM:SS","example":"2026-11-22 20:42:38"}},{"name":"client_start_datetime","in":"query","required":false,"description":"starting date\/time in client timezone (YYYY-MM-DD HH:MM:SS format), instead of start_datetime. Returned date is a client date then (see POST \/public\/clients\/timezone)","schema":{"type":"string"}},{"name":"products","in":"query","required":false,"description":"array of selected service addons ids","schema":{"type":"array","items":{"type":"integer"}}},{"name":"location_id","in":"query","required":false,"description":"selected location id (when provider_id is empty or 'any')","schema":{"type":"integer"}},{"name":"booking_id","in":"query","required":false,"description":"if you want to reschedule an existing booking, pass its id instead of service_id\/provider_id \u2014 they are resolved from the booking (and from the whole batch, if it is a sequential batch)","schema":{"type":"integer"}},{"name":"count","in":"query","required":false,"description":"number of bookings to look for at once, for group bookings (default 1)","schema":{"type":"integer"}},{"name":"check_membership","in":"query","required":false,"description":"start the search from the earliest date on which the client's active memberships cover every requested service that requires one (0 or 1, default 0). Requires the membership plugin, otherwise ignored, and an authenticated client. Returns null when any requested service has no membership coverage at all","schema":{"type":"integer","enum":[0,1]}},{"name":"with_waiting_list","in":"query","required":false,"description":"fall back to a waiting list date when no bookable date is found (0 or 1, default 0). Requires the waiting list plugin, otherwise ignored. Bookable dates always win - a date is returned on this basis only when nothing is bookable in the planning horizon, and it is always a date the provider works, just fully booked","schema":{"type":"integer","enum":[0,1]}}]}},"\/public\/captcha\/challenge":{"get":{"tags":["booking"],"summary":"Get captcha challenge for booking","description":"Returns everything the client needs to render the captcha widget before creating a booking.<br>Call it before POST \/public\/booking\/item. If the response is { provider: null }, captcha is not<br>required for API bookings of this company. Otherwise:<br>  1. load the script from widgetUrl (SBCaptcha universal widget);<br>  2. render it: new SBCaptcha({ container: el, challenge: <this response>, onToken: fn });<br>  3. send the token from onToken as captcha_token in the POST \/public\/booking\/item body.<br>A token is single-use: fetch a new challenge after a failed booking.<br>The token is produced by the end user solving the widget, so integrations without a client-facing<br>UI cannot obtain it; the company can turn off \"Enable captcha for API integrations\" instead.<br><br>  fetch('\/public\/captcha\/challenge', { headers: { 'X-Company-Login': '...', 'X-Token': '...' } })<br>    .then(r => r.json())<br>    .then(data => new SBCaptcha({ container: el, challenge: data, onToken: fn }));<br><br>Response fields:<br>  provider       string   Active provider: 'fcaptcha' | 'altcha' | 'recaptcha' | 'recaptchav3' | 'turnstile' | 'imagecaptcha' | null<br>  widgetUrl      string   Absolute URL of the SBCaptcha widget loader script (captcha-widget.js)<br>  assets         object   { js: string[], css: string[] } \u2014 scripts\/styles to load before rendering.<br>                         For altcha and fcaptcha, JS URLs point to the public booking page proxy<br>                         (GET \/v2\/captcha\/asset?file=<provider>) which serves the file with<br>                         Access-Control-Allow-Origin: * for cross-origin ES module loading.<br>  site_key       string   reCAPTCHA public site key (recaptcha only)<br>  imageUrl       string   PNG captcha image URL with cache-buster (imagecaptcha only)<br>  challengeUrl   string   Absolute URL FCaptcha widget fetches sub-challenges from (fcaptcha only)<br>  verifyUrl      string   Absolute URL FCaptcha widget POSTs PoW solution to (fcaptcha only)<br>  verifyHeaders  object   Auth headers to include in the verifyUrl request (fcaptcha only;<br>                         SBCaptcha injects these automatically via fetch patch)<br>  algorithm, challenge, maxnumber, salt, signature  \u2014 Altcha challenge fields (altcha only)<br><br>If captcha is disabled for the company, returns { provider: null }.<br>Fail-open: if this endpoint is unreachable, proceed without captcha.","responses":{"200":{"description":"Successful response"},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_captcha_challenge"}},"\/public\/waiting-list":{"get":{"tags":["waiting_list"],"summary":"Get list of waiting list entries","description":"Return list of the client's waiting list entries <a href=\"#model-PublicListWaitingListEntity\">(PublicListWaitingListEntity)<\/a>.<br>A waiting list entry covers a whole day, not a time slot, so it has a date but no time.<br>Use filter[upcoming_only] to show the \"upcoming\" tab and omit it for the \"all\" tab.<br><br>Pass include=availability to additionally calculate, for every returned entry, whether the<br>requested day currently has free slots (is_available). That is a full timeline calculation<br>per date\/service\/provider\/count combination, so request it only when the client can act on it.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicListWaitingListEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: When the waiting list plugin is not activated","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_waiting_list","parameters":[{"name":"filter[upcoming_only]","in":"query","required":false,"description":"only entries for today and later (0 or 1)","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[past_only]","in":"query","required":false,"description":"only entries whose date has already passed (0 or 1) - the exact complement of filter[upcoming_only]","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[active_only]","in":"query","required":false,"description":"only entries the client is still waiting on (0 or 1)","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[history_only]","in":"query","required":false,"description":"only entries the client is no longer waiting on: date has passed or entry is inactive (0 or 1) - the exact complement of filter[upcoming_only] + filter[active_only]","schema":{"type":"integer","enum":[0,1]}},{"name":"order_field","in":"query","required":false,"description":"field to order by (date, record_date)","schema":{"type":"string"}},{"name":"order_direction","in":"query","required":false,"description":"direction to order (asc, desc)","schema":{"type":"string"}},{"name":"include","in":"query","required":false,"description":"comma-separated list of additional data to include (service,provider,location,category,availability)","schema":{"type":"string"}},{"name":"hash","in":"query","required":false,"description":"client hash for authentication (optional)","schema":{"type":"string"}}]}},"\/public\/waiting-list\/item\/{id}":{"get":{"tags":["waiting_list"],"summary":"Get waiting list entry details","description":"Return single waiting list entry <a href=\"#model-PublicWaitingListEntity\">(PublicWaitingListEntity)<\/a> by id.<br>Throws AccessDenied error in case the entry belongs to another client.<br>Throws NotFound error in case the entry is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicWaitingListEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: When the waiting list plugin is not activated","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_waiting_list_item_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : waiting list entry id","schema":{"type":"string"}},{"name":"include","in":"query","required":false,"description":"comma-separated list of additional data to include (service,provider,location,category,availability)","schema":{"type":"string"}},{"name":"hash","in":"query","required":false,"description":"client hash for authentication (optional)","schema":{"type":"string"}}]}},"\/public\/waiting-list\/item":{"post":{"tags":["waiting_list"],"summary":"Join the waiting list","description":"Add the client to the waiting list for a fully booked day and return the created entry<br><a href=\"#model-PublicWaitingListEntity\">(PublicWaitingListEntity)<\/a>. Accepts <a href=\"#model-PublicWaitingListBuildEntity\">(PublicWaitingListBuildEntity)<\/a> data as body of request.<br>The client is created on the fly from the \"client\" object, so no account is required.<br>Throws BadRequest error when the client already waits for that date or the data is invalid.\n\n**Return Description:** Response data","responses":{"201":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicWaitingListEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_waiting_list_item","requestBody":{"required":true,"description":"waiting list entry data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicWaitingListBuildEntity"}}}}}},"\/public\/waiting-list\/item\/id\/{id}":{"delete":{"tags":["waiting_list"],"summary":"Cancel waiting list entry","description":"Cancel the client's waiting list entry by id and return it <a href=\"#model-PublicWaitingListEntity\">(PublicWaitingListEntity)<\/a>.<br>Throws AccessDenied error in case the entry belongs to another client.<br>Throws NotFound error in case the entry is not found.<br>Throws BadRequest error in case the entry is already closed or its date has passed.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicWaitingListEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_waiting_list_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : waiting list entry id","schema":{"type":"string"}},{"name":"hash","in":"query","required":false,"description":"client hash for authentication (optional, in query)","schema":{"type":"string"}}]}},"\/public\/online-meeting\/item\/id\/{id}":{"get":{"tags":["online_meeting"],"summary":"Get online meeting details","description":"Return online meeting entity<a href=\"#model-OnlineMeetingEntity\">(OnlineMeetingEntity)<\/a><br>Throws AccessDenied error in case user does not have access.<br>Throws NotFound error in case entity is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OnlineMeetingEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_online_meeting_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : online meeting id","schema":{"type":"string"}}]}},"\/public\/clients":{"get":{"tags":["client"],"summary":"Get current client details","description":"Returns details <a href=\"#model-ClientEntity\">(ClientEntity)<\/a> of the currently logged in client.<br>Requires authentication with a valid client token.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_clients"},"post":{"tags":["client"],"summary":"Update client details","description":"Updates details and returns updated client <a href=\"#model-ClientEntity\">(ClientEntity)<\/a>.<br>Requires authentication with a valid client token.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"description":"client name (optional)","type":"string"},"email":{"description":"client email (optional)","type":"string"},"phone":{"description":"client phone (optional)","type":"string"},"is_email_unsubscribed":{"description":"email unsubscribe flag (optional)","type":"boolean"},"is_sms_unsubscribed":{"description":"SMS unsubscribe flag (optional)","type":"boolean"},"client_fields":{"description":"custom client fields values as key-value pairs {\"field_hash\": \"value\"}. For date fields use YYYY-MM-DD format. (optional)","type":"object","additionalProperties":{"type":"string"},"example":{"field_hash":"value"}}}}}}}}},"\/public\/clients\/login":{"post":{"tags":["client"],"summary":"Login with email and password","description":"Authenticate a client with email\/login and password.<br>Returns a token <a href=\"#model-PublicTokenEntity\">(PublicTokenEntity)<\/a> that contains client identification, which can be used for subsequent authenticated API calls<br>to access client-specific data and perform client-specific actions.<br>Set remember=true to extend token lifetime (30 days instead of 1 hour).\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicTokenEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients_login","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"login":{"description":"client email\/login","type":"string"},"password":{"description":"client password","type":"string"},"remember":{"description":"extend token lifetime","type":"boolean"}}}}}}}},"\/public\/clients\/logout":{"post":{"tags":["client"],"summary":"Logout current client","description":"Invalidates the current client session and returns new anonymous token <a href=\"#model-PublicTokenEntity\">(PublicTokenEntity)<\/a> that<br>allows the application to remain authenticated without client-specific access.<br>This new token should be used for all subsequent API calls to ensure the client is properly logged out.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicTokenEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients_logout"}},"\/public\/clients\/timezone":{"post":{"tags":["client"],"summary":"Set client timezone","description":"Stores client timezone in the token and returns new token <a href=\"#model-PublicTokenEntity\">(PublicTokenEntity)<\/a>, which should be used for all subsequent API calls.<br>Client and token lifetime are kept, token is re-issued with the timezone. Pass empty timezone to remove it from the token.<br>Works with anonymous and client tokens; the timezone is kept on client login\/logout.<br>Requires 'show_booking_page_in_client_timezone' option (<a href=\"#model-PublicConfigEntity\">PublicConfigEntity<\/a>) to be enabled.<br><br>Any valid timezone identifier is accepted (e.g. the one detected in browser). If it is not in the list of<br>timezones available for company (GET \/public\/timezone), the closest one by current offset is used<br>(returned in client_timezone field).<br><br>With timezone set, timeline and booking endpoints return client date\/time fields and accept client_* parameters.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicTokenEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: Client timezone is disabled or timezone is invalid","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients_timezone","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"timezone":{"description":"timezone identifier (e.g. 'America\/New_York')","type":"string"}}}}}}},"get":{"tags":["client"],"summary":"Get client timezone","description":"Returns client timezone <a href=\"#model-TimezoneEntity\">(TimezoneEntity)<\/a> stored in the current token, or null if it is not set<br>or 'show_booking_page_in_client_timezone' option is disabled.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TimezoneEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_clients_timezone"}},"\/public\/clients\/fields":{"get":{"tags":["client"],"summary":"Get client fields list","description":"Returns client fields list <a href=\"#model-Client_FieldDetailsEntity\">(Client_FieldDetailsEntity)<\/a>, including name, email, phone and address fields.<br>Set only-custom=1 to return only custom fields (Client fields custom feature).\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Client_FieldDetailsEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_clients_fields","parameters":[{"name":"only-custom","in":"query","required":true,"description":"return only custom fields (1 or 0)","schema":{"type":"integer","enum":[0,1]}}]}},"\/public\/clients\/register":{"post":{"tags":["client"],"summary":"Register a new client","description":"Creates a new client and returns authentication token <a href=\"#model-PublicTokenEntity\">(PublicTokenEntity)<\/a>.<br>Required fields are email, name, password, and terms acceptance.<br>Note: promotion_letters is not part of registration terms and is ignored if sent -<br>promo consent is only collected on booking (terms.promotion_letters).\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicTokenEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients_register","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"description":"client email","type":"string"},"name":{"description":"client name","type":"string"},"password":{"description":"client password","type":"string"},"phone":{"description":"client phone (optional)","type":"string"},"client_fields":{"description":"custom client fields values as key-value pairs {\"field_hash\": \"value\"}. For date fields use YYYY-MM-DD format.","type":"object","additionalProperties":{"type":"string"},"example":{"field_hash":"value"}},"terms":{"description":"legal terms acceptance flags","$ref":"#\/components\/schemas\/ClientTermsEntity"}}}}}}}},"\/public\/clients\/password":{"post":{"tags":["client"],"summary":"Change client password","description":"Updates the password for the currently logged in client.<br>Requires authentication with a valid client token.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients_password","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"old_password":{"description":"current client password","type":"string"},"password":{"description":"new client password","type":"string"}}}}}}}},"\/public\/clients\/terms":{"get":{"tags":["client"],"summary":"Get client terms versions","description":"Returns information about enabled terms and status <a href=\"#model-ClientTermsStatusEntity\">(ClientTermsStatusEntity)<\/a>.<br>Includes current acceptance status for the authenticated client.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientTermsStatusEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_clients_terms"},"put":{"tags":["client"],"summary":"Accept legal terms","description":"Explicitly accepts legal terms <a href=\"#model-simplybook terms, user terms, cancellation terms, privacy policy)<br>outside of registration or booking - e.g. when terms versions changed and a returning client<br>needs to re-accept them without making a new booking.<br><br>IMPORTANT: this method cannot set promotion_letters - it is not a valid parameter here and will<br>be ignored if sent. The response (ClientTermsStatusEntity\">(simplybook terms, user terms, cancellation terms, privacy policy)<br>outside of registration or booking - e.g. when terms versions changed and a returning client<br>needs to re-accept them without making a new booking.<br><br>IMPORTANT: this method cannot set promotion_letters - it is not a valid parameter here and will<br>be ignored if sent. The response (ClientTermsStatusEntity)<\/a> still includes accepted_promotion_letters<br>for completeness, but its value is unaffected by this call. Promotion letters consent is only<br>settable via booking (terms.promotion_letters, opt-in only) or via is_email_unsubscribed\/<br>is_sms_unsubscribed on POST \/public\/clients.<br><br>Acceptance only: sending false for any term is rejected with BadRequest - this endpoint<br>cannot revoke an acceptance. Omit a field to leave it unchanged.<br><br>Requires authentication with a valid client token.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientTermsStatusEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"put_public_clients_terms","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"simplybook_terms":{"description":"accept SimplyBook terms (optional)","type":"boolean"},"user_terms":{"description":"accept user license terms (optional)","type":"boolean"},"cancellation_terms":{"description":"accept cancellation policy (optional)","type":"boolean"},"privacy_policy":{"description":"accept privacy policy (optional)","type":"boolean"}}}}}}}},"\/public\/clients\/user-terms":{"get":{"tags":["client"],"summary":"Get user terms text","description":"Returns the full text of the user license terms.\n\n**Return Description:** user terms text","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_clients_user_terms"}},"\/public\/clients\/cancellation-terms":{"get":{"tags":["client"],"summary":"Get cancellation terms text","description":"Returns the full text of the cancellation policy.\n\n**Return Description:** cancellation terms text","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_clients_cancellation_terms"}},"\/public\/clients\/privacy-policy":{"get":{"tags":["client"],"summary":"Get privacy policy text","description":"Returns the full text of the privacy policy.\n\n**Return Description:** privacy policy text","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_clients_privacy_policy"}},"\/public\/clients\/remind-password":{"post":{"tags":["client"],"summary":"Send password reset email","description":"Sends a password reset email to the specified client email address.<br>Email will contain a hash link for resetting the password.\n\n**Return Description:** Success status","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients_remind_password","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"description":"client email address","type":"string"}}}}}}}},"\/public\/clients\/login-by-hash":{"post":{"tags":["client"],"summary":"Login with hash from email","description":"Authenticates a client and returns token <a href=\"#model-PublicTokenEntity\">(PublicTokenEntity)<\/a>.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicTokenEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients_login_by_hash","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"hash":{"description":"authentication hash from email","type":"string"},"remember":{"description":"extend token lifetime (optional)","type":"boolean"}}}}}}}},"\/public\/clients\/password-by-hash":{"post":{"tags":["client"],"summary":"Change password with hash","description":"Updates client password and returns token <a href=\"#model-PublicTokenEntity\">(PublicTokenEntity)<\/a>.<br>Used for password reset functionality.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicTokenEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_clients_password_by_hash","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"hash":{"description":"authentication hash from email","type":"string"},"password":{"description":"new client password","type":"string"}}}}}}}},"\/public\/services":{"get":{"tags":["service"],"summary":"Get service list","description":"Returns list <a href=\"#model-PublicListServiceEntity\">(PublicListServiceEntity)<\/a> of visible services. Can be filtered by name, description,<br>provider ID, category ID, location ID, type (service or class), and combinability.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicListServiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_services","parameters":[{"name":"filter[search]","in":"query","required":false,"description":"search in name and description","schema":{"type":"string"}},{"name":"filter[provider_id]","in":"query","required":false,"description":"filter by provider","schema":{"type":"integer"}},{"name":"filter[category_id]","in":"query","required":false,"description":"filter by category","schema":{"type":"integer"}},{"name":"filter[location_id]","in":"query","required":false,"description":"filter by location (via providers)","schema":{"type":"integer"}},{"name":"filter[can_combine]","in":"query","required":false,"description":"filter services that can be combined (1 or 0)","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[mark_combine]","in":"query","required":false,"description":"mark services that can be combined (1 or 0)","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[type]","in":"query","required":false,"description":"filter by type: enum['service','class'] - ordinary services only or classes only (Classes plugin). All by default","schema":{"type":"string","enum":["service","class"],"description":"filter by type: service\/class - ordinary services only or classes only (Classes plugin). All by default"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/services\/item\/id\/{id}":{"get":{"tags":["service"],"summary":"Get service details","description":"Returns details <a href=\"#model-PublicServiceEntity\">(PublicServiceEntity)<\/a> of a specific service by ID.<br>Throws NotFound if service is not visible or doesn't exist.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicServiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_services_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : service ID","schema":{"type":"string"}}]}},"\/public\/categories":{"get":{"tags":["service"],"summary":"Get service categories list","description":"Returns list <a href=\"#model-PublicListCategoryEntity\">(PublicListCategoryEntity)<\/a> of visible service categories.<br>Categories are ordered by their position in the system.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicListCategoryEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_categories","parameters":[{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/categories\/item\/id\/{id}":{"get":{"tags":["service"],"summary":"Get category details","description":"Returns details <a href=\"#model-CategoryEntity\">(CategoryEntity)<\/a> of a specific service category by ID.<br>Throws NotFound if category doesn't exist.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CategoryEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_categories_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : category ID","schema":{"type":"string"}}]}},"\/public\/providers":{"get":{"tags":["provider"],"summary":"Get providers list","description":"Returns a paginated list <a href=\"#model-PublicListProviderEntity\">PublicListProviderEntity<\/a> of visible service providers. Can be filtered by name,<br>service ID, location ID, and type.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicListProviderEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_providers","parameters":[{"name":"filter[search]","in":"query","required":false,"description":"search in name and description","schema":{"type":"string"}},{"name":"filter[service_id]","in":"query","required":false,"description":"filter by service","schema":{"type":"integer"}},{"name":"filter[location_id]","in":"query","required":false,"description":"filter by location","schema":{"type":"integer"}},{"name":"filter[type]","in":"query","required":false,"description":"filter by type: enum['service'] - exclude class providers (Classes plugin). All by default","schema":{"type":"string","enum":["service"],"description":"filter by type: service - exclude class providers (Classes plugin). All by default"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/providers\/any-unit":{"get":{"tags":["provider"],"summary":"Get any-unit provider data","description":"Returns information <a href=\"#model-AnyUnitDataEntity\">AnyUnitDataEntity<\/a> about the special \"Any Provider\" option,<br>which allows booking without selecting a specific provider.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AnyUnitDataEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_providers_any_unit"}},"\/public\/providers\/item\/id\/{id}":{"get":{"tags":["provider"],"summary":"Get provider details","description":"Returns details <a href=\"#model-ProviderEntity\">ProviderEntity<\/a> of a specific service provider by ID.<br>Throws NotFound if provider doesn't exist or is not visible.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProviderEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_providers_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : provider ID","schema":{"type":"string"}}]}},"\/public\/locations":{"get":{"tags":["provider"],"summary":"Get provider locations list","description":"Returns list <a href=\"#model-PublicListLocationEntity\">(PublicListLocationEntity)<\/a> of visible locations. This endpoint requires<br>the locations feature to be enabled.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicListLocationEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_locations","parameters":[{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/locations\/item\/id\/{id}":{"get":{"tags":["provider"],"summary":"Get location details","description":"Returns details <a href=\"#model-LocationEntity\">(LocationEntity)<\/a> of a specific location by ID.<br>Throws NotFound if location doesn't exist or is not visible.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/LocationEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_locations_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : location ID","schema":{"type":"string"}}]}},"\/public\/additional-fields":{"get":{"tags":["intake_forms"],"summary":"Get additional fields list","description":"Returns intake form fields <a href=\"#model-PublicListAdditionalFieldEntity\">(PublicListAdditionalFieldEntity)<\/a> used for customizing service intakes.<br>You can filter results by passing service_id filter parameter.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicListAdditionalFieldEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_additional_fields","parameters":[{"name":"filter[service_id][]","in":"query","required":false,"description":"Filter by service IDs","schema":{"type":"array","items":{"type":"integer"}}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/payment-methods":{"get":{"tags":["payments"],"summary":"Get client saved payment methods list","description":"Returns a list <a href=\"#model-PaymentMethodEntity\">(PaymentMethodEntity)<\/a> of payment methods saved by the currently logged-in client.<br>These are stored payment methods that can be reused for future payments.<br>The list is empty when the company has not enabled saved payment methods - check<br><b>allow_rebilling_payments<\/b> in \/public\/config before offering them to the client.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/PaymentMethodEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: When the token does not identify a logged-in client","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_payment_methods"}},"\/public\/payment-methods\/item\/id\/{id}":{"delete":{"tags":["payments"],"summary":"Delete client saved payment method","description":"Disables one of the currently logged-in client's saved payment methods so it can no longer<br>be used for future payments. A client can only remove their own payment methods.\n\n**Return Description:** empty response","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: When the token does not identify a logged-in client","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_payment_methods_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : payment method id","schema":{"type":"string"}}]}},"\/public\/payment-processor":{"get":{"tags":["payments"],"summary":"Get available payment processors list","description":"Returns a list <a href=\"#model-PaymentSystemEntity\">(PaymentSystemEntity)<\/a> of payment systems available for use in the client portal.<br>These are the payment options clients can use to pay for bookings or invoices.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/PaymentSystemEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_payment_processor"}},"\/public\/payment-processor\/pay":{"get":{"tags":["payments"],"summary":"Process payment for an invoice","description":"Initiates the payment process for a specified invoice using the selected payment system.<br>Returns payment processing information <a href=\"#model-PaymentProcessorResultEntity\">(PaymentProcessorResultEntity)<\/a> that can include a redirect URL,<br>inline content, or a template for the payment form.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PaymentProcessorResultEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: When the invoice requires a recurring payment method but the recurring flag is not set or Bad request: When recurring is requested but the selected payment system does not support recurring payments or Bad request: When store_payment_method is requested without a logged-in client or Bad request: When store_payment_method is requested but the selected payment system does not support storing a payment method or Bad request: When the invoice has expired and its content was released by the payment timeout","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_payment_processor_pay","parameters":[{"name":"invoice_id","in":"query","required":true,"description":"ID of the invoice to pay","schema":{"type":"integer"}},{"name":"system","in":"query","required":true,"description":"Payment system key (e.g., 'revolut', 'stripe')","schema":{"type":"string"}},{"name":"callback_url","in":"query","required":false,"description":"URL to redirect after payment completion. Ignored if not a well-formed absolute URL (falls back to the default return URL).","schema":{"type":"string"}},{"name":"recurring","in":"query","required":false,"description":"Whether this is a recurring payment (optional) (1 or 0). Required to be 1 when the invoice contains a recurring-only membership.","schema":{"type":"integer","enum":[0,1]}},{"name":"store_payment_method","in":"query","required":false,"description":"Save the payment method for reuse in future payments (1 or 0). Requires a logged-in client, the company setting <b>allow_rebilling_payments<\/b> (see \/public\/config), and a payment system whose PaymentSystemEntity (see GET \/public\/payment-processor) has <b>is_rebilling_supported<\/b> true.","schema":{"type":"integer","enum":[0,1]}}]}},"\/public\/invoice":{"get":{"tags":["payments"],"summary":"Get client invoices\/orders list","description":"Returns a paginated list <a href=\"#model-InvoiceEntity\">(InvoiceEntity)<\/a> of invoices for the currently logged-in client.<br>Includes both paid and unpaid invoices.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/InvoiceEntity"}},"metadata":{"$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_invoice","parameters":[{"name":"filter[search]","in":"query","required":false,"description":"search by invoice number or description","schema":{"type":"string"}},{"name":"filter[status]","in":"query","required":false,"description":"filter by status: enum['paid','unpaid','all','new','pending','cancelled','deleted','error']. By default returns all except 'new' and 'deleted'.","schema":{"type":"string","enum":["paid","unpaid","all","new","pending","cancelled","deleted","error"],"description":"filter by status: paid\/unpaid\/all\/new\/pending\/cancelled\/deleted\/error. By default returns all except 'new' and 'deleted'."}},{"name":"filter[recurring_profile_id]","in":"query","required":false,"description":"return only invoices belonging to the given recurring profile","schema":{"type":"integer"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]},"post":{"tags":["payments"],"summary":"Create invoice","description":"Creates a new empty invoice for the current client and returns PublicInvoiceResponseEntity.<br>When client_login is disabled, pass client data in the request body.<br>The response includes a token for the new\/existing client session.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicInvoiceResponseEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: When client_login is enabled and client is not logged in","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"client":{"description":"Client data (required when client_login is disabled): name, email, phone, address1, city, zip, country_id","type":"object"},"terms":{"description":"Accepted terms: cancellation_terms, promotion_letters, simplybook_terms, user_terms","type":"object"}}}}}}}},"\/public\/invoice\/item\/id\/{id}":{"get":{"tags":["payments"],"summary":"Get invoice\/order details","description":"Returns details <a href=\"#model-InvoiceEntity\">(InvoiceEntity)<\/a> of a specific invoice by ID.<br>Can include additional booking data by using the include parameter.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_invoice_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}},{"name":"include","in":"query","required":false,"description":"Optional comma-separated list of relations to include (e.g., \"lines.bookings.service,lines.bookings.provider,\"). List of available relations: lines.bookings.service, lines.bookings.provider, lines.bookings.location, lines.bookings.category","schema":{"type":"string"}}]}},"\/public\/invoice\/pay-deposit-amount\/id\/{id}":{"post":{"tags":["payments"],"summary":"Set invoice\/order to pay deposit amount only","description":"Updates the invoice to charge only the deposit amount and returns updated invoice <a href=\"#model-InvoiceEntity\">(InvoiceEntity)<\/a>.<br>only works for invoices with 'new' status.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_pay_deposit_amount_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}]}},"\/public\/invoice\/pay-full-amount\/id\/{id}":{"post":{"tags":["payments"],"summary":"Set invoice\/order to pay full amount","description":"Updates the invoice to charge the full amount and returns updated invoice <a href=\"#model-InvoiceEntity\">(InvoiceEntity)<\/a>.<br>only works for invoices with 'new' status.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_pay_full_amount_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}]}},"\/public\/invoice\/pay\/id\/{id}":{"get":{"tags":["payments"],"summary":"Pay invoice\/order with a payment processor","description":"Initiates payment for the invoice with the selected payment system, same as and backed by<br>the exact same implementation as GET \/public\/payment-processor\/pay - see that endpoint for<br>the full behaviour and error cases. Offered here too so that every way to settle an invoice<br>(a new payment method via this action, a saved one via \/public\/invoice\/rebill) lives under<br>the same \/public\/invoice\/ resource; both endpoints keep working and neither is deprecated.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PaymentProcessorResultEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: When the invoice requires a recurring payment method but the recurring flag is not set or Bad request: When recurring is requested but the selected payment system does not support recurring payments or Bad request: When store_payment_method is requested without a logged-in client or Bad request: When the invoice has expired and its content was released by the payment timeout","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_invoice_pay_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID (URL path parameter)","schema":{"type":"string"}},{"name":"system","in":"query","required":true,"description":"Payment system key (e.g., 'revolut', 'stripe')","schema":{"type":"string"}},{"name":"callback_url","in":"query","required":true,"description":"URL to redirect after payment completion","schema":{"type":"string"}},{"name":"recurring","in":"query","required":false,"description":"Whether this is a recurring payment (optional) (1 or 0). Required to be 1 when the invoice contains a recurring-only membership.","schema":{"type":"integer","enum":[0,1]}},{"name":"store_payment_method","in":"query","required":false,"description":"Save the payment method for reuse in future payments (1 or 0). Requires a logged-in client and the company setting <b>allow_rebilling_payments<\/b> (see \/public\/config); ignored by payment systems that can not store a payment method.","schema":{"type":"integer","enum":[0,1]}}]}},"\/public\/invoice\/rebill\/id\/{id}":{"put":{"tags":["payments"],"summary":"Pay invoice\/order with a saved payment method","description":"Charges one of the logged-in client's saved payment methods <a href=\"#model-see \/public\/payment-methods)<br>for this invoice, so the client does not have to enter their card details again.<br>Returns the invoice (InvoiceEntity\">(see \/public\/payment-methods)<br>for this invoice, so the client does not have to enter their card details again.<br>Returns the invoice (InvoiceEntity)<\/a> as it stands right after the attempt - it is only<br>marked as paid once the payment system confirms the charge asynchronously, so a 'pending'<br>status here does not mean the payment failed; poll the invoice afterwards rather than<br>treating anything short of 'paid' as an error.<br>Only works for invoices with 'new' or 'pending' status.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: When the invoice does not belong to the logged-in client","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: When no payment method is given or the invoice can not be paid any more","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found: When the payment method does not exist, is not active or does not support the requested payment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"put_public_invoice_rebill_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID (URL path parameter)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"payment_method_id":{"description":"Saved payment method id (request body)","type":"integer"},"recurring":{"description":"Start a recurring profile with this payment method (1 or 0)","type":"boolean"}}}}}}}},"\/public\/invoice\/promotion\/id\/{id}":{"post":{"tags":["payments"],"summary":"Apply promotion code to invoice","description":"Applies a promotion code and returns updated invoice <a href=\"#model-InvoiceEntity\">(InvoiceEntity)<\/a>.<br>only works for invoices with 'new' status.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_promotion_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"code":{"description":"Promotion code to apply","type":"string"}}}}}}}},"\/public\/invoice\/promotion\/id\/{id}\/instance-id\/{instance-id}":{"delete":{"tags":["payments"],"summary":"Remove promotion code from invoice","description":"Removes a previously applied promotion code and returns updated invoice <a href=\"#model-InvoiceEntity\">(InvoiceEntity)<\/a>.<br>only works for invoices with 'new' status.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_invoice_promotion_id_item_instance_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}},{"name":"instance-id","in":"path","required":true,"description":"Path parameter `instance-id` : Promotion instance ID to remove","schema":{"type":"string"}}]}},"\/public\/invoice\/tips\/id\/{id}":{"post":{"tags":["payments"],"summary":"Add tips to invoice\/order","description":"Adds tips and returns updated invoice <a href=\"#model-InvoiceEntity\">(InvoiceEntity)<\/a>.<br>only works for invoices with 'new' status or specific 'paid' invoices.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_tips_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"tips":{"description":"Percentage of tips to add (e.g., 10 for 10%)","type":"integer"},"tips_amount":{"description":"Fixed amount of tips to add (alternative to percentage)","type":"number"}}}}}}},"delete":{"tags":["payments"],"summary":"Remove tips from invoice\/order","description":"Removes tips and returns updated invoice <a href=\"#model-InvoiceEntity\">(InvoiceEntity)<\/a>.<br>only works for invoices with 'new' status or specific 'paid' invoices.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_invoice_tips_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}]}},"\/public\/invoice\/package\/id\/{id}":{"post":{"tags":["payments"],"summary":"Apply package to invoice\/order","description":"Applies a package instance to the invoice, potentially reducing the total amount.<br>only works for invoices with 'new' status.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_package_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"package_instance_id":{"description":"Package instance ID to apply","type":"integer"}}}}}}}},"\/public\/invoice\/package\/id\/{id}\/instance-id\/{instance-id}":{"delete":{"tags":["payments"],"summary":"Remove package from invoice\/order","description":"Removes a previously applied package instance from the invoice.<br>only works for invoices with 'new' status.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_invoice_package_id_item_instance_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}},{"name":"instance-id","in":"path","required":true,"description":"Path parameter `instance-id` : Package instance ID to remove","schema":{"type":"string"}}]}},"\/public\/invoice\/add-membership\/id\/{id}":{"post":{"tags":["payments"],"summary":"Add membership line to invoice","description":"Adds a membership purchase line to an existing invoice.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: When membership is invalid or start_date doesn't match its fixed start date","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_add_membership_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"membership_id":{"description":"Membership ID to add","type":"integer"},"start_date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"}}}}}}}},"\/public\/invoice\/add-promotion\/id\/{id}":{"post":{"tags":["payments"],"summary":"Add promotion line to invoice","description":"Adds a gift card or promotion purchase line to an existing invoice.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_add_promotion_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"promotion_id":{"description":"Promotion (gift card) ID to add","type":"integer"}}}}}}}},"\/public\/invoice\/add-package\/id\/{id}":{"post":{"tags":["payments"],"summary":"Add package line to invoice","description":"Adds a package purchase line to an existing invoice.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_add_package_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"package_id":{"description":"Package ID to add","type":"integer"},"start_date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"}}}}}}}},"\/public\/invoice\/add-product\/id\/{id}":{"post":{"tags":["payments"],"summary":"Add product line to invoice","description":"Adds a product purchase line to an existing invoice.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_add_product_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"product_id":{"description":"Product ID to add","type":"integer"},"qty":{"description":"Quantity","type":"integer"}}}}}}}},"\/public\/invoice\/modify-product\/id\/{id}":{"post":{"tags":["payments"],"summary":"Change product line quantity in invoice","description":"Updates the quantity of an existing product line in an invoice.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_invoice_modify_product_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"invoice_line_id":{"description":"Invoice line ID to modify","type":"integer"},"qty":{"description":"New quantity","type":"integer"}}}}}}}},"\/public\/invoice\/line\/id\/{id}":{"delete":{"tags":["payments"],"summary":"Delete invoice line","description":"Removes a specific line from an existing invoice.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_invoice_line_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Invoice ID","schema":{"type":"string"}},{"name":"invoice_line_id","in":"query","required":true,"description":"Invoice line ID to delete","schema":{"type":"integer"}}]}},"\/public\/invoice\/recurring-profiles":{"get":{"tags":["payments"],"summary":"Get list of recurring profiles","description":"Returns a paginated list <a href=\"#model-InvoiceRecurringProfileEntity\">(InvoiceRecurringProfileEntity)<\/a> of recurring payment profiles<br>for the currently logged-in client, newest first. Recurring profiles are created for<br>recurring memberships - membership_id is always present; pass include=membership to embed<br>the full MembershipEntity too.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/InvoiceRecurringProfileEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: When there is no logged-in client","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_invoice_recurring_profiles","parameters":[{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page, max 100 (default 10)","schema":{"type":"integer"}},{"name":"include","in":"query","required":false,"description":"comma-separated list of additional data to include (membership, membership.services, init_invoice, init_invoice.lines.bookings) - see \/public\/invoice\/recurring-profile\/id\/{id} for what membership and init_invoice show","schema":{"type":"string"}}]}},"\/public\/invoice\/recurring-profile\/id\/{id}":{"get":{"tags":["payments"],"summary":"Get recurring profile details","description":"Returns details of a recurring payment profile <a href=\"#model-InvoiceRecurringProfileEntity\">(InvoiceRecurringProfileEntity)<\/a><br>by ID for the currently logged-in client. Recurring profiles are created for recurring<br>memberships - membership_id is always present. Pass include=membership to embed the full<br>MembershipEntity (e.g. membership.services for its services), or include=init_invoice for<br>the whole purchase behind it instead (all lines, amounts, tax).\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceRecurringProfileEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_invoice_recurring_profile_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Recurring profile ID","schema":{"type":"string"}},{"name":"include","in":"query","required":false,"description":"comma-separated list of additional data to include (membership, membership.services, init_invoice, init_invoice.lines.bookings)","schema":{"type":"string"}}]},"delete":{"tags":["payments"],"summary":"Cancel recurring profile","description":"Cancels a recurring payment profile <a href=\"#model-e.g. a recurring membership subscription)<br>for the currently logged-in client and returns the updated<br>profile (InvoiceRecurringProfileEntity\">(e.g. a recurring membership subscription)<br>for the currently logged-in client and returns the updated<br>profile (InvoiceRecurringProfileEntity)<\/a>.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InvoiceRecurringProfileEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_public_invoice_recurring_profile_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Recurring profile ID","schema":{"type":"string"}}]}},"\/public\/packages":{"get":{"tags":["packages"],"summary":"Get packages list","description":"Returns list of available packages (Packages custom feature).<br>In GET parameters you can pass filter with following parameters:<br><b>service_id<\/b> - filter by service\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/PackageEntity"}},"metadata":{"$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_packages","parameters":[{"name":"filter","in":"query","required":true,"description":"filter object","schema":{"type":"object"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/packages\/instances":{"get":{"tags":["packages"],"summary":"Get client package instances","description":"Returns a list <a href=\"#model-PublicListPackageInstanceEntity\">(PublicListPackageInstanceEntity)<\/a> of package instances that belong to the current client,<br>including future-dated ones (date-expired instances are excluded, see the can_be_used flag).<br>Can be filtered by invoice_id to show only packages suitable for a specific invoice.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PublicListPackageInstanceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_packages_instances","parameters":[{"name":"invoice_id","in":"query","required":false,"description":"Filter packages applicable for a specific invoice","schema":{"type":"integer"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/memberships":{"get":{"tags":["memberships"],"summary":"Get memberships list","description":"Returns a paginated list of available memberships (Memberships custom feature).<br>Pass include=services to include associated services in the response.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/MembershipEntity"}},"metadata":{"$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_memberships","parameters":[{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/memberships\/purchased":{"get":{"tags":["memberships"],"summary":"Get client purchased memberships","description":"Returns a list of active membership instances purchased by the current client.<br>Pass filter[active_only]=1 to return only active (non-expired) instances.<br>Pass include=membership.services to include full membership and service data.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/ClientMembershipPaymentEntity"}},"metadata":{"$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_memberships_purchased","parameters":[{"name":"filter[active_only]","in":"query","required":false,"description":"Pass 1 to return only active memberships","schema":{"type":"integer"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/promotions":{"get":{"tags":["promotions"],"summary":"Get promotions list","description":"Returns a list of available promotions (gift cards and promo codes).\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/PromotionEntity"}},"metadata":{"$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_promotions","parameters":[{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/promotions\/purchased":{"get":{"tags":["promotions"],"summary":"Get client purchased promotions","description":"Returns a list of promotion instances (gift cards) purchased by the current client.<br>Pass include=print_link to include printable gift card links.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/PromotionInstanceEntity"}},"metadata":{"$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_promotions_purchased","parameters":[{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/products":{"get":{"tags":["products"],"summary":"Get products list","description":"Returns a paginated list of products (Products custom feature).<br>Can be filtered by type, service, or category.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/ProductEntity"}},"metadata":{"$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_products","parameters":[{"name":"filter[type]","in":"query","required":false,"description":"Product type: product or attribute","schema":{"type":"string"}},{"name":"filter[service_id]","in":"query","required":false,"description":"Filter by service ID","schema":{"type":"integer"}},{"name":"filter[category_id]","in":"query","required":false,"description":"Filter by product category ID","schema":{"type":"integer"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/products\/item\/id\/{id}":{"get":{"tags":["products"],"summary":"Get product item","description":"Returns a single product by ID.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProductEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found When product is not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_products_item_id_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Product ID","schema":{"type":"string"}}]}},"\/public\/products\/categories":{"get":{"tags":["products"],"summary":"Get product categories","description":"Returns a list of product categories available in the company.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"type":"integer"},"description":"Response data"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_products_categories"}},"\/public\/products\/service":{"get":{"tags":["products"],"summary":"Get products for service","description":"Returns a list of products and their available quantities for a specific service.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/ProductEntity"}},"metadata":{"$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_products_service","parameters":[{"name":"filter[service_id]","in":"query","required":false,"description":"Service ID to filter products by","schema":{"type":"integer"}},{"name":"filter[type]","in":"query","required":false,"description":"Product type: product or attribute","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"page number, starting from 1 (default 1)","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page (max 100, bigger values are reduced to 100)","schema":{"type":"integer"}}]}},"\/public\/products\/order":{"post":{"tags":["products"],"summary":"Create product order","description":"Creates an order for one or more products and returns a ProductInvoiceEntity.<br>When client_login is disabled, pass client data in the request body.<br>The response includes a token for the new\/existing client session.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProductInvoiceEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: When client_login is enabled and client is not logged in","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_public_products_order","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"items":{"description":"Array of objects with product_id and qty fields","type":"array","items":{"type":"integer"}},"client":{"description":"Client data (required when client_login is disabled): name, email, phone, address1, city, zip, country_id","type":"object"},"terms":{"description":"Accepted terms: cancellation_terms, promotion_letters, simplybook_terms, user_terms","type":"object"}}}}}}}},"\/public\/gdpr\/code":{"get":{"tags":["gdpr"],"summary":"Generate GDPR access code","description":"Generates and sends a verification code to access GDPR data.<br>Without parameters, generates a code for the logged-in client.<br>With email parameter, generates a code for the specified email address.<br>The code is sent via email or SMS and is required to access GDPR data.\n\n**Return Description:** Success status","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: When required parameters are missing","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_gdpr_code","parameters":[{"name":"email","in":"query","required":false,"description":"Client email to receive the verification code","schema":{"type":"string"}},{"name":"phone","in":"query","required":false,"description":"Client phone to receive the verification code via SMS","schema":{"type":"string"}}]}},"\/public\/gdpr\/info":{"get":{"tags":["gdpr"],"summary":"Get GDPR client data","description":"Returns all personal data <a href=\"#model-GdprClientDataEntity\">(GdprClientDataEntity)<\/a> stored for a client in accordance with GDPR requirements.<br>Requires a verification code that was previously generated and sent to the client.<br>For logged-in clients, only the code is required. For non-logged-in clients,<br>both the code and email\/phone are required.\n\n**Return Description:** Structured entity containing all client personal data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GdprClientDataEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request: When required parameters are missing","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: When the code is invalid or doesn't match the email\/phone","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_public_gdpr_info","parameters":[{"name":"code","in":"query","required":true,"description":"Verification code received via email or SMS","schema":{"type":"string"}},{"name":"email","in":"query","required":false,"description":"Client email (required for non-logged-in clients)","schema":{"type":"string"}},{"name":"phone","in":"query","required":false,"description":"Client phone (alternative to email for non-logged-in clients)","schema":{"type":"string"}}]}}},"components":{"schemas":{"PublicBookingBuildEntity":{"type":"object","description":"Entity that contains information to make booking from public side","properties":{"terms":{"description":"Terms accepted by client","$ref":"#\/components\/schemas\/Booking_TermsEntity"},"sheduler_channel":{"description":"Booking channel id (4 = google maps)","type":"integer"},"captcha_token":{"description":"Captcha token from widget (Anti Fraud plugin)","type":"string"},"invoice_id":{"description":"Invoice id to add booking to (optional)","type":"integer"},"id":{"description":"Booking id to edit","type":"integer"},"count":{"description":"Group booking count. You can use either count or recurringSettings","type":"integer"},"recurring_settings":{"description":"Recurring settings. You can use either count or recurringSettings","$ref":"#\/components\/schemas\/Booking_RecurringSettingsEntity"},"additional_fields":{"description":"Array of additional fields values. <a href=\"#model-Booking_AdditionalFieldValueEntity\">Booking_AdditionalFieldValueEntity<\/a>[]","type":"array","items":{"$ref":"#\/components\/schemas\/Booking_AdditionalFieldValueEntity"}},"products":{"description":"Array of products (addons). <a href=\"#model-ProductQtyEntity\">ProductQtyEntity<\/a>[]","type":"array","items":{"$ref":"#\/components\/schemas\/ProductQtyEntity"}},"client_membership_id":{"description":"Client membership instance id.","type":"integer"},"client":{"description":"Client data","$ref":"#\/components\/schemas\/ClientEntity"},"batch_id":{"description":"Multiple\/group booking batch","type":"integer"},"is_confirmed":{"description":"Booking is confirmed","type":"boolean"},"client_time_offset":{"description":"Client time offset in minutes (difference between client and company time), stored on booking","type":"integer"},"client_timezone":{"description":"Client timezone stored on booking (when client timezone was set on booking, see POST \/public\/clients\/timezone)","type":"string"},"client_start_datetime":{"description":"Booking start datetime in client timezone (when client timezone is stored on booking)","type":"string"},"client_end_datetime":{"description":"Booking end datetime in client timezone (when client timezone is stored on booking)","type":"string"},"start_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"record_date":{"description":"Booking creation date and time in company time zone (YYYY-MM-DD HH:MM:SS), the same time zone as start_datetime","type":"string"},"location_id":{"description":"Location id","type":"integer"},"category_id":{"description":"Category id","type":"integer"},"service_id":{"description":"Service id","type":"integer"},"provider_id":{"description":"Provider id","type":"integer"},"client_id":{"description":"Client id","type":"integer"},"duration":{"description":"Duration in minutes","type":"integer"},"service":{"description":"Service","$ref":"#\/components\/schemas\/ServiceEntity"},"provider":{"description":"Provider","$ref":"#\/components\/schemas\/ProviderEntity"},"location":{"description":"Location","$ref":"#\/components\/schemas\/LocationEntity"},"category":{"description":"Category","$ref":"#\/components\/schemas\/CategoryEntity"},"is_sequential":{"description":"Whether this booking belongs to a sequential (consecutive-services) batch","type":"boolean"}}},"CountryPhoneZoneEntity":{"type":"object","description":"Entity that contains country phone zone information","properties":{"name":{"description":"Phone zone name","type":"string"},"code":{"description":"Phone zone code","type":"string"},"country":{"description":"Associated country","type":"string"}}},"PublicListWaitingListEntity":{"type":"object","description":"Entity that contains waiting list entries with metadata","properties":{"data":{"description":"Waiting list entries","type":"array","items":{"$ref":"#\/components\/schemas\/PublicWaitingListEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}},"Client_FieldDetailsEntity":{"type":"object","description":"Client field details info","properties":{"id":{"description":"Field id. Always a string: built-in fields use their names (e.g. \"name\", \"email\", \"phone\"),<br>custom client fields use their numeric id as a string","type":"string"},"title":{"description":"Field title","type":"string"},"default_value":{"description":"Default field value","oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"values":{"description":"Array of available values for select field","type":"array","items":{"$ref":"#\/components\/schemas\/Client_FieldSelectOptionEntity"}},"value":{"description":"Field value","oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"is_visible":{"description":"Field is visible on public site","type":"boolean"},"is_optional":{"description":"Field is optional","type":"boolean"},"is_built_in":{"description":"Field is built-in","type":"boolean"},"type":{"description":"Field type","type":"string"}}},"Client_FieldSelectOptionEntity":{"type":"object","description":"Option data for select client field","properties":{"value":{"description":"Option value","type":"string"},"is_default":{"description":"Is default value","type":"boolean"},"position":{"description":"Position","type":"integer"}}},"Client_FieldValueEntity":{"type":"object","description":"Client field value object","properties":{"id":{"description":"Field id","type":"string"},"field":{"description":"Field object. Read only (you do not need to pass it on save)","$ref":"#\/components\/schemas\/Client_FieldDetailsEntity"},"value":{"description":"Field value","oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]}}},"Client_DetailsEntity":{"type":"object","description":"Client data each field value is in separate [[Client_FieldValueEntity]] object.","properties":{"id":{"description":"Id of client","type":"integer"},"fields":{"description":"Array of fields with values","type":"array","items":{"$ref":"#\/components\/schemas\/Client_FieldValueEntity"}}}},"PublicListBookingInfoEntity":{"type":"object","description":"Entity that contains booking info list with metadata","properties":{"data":{"description":"Bookings data","type":"array","items":{"$ref":"#\/components\/schemas\/BookingInfoEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}},"PaymentSystemEntity":{"type":"object","description":"Entity that contains payment system information.","properties":{"name":{"description":"Payment system name","type":"string"},"is_active":{"description":"Is payment system active","type":"boolean"},"is_recurring_supported":{"description":"Is recurring payments supported","type":"boolean"},"is_rebilling_supported":{"description":"Is rebilling payments supported","type":"boolean"},"is_refund_supported":{"description":"Is refund payments supported","type":"boolean"}}},"PublicPasswordEntity":{"type":"object","description":"Entity that contains client information (for public API)","properties":{"id":{"description":"Client id. Auto-generated value.","type":"integer"},"email":{"description":"Client email","type":"string"}}},"PublicWaitingListEntity":{"type":"object","description":"Entity that contains a single waiting list entry of the client.\nA waiting list entry reserves a whole day rather than a time slot - the client is notified\nas soon as any slot for the requested service, provider and bookings count frees up on that day.","properties":{"id":{"description":"Waiting list entry id. Auto-generated value.","type":"integer"},"code":{"description":"Waiting list entry code, e.g. \"wl-15\". Auto-generated value.","type":"string"},"date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"count":{"description":"Number of bookings the client is waiting for.","type":"integer"},"status":{"description":"Entry status: waiting\/booked\/cancelled.\n\"booked\" means the client has booked on that date and the entry is not needed any more,\n\"cancelled\" means the entry was cancelled by the client or expired unfulfilled.","type":"string","enum":["waiting","booked","cancelled"]},"is_cancellable":{"description":"Whether the client can still cancel this entry.","type":"boolean"},"is_available":{"description":"Whether the requested date currently has free slots, so the client can book right away.<br>Only calculated when \"availability\" is requested in the include parameter, null otherwise.","type":"boolean","nullable":true},"sheduler_id":{"description":"Id of the booking that closed this entry, null unless status is \"booked\".","type":"integer","nullable":true},"service_id":{"description":"Service id","type":"integer"},"provider_id":{"description":"Provider id","type":"integer"},"location_id":{"description":"Location id","type":"integer","nullable":true},"category_id":{"description":"Category id","type":"integer","nullable":true},"client_id":{"description":"Client id","type":"integer"},"record_date":{"description":"Date the entry was created","type":"string"},"service":{"description":"Service","$ref":"#\/components\/schemas\/ServiceEntity"},"provider":{"description":"Provider","$ref":"#\/components\/schemas\/ProviderEntity"},"location":{"description":"Location","$ref":"#\/components\/schemas\/LocationEntity"},"category":{"description":"Category","$ref":"#\/components\/schemas\/CategoryEntity"},"token":{"description":"Token the client can use for subsequent requests, so a guest client isn't limited to the<br>single \"hash\" query param. Only set right after join() when the client_login plugin is off.","type":"string","nullable":true}}},"PaymentMethodEntity":{"type":"object","description":"This entity contains information about payment method","properties":{"name":{"description":"Payment method display name, as reported by the payment system.<br>Not always a card mask - Stripe returns something like \"4***4242\", PayPal the payer<br>email and Adyen an internal reference, so show it as-is rather than parsing it","type":"string"},"is_active":{"description":"Is the payment system behind this payment method currently active.<br>An inactive payment method can not be used to pay","type":"boolean"},"is_recurring_supported":{"description":"Is recurring payments supported","type":"boolean"},"is_rebilling_supported":{"description":"Is rebilling payments supported","type":"boolean"},"is_refund_supported":{"description":"Is refund payments supported","type":"boolean"},"payment_system":{"description":"Payment system name","type":"string"}}},"InvoiceEntity":{"type":"object","description":"Entity that contains invoice information","properties":{"id":{"description":"Invoice id. Auto-generated value.","type":"integer"},"number":{"description":"Invoice number. Auto-generated value.","type":"string"},"datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"due_datetime":{"description":"Invoice due date. By default current datetime + payment timeout","type":"string"},"payment_datetime":{"description":"Payment payment date","type":"string","nullable":true},"refund_datetime":{"description":"Refund payment date","type":"string","nullable":true},"amount":{"description":"Invoice amount. Readonly","type":"number","format":"float"},"recurring_amount":{"description":"Invoice recurring amount. Readonly","type":"number","format":"float"},"deposit":{"description":"Invoice deposit. Readonly","type":"number","format":"float"},"rest_amount":{"description":"Invoice rest amount. Readonly","type":"number","format":"float"},"taxes":{"description":"Array of invoice taxes","type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_TaxEntity"}},"discount":{"description":"Invoice discount amount. Readonly","type":"number","format":"float"},"currency":{"description":"Invoice currency code. ISO 4217","type":"string"},"client_id":{"description":"Client id","type":"integer"},"description":{"description":"Invoice description","type":"string"},"payment_received":{"description":"Payment was received by company","type":"boolean"},"payment_processor":{"description":"Payment processor key","type":"string"},"lines":{"description":"Array of lines. The line can be one of the following types:<br><a href=\"#model-Invoice_BookingLineEntity\">Invoice_BookingLineEntity<\/a>, <a href=\"#model-Invoice_ProductLineEntity\">Invoice_ProductLineEntity<\/a>, <a href=\"#model-Invoice_MembershipLineEntity\">Invoice_MembershipLineEntity<\/a>, <a href=\"#model-Invoice_PackageLineEntity\">Invoice_PackageLineEntity<\/a>, <a href=\"#model-Invoice_PromotionLineEntity\">Invoice_PromotionLineEntity<\/a>, <a href=\"#model-Invoice_DepositLineEntity\">Invoice_DepositLineEntity<\/a>","oneOf":[{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_BookingLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_ProductLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_MembershipLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_PackageLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_PromotionLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_DepositLineEntity"}}]},"promotion_instances":{"description":"Array of <a href=\"#model-PromotionInstanceEntity\">PromotionInstanceEntity<\/a>. Promotion instances used in invoice","type":"array","items":{"$ref":"#\/components\/schemas\/PromotionInstanceEntity"}},"package_instances":{"description":"Array of <a href=\"#model-PackageInstanceEntity\">PackageInstanceEntity<\/a>. Package instances used in invoice","type":"array","items":{"$ref":"#\/components\/schemas\/PackageInstanceEntity"}},"status":{"description":"Current invoice status","type":"string"},"can_be_paid":{"description":"True when this invoice can still be paid: status is one of new\/pending\/cancelled\/error<br>AND the payment timeout job has not reclaimed it yet. A 'cancelled'\/'error' invoice can<br>be released by that job while keeping its original status, so status alone is not<br>enough to tell - this mirrors the booking page's canPay check (CY1SDEV1-4130) so API<br>consumers (e.g. the booking widget) don't need to reimplement that rule. Only set on<br>GET \/public\/invoice\/item\/id\/{id}, not on list results.","type":"boolean"},"support_recurring_payment":{"description":"True in case this invoice can be paid with recurring payment method","type":"boolean"},"require_recurring_payment":{"description":"True in case this invoice can be paid only with recurring payment method","type":"boolean"},"recurring_profile_id":{"description":"Recurring profile id, linked to this invoice","type":"integer"}}},"PublicCompanyInfoEntity":{"type":"object","description":"Public company information with privacy filters applied.\nAddress fields are omitted when skip_address is set; email is omitted when hide_email is configured.","properties":{"login":{"description":"Company login","type":"string"},"name":{"description":"Company name","type":"string"},"description":{"description":"Company description","type":"string"},"timezone":{"description":"Company time zone","type":"string"},"address1":{"description":"Company address 1","type":"string","nullable":true},"address2":{"description":"Company address 2","type":"string","nullable":true},"phone":{"description":"Phone number","type":"string","nullable":true},"email":{"description":"Email","type":"string","nullable":true},"city":{"description":"Company city","type":"string","nullable":true},"zip":{"description":"Company zip code","type":"string","nullable":true},"country_id":{"description":"Company country id","type":"string","nullable":true},"public_url":{"description":"Public company url","type":"string"}}},"SimplybookRefreshTokenEntity":{"type":"object","description":"Entity that contains refresh token information","properties":{"refresh_token":{"description":"Refresh token","type":"string"}}},"MembershipEntity":{"type":"object","description":"Entity that contains membership information","properties":{"id":{"description":"Membership id. Auto-generated value.","type":"integer"},"name":{"description":"Membership name","type":"string"},"description":{"description":"Membership description","type":"string"},"file_id":{"description":"Image file id","type":"integer"},"picture_preview":{"description":"Path to preview picture","type":"string"},"picture_large":{"description":"Path to large picture","type":"string"},"first_price":{"description":"Price that client will pay when he first time buys membership","type":"number","format":"float"},"recurring_price":{"description":"Price that client will pay when he buy membership not first time","type":"number","format":"float"},"currency":{"description":"Membership price currency","type":"string"},"is_recurring":{"description":"Is membership supporting recurring payment","type":"boolean"},"is_recurring_only":{"description":"Membership requires recurring payment","type":"boolean"},"tax_id":{"description":"Tax id","type":"integer"},"tax":{"description":"Tax information","$ref":"#\/components\/schemas\/TaxEntity"},"duration":{"description":"Membership duration","type":"integer"},"duration_type":{"description":"Membership duration type","type":"string"},"limit":{"description":"How many booking in this membership (0 - unlimited)","type":"integer"},"simultaneous_limit":{"description":"Maximum number of active future bookings per client","type":"integer"},"is_unlimited":{"description":"Has unlimited bookings","type":"boolean"},"is_active":{"description":"Is membership active","type":"boolean"},"is_visible":{"description":"Is membership visible on public site","type":"boolean"}}},"ServiceEntity":{"type":"object","description":"Entity that contains service information","properties":{"id":{"description":"Service id. Auto-generated value.","type":"integer"},"name":{"description":"Service name","type":"string"},"description":{"description":"service description","type":"string"},"price":{"description":"Service price","type":"number","format":"float"},"currency":{"description":"Service price currency","type":"string"},"deposit_price":{"description":"Deposit price","type":"number","format":"float"},"tax_id":{"description":"Tax id","type":"integer"},"tax":{"description":"Tax information","$ref":"#\/components\/schemas\/TaxEntity"},"duration":{"description":"Duration in minutes","type":"integer"},"buffer_time_after":{"description":"Buffer time after in minutes","type":"integer"},"recurring_settings":{"description":"Service recurring settings (in case it is recurring service)","$ref":"#\/components\/schemas\/Booking_RecurringSettingsEntity","nullable":true},"memberships":{"description":"Array of ids of memberships where this service presents.","type":"array","items":{"type":"integer"}},"providers":{"description":"Array of ids of providers where this service connected.","type":"array","items":{"type":"integer"}},"picture":{"description":"Picture file name","type":"string"},"picture_preview":{"description":"Path to preview picture","type":"string"},"is_active":{"description":"If service is active","type":"boolean"},"is_visible":{"description":"If service is visible on public side","type":"boolean"},"limit_booking":{"description":"Limit bookings value.<br>Will be null in case \"Limit bookings\" is turned off.<br>Will take common value from config in case this value is empty or 0 for event.","type":"integer"},"min_group_booking":{"description":"Min group booking value.<br>Will be null in case \"Group booking\" is turned off.","type":"integer"}}},"PublicListCategoryEntity":{"type":"object","description":"Entity that contains category information with metadata","properties":{"data":{"description":"Categories data","type":"array","items":{"$ref":"#\/components\/schemas\/CategoryEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}},"PublicServiceEntity":{"type":"object","description":"Entity that contains service information","properties":{"is_class":{"description":"True if service is a class (Classes plugin). Class has its own provider, so provider selection can be skipped","type":"boolean"},"id":{"description":"Service id. Auto-generated value.","type":"integer"},"name":{"description":"Service name","type":"string"},"description":{"description":"service description","type":"string"},"price":{"description":"Service price","type":"number","format":"float"},"currency":{"description":"Service price currency","type":"string"},"deposit_price":{"description":"Deposit price","type":"number","format":"float"},"tax_id":{"description":"Tax id","type":"integer"},"tax":{"description":"Tax information","$ref":"#\/components\/schemas\/TaxEntity"},"duration":{"description":"Duration in minutes","type":"integer"},"buffer_time_after":{"description":"Buffer time after in minutes","type":"integer"},"recurring_settings":{"description":"Service recurring settings (in case it is recurring service)","$ref":"#\/components\/schemas\/Booking_RecurringSettingsEntity","nullable":true},"memberships":{"description":"Array of ids of memberships where this service presents.","type":"array","items":{"type":"integer"}},"providers":{"description":"Array of ids of providers where this service connected.","type":"array","items":{"type":"integer"}},"picture":{"description":"Picture file name","type":"string"},"picture_preview":{"description":"Path to preview picture","type":"string"},"is_active":{"description":"If service is active","type":"boolean"},"is_visible":{"description":"If service is visible on public side","type":"boolean"},"limit_booking":{"description":"Limit bookings value.<br>Will be null in case \"Limit bookings\" is turned off.<br>Will take common value from config in case this value is empty or 0 for event.","type":"integer"},"min_group_booking":{"description":"Min group booking value.<br>Will be null in case \"Group booking\" is turned off.","type":"integer"}}},"ClientOutstandingBalanceEntity":{"type":"object","description":"Entity that contains oustanding client balance","properties":{"id":{"description":"Invoice id. Auto-generated value.","type":"integer"},"amount":{"description":"Invoice amount. Readonly","type":"number","format":"float"},"currency":{"description":"Invoice currency code. ISO 4217","type":"string"},"client":{"description":"Client","$ref":"#\/components\/schemas\/ClientEntity"}}},"PublicPasswordClientEntity":{"type":"object","description":"Entity that contains client information (for public API)","properties":{"id":{"description":"Client id. Auto-generated value.","type":"integer"},"name":{"description":"Client name","type":"string"},"email":{"description":"Client email","type":"string"},"phone":{"description":"Client phone","type":"string"},"address1":{"description":"Client address fields<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"address2":{"description":"Client address fields<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"city":{"description":"Client city<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"zip":{"description":"Client zip code<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"country_id":{"description":"Client country id<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"state_id":{"description":"Client state id<br>These fields related to Client login custom feature and can be null.","type":"integer","nullable":true}}},"DetailedBookingEntity":{"type":"object","description":"Entity that contains detailed booking information","properties":{"id":{"description":"Booking id. Auto-generated value.","type":"integer"},"code":{"description":"Booking code. Auto-generated value.","type":"string"},"is_confirmed":{"description":"Booking is confirmed","type":"boolean"},"client_time_offset":{"description":"Client time offset in minutes (difference between client and company time), stored on booking","type":"integer"},"client_timezone":{"description":"Client timezone stored on booking (when client timezone was set on booking, see POST \/public\/clients\/timezone)","type":"string"},"client_start_datetime":{"description":"Booking start datetime in client timezone (when client timezone is stored on booking)","type":"string"},"client_end_datetime":{"description":"Booking end datetime in client timezone (when client timezone is stored on booking)","type":"string"},"start_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"record_date":{"description":"Booking creation date and time in company time zone (YYYY-MM-DD HH:MM:SS), the same time zone as start_datetime","type":"string"},"location_id":{"description":"Location id","type":"integer"},"category_id":{"description":"Category id","type":"integer"},"service_id":{"description":"Service id","type":"integer"},"provider_id":{"description":"Provider id","type":"integer"},"client_id":{"description":"Client id","type":"integer"},"duration":{"description":"Duration in minutes","type":"integer"},"service":{"description":"Service","$ref":"#\/components\/schemas\/ServiceEntity"},"provider":{"description":"Provider","$ref":"#\/components\/schemas\/ProviderEntity"},"location":{"description":"Location","$ref":"#\/components\/schemas\/LocationEntity"},"category":{"description":"Category","$ref":"#\/components\/schemas\/CategoryEntity"},"is_sequential":{"description":"Whether this booking belongs to a sequential (consecutive-services) batch","type":"boolean"}}},"StateEntity":{"type":"object","description":"Entity that represents a state or province in a country.\nThis entity contains information about a state or province,\nincluding its ID and name. It is primarily used for address forms\nand location-based filtering.","properties":{"id":{"description":"State\/province ID<br>A unique identifier for the state or province.","type":"string"},"name":{"description":"State\/province name<br>The display name of the state or province.","type":"string"}}},"PublicOnlineMeetingEntity":{"type":"object","description":"Online Meeting entity","properties":{"id":{"description":"id. Auto-generated value.","type":"integer"},"meeting_service_id":{"description":"Meeting Service Id","type":"integer"},"event_id":{"description":"Event id","type":"integer"},"unit_group_id":{"description":"Unit group id","type":"integer"},"date_start":{"description":"Start datetime","type":"string"},"options":{"description":"","type":"array","items":{"type":"integer"},"nullable":true}}},"AdditionalFieldEntity":{"type":"object","description":"Entity representing an additional field (custom intake form field) in the system.\nThese fields can be attached to services to collect additional information during booking.","properties":{"id":{"description":"Unique field identifier","type":"integer"},"name":{"description":"Unique field name used as key in the system<br>This is the machine-readable identifier for the field","type":"string"},"field_name":{"description":"Display label for the field<br>This is what clients will see on the booking form","type":"string"},"field_type":{"description":"Field type which determines the input method<br>Possible values: text, textarea, select, checkbox, date, etc.","type":"string"},"field_options":{"description":"Available options for select, checkbox, and radio field types<br>For other field types, this will be an empty array","type":"array","items":{"type":"string"}},"default_value":{"description":"Default value for the field<br>The type depends on the fieldType","oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"optional":{"description":"Whether the field is optional or required<br>True means the field is optional, false means it's required","type":"boolean"},"is_visible":{"description":"Whether the field is visible on the public booking form<br>Fields may be hidden but still used in the system","type":"boolean"},"show_for_all_services":{"description":"Whether this field appears for all services<br>If false, the field is only attached to specific services","type":"boolean"},"services":{"description":"Service IDs this field is assigned to","type":"array","items":{"type":"integer"}}}},"Package_PackageServiceEntity":{"type":"object","description":"Package service qty into","properties":{"id":{"description":"Package service entity id. Auto-generated value.","type":"integer"},"service_id":{"description":"Service id","type":"integer"},"qty":{"description":"Qty in package","type":"integer"},"name":{"description":"Service name","type":"string"},"is_visible":{"description":"Is visible","type":"boolean"},"service":{"description":"Full service info, populated when include=service is requested","$ref":"#\/components\/schemas\/ServiceEntity","nullable":true}}},"Package_PackageProductEntity":{"type":"object","description":"Package product qty into","properties":{"id":{"description":"Package service entity id. Auto-generated value.","type":"integer"},"product_id":{"description":"Product id","type":"integer"},"qty":{"description":"Qty in package","type":"integer"},"name":{"description":"Name of product","type":"string"},"is_visible":{"description":"Is visible","type":"boolean"},"product":{"description":"Full product info, populated when include=product is requested","$ref":"#\/components\/schemas\/ProductEntity","nullable":true}}},"ProductInvoiceEntity":{"type":"object","description":"Entity that contains invoice for product order","properties":{"token":{"description":"token","type":"string"},"id":{"description":"Invoice id. Auto-generated value.","type":"integer"},"number":{"description":"Invoice number. Auto-generated value.","type":"string"},"datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"due_datetime":{"description":"Invoice due date. By default current datetime + payment timeout","type":"string"},"payment_datetime":{"description":"Payment payment date","type":"string","nullable":true},"refund_datetime":{"description":"Refund payment date","type":"string","nullable":true},"amount":{"description":"Invoice amount. Readonly","type":"number","format":"float"},"recurring_amount":{"description":"Invoice recurring amount. Readonly","type":"number","format":"float"},"deposit":{"description":"Invoice deposit. Readonly","type":"number","format":"float"},"rest_amount":{"description":"Invoice rest amount. Readonly","type":"number","format":"float"},"taxes":{"description":"Array of invoice taxes","type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_TaxEntity"}},"discount":{"description":"Invoice discount amount. Readonly","type":"number","format":"float"},"currency":{"description":"Invoice currency code. ISO 4217","type":"string"},"client_id":{"description":"Client id","type":"integer"},"description":{"description":"Invoice description","type":"string"},"payment_received":{"description":"Payment was received by company","type":"boolean"},"payment_processor":{"description":"Payment processor key","type":"string"},"lines":{"description":"Array of lines. The line can be one of the following types:<br><a href=\"#model-Invoice_BookingLineEntity\">Invoice_BookingLineEntity<\/a>, <a href=\"#model-Invoice_ProductLineEntity\">Invoice_ProductLineEntity<\/a>, <a href=\"#model-Invoice_MembershipLineEntity\">Invoice_MembershipLineEntity<\/a>, <a href=\"#model-Invoice_PackageLineEntity\">Invoice_PackageLineEntity<\/a>, <a href=\"#model-Invoice_PromotionLineEntity\">Invoice_PromotionLineEntity<\/a>, <a href=\"#model-Invoice_DepositLineEntity\">Invoice_DepositLineEntity<\/a>","oneOf":[{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_BookingLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_ProductLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_MembershipLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_PackageLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_PromotionLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_DepositLineEntity"}}]},"promotion_instances":{"description":"Array of <a href=\"#model-PromotionInstanceEntity\">PromotionInstanceEntity<\/a>. Promotion instances used in invoice","type":"array","items":{"$ref":"#\/components\/schemas\/PromotionInstanceEntity"}},"package_instances":{"description":"Array of <a href=\"#model-PackageInstanceEntity\">PackageInstanceEntity<\/a>. Package instances used in invoice","type":"array","items":{"$ref":"#\/components\/schemas\/PackageInstanceEntity"}},"status":{"description":"Current invoice status","type":"string"},"can_be_paid":{"description":"True when this invoice can still be paid: status is one of new\/pending\/cancelled\/error<br>AND the payment timeout job has not reclaimed it yet. A 'cancelled'\/'error' invoice can<br>be released by that job while keeping its original status, so status alone is not<br>enough to tell - this mirrors the booking page's canPay check (CY1SDEV1-4130) so API<br>consumers (e.g. the booking widget) don't need to reimplement that rule. Only set on<br>GET \/public\/invoice\/item\/id\/{id}, not on list results.","type":"boolean"},"support_recurring_payment":{"description":"True in case this invoice can be paid with recurring payment method","type":"boolean"},"require_recurring_payment":{"description":"True in case this invoice can be paid only with recurring payment method","type":"boolean"},"recurring_profile_id":{"description":"Recurring profile id, linked to this invoice","type":"integer"}}},"ProductQtyEntity":{"type":"object","description":"Entity that contains product qty information","properties":{"product_id":{"description":"Product id","type":"integer"},"qty":{"description":"Product qty","type":"integer"}}},"Invoice_MembershipLineEntity":{"type":"object","description":"Entity that contains invoice line information with membership","properties":{"membership_id":{"description":"Membership entity object id","type":"integer"},"membership":{"description":"Membership data","$ref":"#\/components\/schemas\/MembershipEntity"},"period_start":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"membership_payment_id":{"description":"Membership payment id, that was initialized by client","type":"integer"},"id":{"description":"Invoice line id. Auto-generated value.","type":"integer"},"invoice_id":{"description":"Invoice id","type":"integer"},"name":{"description":"Invoice line name","type":"string"},"type":{"description":"Invoice line type. Can be booking, product, membership, custom","type":"string"},"discount_ratio":{"description":"Invoice line discount ratio","type":"number","format":"float"},"discount_amount":{"description":"Invoice line discount fixed amount","type":"number","format":"float"},"discount":{"description":"Invoice line discount","type":"number","format":"float"},"price":{"description":"Invoice line price","type":"number","format":"float"},"final_price":{"description":"Invoice line final price (including tax and discount)","type":"number","format":"float"},"qty":{"description":"Invoice line qty","type":"number","format":"float"},"package_qty":{"description":"Invoice line qty, that was purchased by using package","type":"number","format":"float"},"tax":{"description":"Tax entity related to this invoice line<br>Note: Use tax_rate in calculations as rate in this object can be different.","$ref":"#\/components\/schemas\/TaxEntity"},"tax_ratio":{"description":"Invoice line tax ratio","type":"number","format":"float"},"tax_amount":{"description":"Invoice line tax amount","type":"number","format":"float"},"amount":{"description":"Invoice line amount","type":"number","format":"float"},"deposit":{"description":"Invoice line deposit","type":"number","format":"float"},"rest_amount":{"description":"Invoice line rest amount","type":"number","format":"float"}}},"Invoice_PromotionLineEntity":{"type":"object","description":"Entity that contains invoice line information with gift card","properties":{"promotion_id":{"description":"Gift card id","type":"integer"},"promotion_instance_id":{"description":"Gift card instance id","type":"integer"},"promotion":{"description":"Gift card","$ref":"#\/components\/schemas\/PromotionEntity"},"id":{"description":"Invoice line id. Auto-generated value.","type":"integer"},"invoice_id":{"description":"Invoice id","type":"integer"},"name":{"description":"Invoice line name","type":"string"},"type":{"description":"Invoice line type. Can be booking, product, membership, custom","type":"string"},"discount_ratio":{"description":"Invoice line discount ratio","type":"number","format":"float"},"discount_amount":{"description":"Invoice line discount fixed amount","type":"number","format":"float"},"discount":{"description":"Invoice line discount","type":"number","format":"float"},"price":{"description":"Invoice line price","type":"number","format":"float"},"final_price":{"description":"Invoice line final price (including tax and discount)","type":"number","format":"float"},"qty":{"description":"Invoice line qty","type":"number","format":"float"},"package_qty":{"description":"Invoice line qty, that was purchased by using package","type":"number","format":"float"},"tax":{"description":"Tax entity related to this invoice line<br>Note: Use tax_rate in calculations as rate in this object can be different.","$ref":"#\/components\/schemas\/TaxEntity"},"tax_ratio":{"description":"Invoice line tax ratio","type":"number","format":"float"},"tax_amount":{"description":"Invoice line tax amount","type":"number","format":"float"},"amount":{"description":"Invoice line amount","type":"number","format":"float"},"deposit":{"description":"Invoice line deposit","type":"number","format":"float"},"rest_amount":{"description":"Invoice line rest amount","type":"number","format":"float"}}},"Invoice_BookingLineEntity":{"type":"object","description":"Entity that contains invoice line information with bookings","properties":{"booking_ids":{"description":"Booking ids, that were purchased. It can have multiple ids in case\nrecurring booking and group booking. In case recurring booking qty will be equal 1,\nbecause client pays for session.\nIn case group booking qty will be equal count of group booking.","type":"array","items":{"type":"integer"}},"bookings":{"description":"Bookings, that were purchased","type":"array","items":{"$ref":"#\/components\/schemas\/BookingEntity"}},"id":{"description":"Invoice line id. Auto-generated value.","type":"integer"},"invoice_id":{"description":"Invoice id","type":"integer"},"name":{"description":"Invoice line name","type":"string"},"type":{"description":"Invoice line type. Can be booking, product, membership, custom","type":"string"},"discount_ratio":{"description":"Invoice line discount ratio","type":"number","format":"float"},"discount_amount":{"description":"Invoice line discount fixed amount","type":"number","format":"float"},"discount":{"description":"Invoice line discount","type":"number","format":"float"},"price":{"description":"Invoice line price","type":"number","format":"float"},"final_price":{"description":"Invoice line final price (including tax and discount)","type":"number","format":"float"},"qty":{"description":"Invoice line qty","type":"number","format":"float"},"package_qty":{"description":"Invoice line qty, that was purchased by using package","type":"number","format":"float"},"tax":{"description":"Tax entity related to this invoice line<br>Note: Use tax_rate in calculations as rate in this object can be different.","$ref":"#\/components\/schemas\/TaxEntity"},"tax_ratio":{"description":"Invoice line tax ratio","type":"number","format":"float"},"tax_amount":{"description":"Invoice line tax amount","type":"number","format":"float"},"amount":{"description":"Invoice line amount","type":"number","format":"float"},"deposit":{"description":"Invoice line deposit","type":"number","format":"float"},"rest_amount":{"description":"Invoice line rest amount","type":"number","format":"float"}}},"Invoice_DepositLineEntity":{"type":"object","description":"Entity that contains invoice line information with bookings","properties":{"booking_ids":{"description":"Booking ids, that were purchased. It can have multiple ids in case\nrecurring booking and group booking. In case recurring booking qty will be equal 1,\nbecause client pays for session.\nIn case group booking qty will be equal count of group booking.","type":"array","items":{"type":"integer"}},"bookings":{"description":"Bookings, that were purchased","type":"array","items":{"$ref":"#\/components\/schemas\/BookingEntity"}},"id":{"description":"Invoice line id. Auto-generated value.","type":"integer"},"invoice_id":{"description":"Invoice id","type":"integer"},"name":{"description":"Invoice line name","type":"string"},"type":{"description":"Invoice line type. Can be booking, product, membership, custom","type":"string"},"discount_ratio":{"description":"Invoice line discount ratio","type":"number","format":"float"},"discount_amount":{"description":"Invoice line discount fixed amount","type":"number","format":"float"},"discount":{"description":"Invoice line discount","type":"number","format":"float"},"price":{"description":"Invoice line price","type":"number","format":"float"},"final_price":{"description":"Invoice line final price (including tax and discount)","type":"number","format":"float"},"qty":{"description":"Invoice line qty","type":"number","format":"float"},"package_qty":{"description":"Invoice line qty, that was purchased by using package","type":"number","format":"float"},"tax":{"description":"Tax entity related to this invoice line<br>Note: Use tax_rate in calculations as rate in this object can be different.","$ref":"#\/components\/schemas\/TaxEntity"},"tax_ratio":{"description":"Invoice line tax ratio","type":"number","format":"float"},"tax_amount":{"description":"Invoice line tax amount","type":"number","format":"float"},"amount":{"description":"Invoice line amount","type":"number","format":"float"},"deposit":{"description":"Invoice line deposit","type":"number","format":"float"},"rest_amount":{"description":"Invoice line rest amount","type":"number","format":"float"}}},"Invoice_ProductLineEntity":{"type":"object","description":"Entity that contains invoice line information with product","properties":{"product_id":{"description":"Product id, that was purchased","type":"integer"},"booking_id":{"description":"Related booking id","type":"integer"},"product":{"description":"Product, that was purchased","$ref":"#\/components\/schemas\/ProductEntity"},"id":{"description":"Invoice line id. Auto-generated value.","type":"integer"},"invoice_id":{"description":"Invoice id","type":"integer"},"name":{"description":"Invoice line name","type":"string"},"type":{"description":"Invoice line type. Can be booking, product, membership, custom","type":"string"},"discount_ratio":{"description":"Invoice line discount ratio","type":"number","format":"float"},"discount_amount":{"description":"Invoice line discount fixed amount","type":"number","format":"float"},"discount":{"description":"Invoice line discount","type":"number","format":"float"},"price":{"description":"Invoice line price","type":"number","format":"float"},"final_price":{"description":"Invoice line final price (including tax and discount)","type":"number","format":"float"},"qty":{"description":"Invoice line qty","type":"number","format":"float"},"package_qty":{"description":"Invoice line qty, that was purchased by using package","type":"number","format":"float"},"tax":{"description":"Tax entity related to this invoice line<br>Note: Use tax_rate in calculations as rate in this object can be different.","$ref":"#\/components\/schemas\/TaxEntity"},"tax_ratio":{"description":"Invoice line tax ratio","type":"number","format":"float"},"tax_amount":{"description":"Invoice line tax amount","type":"number","format":"float"},"amount":{"description":"Invoice line amount","type":"number","format":"float"},"deposit":{"description":"Invoice line deposit","type":"number","format":"float"},"rest_amount":{"description":"Invoice line rest amount","type":"number","format":"float"}}},"Invoice_PackageLineEntity":{"type":"object","description":"Entity that contains invoice line information with package","properties":{"package_id":{"description":"Package entity object id","type":"integer"},"package":{"description":"Package data","$ref":"#\/components\/schemas\/PackageEntity"},"period_start":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"package_instance_id":{"description":"Package payment id, that was initialized by client","type":"integer"},"id":{"description":"Invoice line id. Auto-generated value.","type":"integer"},"invoice_id":{"description":"Invoice id","type":"integer"},"name":{"description":"Invoice line name","type":"string"},"type":{"description":"Invoice line type. Can be booking, product, membership, custom","type":"string"},"discount_ratio":{"description":"Invoice line discount ratio","type":"number","format":"float"},"discount_amount":{"description":"Invoice line discount fixed amount","type":"number","format":"float"},"discount":{"description":"Invoice line discount","type":"number","format":"float"},"price":{"description":"Invoice line price","type":"number","format":"float"},"final_price":{"description":"Invoice line final price (including tax and discount)","type":"number","format":"float"},"qty":{"description":"Invoice line qty","type":"number","format":"float"},"package_qty":{"description":"Invoice line qty, that was purchased by using package","type":"number","format":"float"},"tax":{"description":"Tax entity related to this invoice line<br>Note: Use tax_rate in calculations as rate in this object can be different.","$ref":"#\/components\/schemas\/TaxEntity"},"tax_ratio":{"description":"Invoice line tax ratio","type":"number","format":"float"},"tax_amount":{"description":"Invoice line tax amount","type":"number","format":"float"},"amount":{"description":"Invoice line amount","type":"number","format":"float"},"deposit":{"description":"Invoice line deposit","type":"number","format":"float"},"rest_amount":{"description":"Invoice line rest amount","type":"number","format":"float"}}},"Invoice_TipLineEntity":{"type":"object","description":"Entity that contains invoice tip amount information","properties":{"tip_amount":{"description":"Tax amount","type":"number","format":"float"},"tip_ratio":{"description":"Tip prcentage","type":"integer"},"id":{"description":"Invoice line id. Auto-generated value.","type":"integer"},"invoice_id":{"description":"Invoice id","type":"integer"},"name":{"description":"Invoice line name","type":"string"},"type":{"description":"Invoice line type. Can be booking, product, membership, custom","type":"string"},"discount_ratio":{"description":"Invoice line discount ratio","type":"number","format":"float"},"discount_amount":{"description":"Invoice line discount fixed amount","type":"number","format":"float"},"discount":{"description":"Invoice line discount","type":"number","format":"float"},"price":{"description":"Invoice line price","type":"number","format":"float"},"final_price":{"description":"Invoice line final price (including tax and discount)","type":"number","format":"float"},"qty":{"description":"Invoice line qty","type":"number","format":"float"},"package_qty":{"description":"Invoice line qty, that was purchased by using package","type":"number","format":"float"},"tax":{"description":"Tax entity related to this invoice line<br>Note: Use tax_rate in calculations as rate in this object can be different.","$ref":"#\/components\/schemas\/TaxEntity"},"tax_ratio":{"description":"Invoice line tax ratio","type":"number","format":"float"},"tax_amount":{"description":"Invoice line tax amount","type":"number","format":"float"},"amount":{"description":"Invoice line amount","type":"number","format":"float"},"deposit":{"description":"Invoice line deposit","type":"number","format":"float"},"rest_amount":{"description":"Invoice line rest amount","type":"number","format":"float"}}},"Invoice_TaxEntity":{"type":"object","description":"Entity that contains invoice tax amount information","properties":{"amount":{"description":"Tax amount","type":"number","format":"float"},"id":{"description":"Tax id. Auto-generated value.","type":"integer"},"name":{"description":"Tax name","type":"string"},"ratio":{"description":"Tax ratio","type":"number","format":"float"},"is_default":{"description":"Is default tax","type":"boolean"}}},"BookingEntity":{"type":"object","description":"Entity that contains booking information","properties":{"id":{"description":"Booking id. Auto-generated value.","type":"integer"},"code":{"description":"Booking code. Auto-generated value.","type":"string"},"is_confirmed":{"description":"Booking is confirmed","type":"boolean"},"client_time_offset":{"description":"Client time offset in minutes (difference between client and company time), stored on booking","type":"integer"},"client_timezone":{"description":"Client timezone stored on booking (when client timezone was set on booking, see POST \/public\/clients\/timezone)","type":"string"},"client_start_datetime":{"description":"Booking start datetime in client timezone (when client timezone is stored on booking)","type":"string"},"client_end_datetime":{"description":"Booking end datetime in client timezone (when client timezone is stored on booking)","type":"string"},"start_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"record_date":{"description":"Booking creation date and time in company time zone (YYYY-MM-DD HH:MM:SS), the same time zone as start_datetime","type":"string"},"location_id":{"description":"Location id","type":"integer"},"category_id":{"description":"Category id","type":"integer"},"service_id":{"description":"Service id","type":"integer"},"provider_id":{"description":"Provider id","type":"integer"},"client_id":{"description":"Client id","type":"integer"},"duration":{"description":"Duration in minutes","type":"integer"},"service":{"description":"Service","$ref":"#\/components\/schemas\/ServiceEntity"},"provider":{"description":"Provider","$ref":"#\/components\/schemas\/ProviderEntity"},"location":{"description":"Location","$ref":"#\/components\/schemas\/LocationEntity"},"category":{"description":"Category","$ref":"#\/components\/schemas\/CategoryEntity"},"is_sequential":{"description":"Whether this booking belongs to a sequential (consecutive-services) batch","type":"boolean"}}},"ClientEntity":{"type":"object","description":"Entity that contains client information","properties":{"id":{"description":"Client id. Auto-generated value.","type":"integer"},"name":{"description":"Client name","type":"string"},"email":{"description":"Client email","type":"string"},"phone":{"description":"Client phone","type":"string"},"address1":{"description":"Client address fields<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"address2":{"description":"Client address fields<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"city":{"description":"Client city<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"zip":{"description":"Client zip code<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"country_id":{"description":"Client country id<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"state_id":{"description":"Client state id<br>These fields related to Client login custom feature and can be null.","type":"integer","nullable":true}}},"Timeline_IntervalEntity":{"type":"object","description":"Entity for daily timeline slot","properties":{"from":{"description":"Time from","type":"string"},"to":{"description":"Time to","type":"string"}}},"Timeline_IntervalsDateEntity":{"type":"object","description":"Entity for daily timeline","properties":{"date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"object_id":{"description":"Object (service\/provider etc.) id","type":"integer"},"intervals":{"description":"Intervals","type":"array","items":{"$ref":"#\/components\/schemas\/Timeline_IntervalEntity"}},"available_slots":{"description":"Available slots","type":"array","items":{"$ref":"#\/components\/schemas\/Timeline_SlotEntity"}}}},"Timeline_TimeValidationResultEntity":{"type":"object","description":"Entity that contains booking time validation result","properties":{"available":{"description":"Whether the booking time is available","type":"boolean"},"dates":{"description":"Valid dates","type":"array","items":{"type":"string"}},"error_dates":{"description":"Error dates with reasons","type":"array","items":{"type":"string"}},"error":{"description":"Error message if not available","type":"string"}}},"Timeline_PublicSlotsDateEntity":{"type":"object","description":"Entity for daily timeline of public API (slots with company and client date time)","properties":{"slots":{"description":"Slots","type":"array","items":{"$ref":"#\/components\/schemas\/Timeline_PublicSlotEntity"}},"id":{"description":"Slots date id (the same as date)","type":"string"},"date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"}}},"Timeline_SlotsDateEntity":{"type":"object","description":"Entity for daily timeline","properties":{"id":{"description":"Slots date id (the same as date)","type":"string"},"date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"slots":{"description":"Slots","type":"array","items":{"$ref":"#\/components\/schemas\/Timeline_SlotEntity"}}}},"Timeline_SlotEntity":{"type":"object","description":"Entity for daily timeline slot","properties":{"id":{"description":"Slot id (the same as time)","type":"string"},"time":{"description":"Time","type":"string"},"available_count":{"description":"Available slots count.<br>Filled only when with_available_slots=1 is passed and the \"Display Remaining Spaces\" custom feature is enabled, otherwise null","type":"integer","nullable":true},"total_count":{"description":"Total slots count.<br>Filled only when with_available_slots=1 is passed and the \"Display Remaining Spaces\" custom feature is enabled, otherwise null","type":"integer","nullable":true}}},"Timeline_PublicSlotEntity":{"type":"object","description":"Entity for daily timeline slot of public API (with company and client date time)","properties":{"datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"client_datetime":{"description":"Slot date and time in client timezone (YYYY-MM-DD HH:MM:SS format), only when client timezone is set<br>(see POST \/public\/clients\/timezone)","type":"string"},"id":{"description":"Slot id (the same as time)","type":"string"},"time":{"description":"Time","type":"string"},"available_count":{"description":"Available slots count.<br>Filled only when with_available_slots=1 is passed and the \"Display Remaining Spaces\" custom feature is enabled, otherwise null","type":"integer","nullable":true},"total_count":{"description":"Total slots count.<br>Filled only when with_available_slots=1 is passed and the \"Display Remaining Spaces\" custom feature is enabled, otherwise null","type":"integer","nullable":true}}},"SimplybookLoginEntity":{"type":"object","description":"Entity that contains admin login information (input only)","properties":{}},"ProductEntity":{"type":"object","description":"Entity that contains product information","properties":{"id":{"description":"Product id. Auto-generated value.","type":"integer"},"name":{"description":"Product name","type":"string"},"barcode":{"description":"Product barcode","type":"string"},"description":{"description":"Product description","type":"string"},"type":{"description":"Product type. It can be 'product' or 'attribute'","type":"string"},"price":{"description":"Product price","type":"number","format":"float"},"currency":{"description":"Product currency","type":"string"},"tax_id":{"description":"Tax id","type":"integer"},"tax":{"description":"Tax information","$ref":"#\/components\/schemas\/TaxEntity"},"duration":{"description":"Product duration","type":"integer"},"is_visible":{"description":"Product is visible","type":"boolean"},"services":{"description":"Attached services: [{\"service_id\": int, \"qty\": int}] (qty = default quantity of the add-on for the service)","type":"array","items":{"type":"object"}},"add_to_deposit":{"description":"Is product's price added to deposit for paid events plugin","type":"boolean"}}},"OnlineMeetingEntity":{"type":"object","description":"Online Meeting entity","properties":{"id":{"description":"id. Auto-generated value.","type":"integer"},"meeting_service_id":{"description":"Meeting Service Id","type":"integer"},"event_id":{"description":"Event id","type":"integer"},"unit_group_id":{"description":"Unit group id","type":"integer"},"date_start":{"description":"Start datetime","type":"string"},"options":{"description":"","type":"array","items":{"type":"integer"},"nullable":true}}},"PublicListMetadataEntity":{"type":"object","description":"Entity containing metadata for public lists","properties":{"items_count":{"description":"Total number of items in the list","type":"integer"},"pages_count":{"description":"Total number of pages in the list","type":"integer"},"page":{"description":"Current page number","type":"integer"},"on_page":{"description":"Number of items per page (on_page request parameter, max 100: bigger values are reduced to 100)","type":"integer"}}},"CategoryEntity":{"type":"object","description":"Entity that contains event category information","properties":{"id":{"description":"Category id. Auto-generated value.","type":"integer"},"name":{"description":"Category name","type":"string"},"description":{"description":"Category description","type":"string"},"services":{"description":"Category services (list of ids)","type":"array","items":{"type":"integer"}},"is_visible":{"description":"If category is visible on public side","type":"boolean"},"is_default":{"description":"If category is the default category for the company","type":"boolean"}}},"PublicCompanyDataEntity":{"type":"object","description":"Entity that contains public company data\nThis entity is used to store and manage public company information\nsuch as login, name, description, contact details, and address.","properties":{"login":{"description":"Company login","type":"string"},"name":{"description":"Company name","type":"string"},"description":{"description":"Company description","type":"string"},"country_id":{"description":"Company country ID","type":"string"},"email":{"description":"Company email","type":"string"},"phone":{"description":"Company phone","type":"string"},"web":{"description":"Company web","type":"string"},"skip_address":{"description":"Skip address","type":"boolean"},"address1":{"description":"Company address line 1","type":"string"},"address2":{"description":"Company address line 2","type":"string"},"city":{"description":"Company city","type":"string"},"zip":{"description":"Company zip code","type":"string"},"lat":{"description":"Company latitude","type":"number","format":"float"},"lng":{"description":"Company longitude","type":"number","format":"float"}}},"PublicListPackageInstanceEntity":{"type":"object","description":"Entity that contains package instances information with metadata","properties":{"data":{"description":"Package instances data","type":"array","items":{"$ref":"#\/components\/schemas\/PackageInstanceEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}},"GdprClientDataEntity":{"type":"object","description":"Entity that contains GDPR client data.\nThis entity represents all personal data stored for a client,\nreturned in response to GDPR data access requests.","properties":{"id":{"description":"Client identifier","type":"integer"},"client_info":{"description":"Client basic information<br>Contains name, email, phone, and other basic client details.","type":"object"},"client_accept_terms":{"description":"Client terms acceptance history<br>Records of when the client accepted various terms and conditions.","type":"array","items":{"type":"object"}},"openid_data":{"description":"OpenID authentication data<br>Information about OpenID logins if the client uses third-party authentication.","type":"array","items":{"type":"object"}},"facebook_data":{"description":"Facebook authentication data<br>Information about Facebook login if the client uses Facebook authentication.","type":"array","items":{"type":"object"}},"bookings":{"description":"Client bookings<br>History of appointments booked by the client.","type":"array","items":{"type":"object"}},"invoice":{"description":"Client invoices<br>Payment and invoice history for the client.","type":"array","items":{"type":"object"}},"emails":{"description":"Email communications<br>Records of emails sent to the client.","type":"array","items":{"type":"object"}},"reviews":{"description":"Client reviews<br>Feedback and reviews submitted by the client.","type":"array","items":{"type":"object"}},"memberships":{"description":"Client memberships<br>Information about memberships the client has purchased.","type":"array","items":{"type":"object"}},"sms":{"description":"SMS communications<br>Records of SMS messages sent to the client.","type":"array","items":{"type":"object"}},"contact_widget":{"description":"Contact widget interactions<br>Data from client interactions with contact widgets.","type":"array","items":{"type":"object"}},"soap_history":{"description":"SOAP API history<br>Records of SOAP API calls related to the client.","type":"array","items":{"type":"object"}},"soap_history_crypt":{"description":"Encrypted SOAP API history<br>Encrypted records of sensitive SOAP API calls.","type":"array","items":{"type":"object"}},"gdpr_sms_log":{"description":"GDPR SMS logs<br>Records of SMS messages sent for GDPR verification.","type":"array","items":{"type":"object"}},"voice_bookings_log":{"description":"Voice booking logs<br>Records of voice\/phone bookings made by the client.","type":"array","items":{"type":"object"}},"package_instance":{"description":"Package instances<br>Information about package purchases and usage.","type":"array","items":{"type":"object"}},"online_meeting":{"description":"Online meeting data<br>Information about online meetings the client has participated in.","type":"array","items":{"type":"object"}},"client_fields":{"description":"Custom client fields<br>Additional custom information stored about the client.","type":"array","items":{"type":"object"}},"waiting_list":{"description":"Waiting list entries<br>Records of when the client was on waiting lists.","type":"array","items":{"type":"object"}},"bonuses":{"description":"Client bonuses<br>Information about loyalty bonuses earned by the client.","type":"array","items":{"type":"object"}},"push_notification_log":{"description":"Push notification logs<br>Records of push notifications sent to the client.","type":"array","items":{"type":"object"}}}},"MembershipPaymentEntity":{"type":"object","description":"Entity that contains membership payment information. When this membership starts, ends, link to membership","properties":{"id":{"description":"Membership payment id. Auto-generated value.","type":"integer"},"client_id":{"description":"Client id","type":"integer"},"period_start":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"period_end":{"description":"Membership end date","type":"string"},"created":{"description":"Membership payment created date","type":"string"},"membership_id":{"description":"Membership id","type":"integer"},"membership":{"description":"Membership object","$ref":"#\/components\/schemas\/MembershipEntity"}}},"PublicTokenEntity":{"type":"object","description":"Entity that contains token for public api","properties":{"company_login":{"description":"Company login","type":"string"},"token":{"description":"token","type":"string"},"client_timezone":{"description":"Client timezone stored in token (see POST \/public\/clients\/timezone)","type":"string"}}},"ApiErrorEntity":{"type":"object","description":"Error response. Returned with the HTTP status code of the error\n(token expired is returned with HTTP 401 and code 419).","properties":{"code":{"description":"Error code (usually the same as HTTP status code, 419 for expired token)","type":"integer"},"message":{"description":"Error message","type":"string"},"data":{"description":"Error details, e.g. validation errors per field: {\"field_name\": [\"error message\", ...]}.<br>Empty array ([]) when there are no details","type":"object"},"message_data":{"description":"Additional error context (depends on the error). Empty array ([]) when not used","type":"object"}}},"PublicWaitingListBuildEntity":{"type":"object","description":"Entity used to join the waiting list for a fully booked day.\nNo time is passed - a waiting list entry covers the whole day. The client is created on the fly\nwhen the \"client\" object is provided, so joining the waiting list does not require an account.","properties":{"date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"service_id":{"description":"Service id","type":"integer"},"provider_id":{"description":"Provider id","type":"integer"},"count":{"description":"Number of bookings the client is waiting for","type":"integer"},"location_id":{"description":"Location id, when the location plugin is enabled","type":"integer","nullable":true},"category_id":{"description":"Category id, when the service category plugin is enabled","type":"integer","nullable":true},"client":{"description":"Client data. Required when the request is not authenticated as a client.","$ref":"#\/components\/schemas\/ClientEntity"},"terms":{"description":"Terms accepted by client (including the promotion letters \/ newsletter opt-in) - saved the<br>same way as for a regular booking, see Public_WaitingListService::join()","$ref":"#\/components\/schemas\/Booking_TermsEntity"}}},"WorkDayEntity":{"type":"object","description":"Entity that contains work day information","properties":{"id":{"description":"Work day id (the same as date)","type":"string"},"date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"time_from":{"description":"Work day time from","type":"string"},"time_to":{"description":"Work day time to","type":"string"},"is_day_off":{"description":"Is day off","type":"boolean"}}},"CompanyCategoryEntity":{"type":"object","description":"Entity that contains company category information","properties":{"id":{"description":"Category ID","type":"integer"},"category_key":{"description":"Category key","type":"string"},"name":{"description":"Category name","type":"string"},"image":{"description":"Category image","type":"string","nullable":true},"is_header":{"description":"Is category in header","type":"boolean"},"company_category_id":{"description":"Parent category ID","type":"integer","nullable":true}}},"PaymentProcessorResultEntity":{"type":"object","description":"Entity that contains payment processor result information.\nThis entity represents the result of a payment processing request,\nwhich could include a redirect URL, inline content, or a template\nfor rendering payment forms.","properties":{"redirect_url":{"description":"URL to redirect for external payment processing<br>This URL is provided when the payment processor requires<br>redirecting the user to an external payment page.","type":"string"},"inline_content":{"description":"HTML content for inline payment forms<br>This content is provided when the payment processor supports<br>embedding payment forms directly into the page.","type":"string"},"template":{"description":"HTML template for payment form<br>This template is provided when the payment processor requires<br>a specific HTML structure for the payment form.","type":"string"}}},"InvoiceRecurringProfileEntity":{"type":"object","description":"Entity that contains invoice recurring profile information","properties":{"id":{"description":"Recurring profile id. Auto-generated value.","type":"integer"},"start_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"last_payment_datetime":{"description":"Recurring profile last payment datetime","type":"string"},"next_payment_datetime":{"description":"Recurring profile next payment datetime","type":"string"},"cancellation_datetime":{"description":"Recurring profile cancellation datetime","type":"string"},"client_id":{"description":"Recurring profile client id","type":"integer"},"payment_processor":{"description":"Recurring profile payment processor","type":"string"},"init_invoice_id":{"description":"Initial invoice id","type":"integer"},"status":{"description":"Recurring profile status","type":"string"},"membership_id":{"description":"Id of the membership this profile was created for. Memberships are the only client-facing<br>feature that creates recurring profiles today, so this is effectively always set; null<br>only if the initial invoice unexpectedly has no membership line","type":"integer","nullable":true},"init_invoice":{"description":"Initial invoice. Always built internally (needed to derive client_id\/payment_processor<br>regardless of includes), but only present in the response when requested via<br>?include=init_invoice - use it to see the full purchase (all lines, amounts, tax) rather<br>than just the one membership this profile was created for","$ref":"#\/components\/schemas\/InvoiceEntity"},"membership":{"description":"The membership this profile was created for - the linked entity for membership_id above.<br>Exactly one membership line is expected on the initial invoice (a client can not buy two<br>different memberships in one recurring-enabling purchase); null if the invoice<br>unexpectedly has none. Only present in the response when requested via ?include=membership","$ref":"#\/components\/schemas\/MembershipEntity","nullable":true}}},"PublicListLocationEntity":{"type":"object","description":"Entity that contains locations information with metadata","properties":{"data":{"description":"Locations data","type":"array","items":{"$ref":"#\/components\/schemas\/LocationEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}},"Booking_TermsEntity":{"type":"object","description":"Entity that contains information about accepted terms.","properties":{"simplybook_terms":{"description":"SimplyBook terms accepted by client","type":"boolean"},"user_terms":{"description":"User terms accepted by client","type":"boolean"},"cancellation_terms":{"description":"Cancellation terms accepted by client","type":"boolean"},"promotion_letters":{"description":"Promotion letters accepted by client","type":"boolean"},"privacy_policy":{"description":"Privacy policy accepted by client","type":"boolean"}}},"Booking_AdditionalFieldValueEntity":{"type":"object","description":"Entity that contains additional field value","properties":{"id":{"description":"Additional field id","type":"integer"},"field":{"description":"Additional field name.","type":"string"},"value":{"description":"Additional field value","oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"}]},"file_hash":{"description":"Cloud field file hash","type":"string"}}},"Booking_RecurringSettingsEntity":{"type":"object","description":"Entity that contains booking recurring information.","properties":{"days":{"description":"Repeat days. For 'fixed' type: interval in days between bookings (e.g. 7 = every 7 days).<br>For 'weekly' type: bitmask of week days. Sum the values for the days you need:<br>Sunday=1, Saturday=2, Friday=4, Thursday=8, Wednesday=16, Tuesday=32, Monday=64.<br>Example: Monday+Wednesday = 64+16 = 80.","type":"integer"},"repeat_count":{"description":"Repeat count","type":"integer"},"type":{"description":"Type of repeat. Can be 'fixed', 'weekly'<br>'weekly' means repeat every week day, that set in $days mask.<br>'fixed' means repeat every $days day.","type":"string"},"mode":{"description":"Mode when it is impossible to book appointment on some date. Can be: 'skip', 'book_available', 'book_and_move'.<br>'skip' - Skip all bookings<br>'book_available' - book only on available dates<br>'book_and_move' - move to next date in case some date is not available","type":"string"},"price_per_session":{"description":"Price per session flag<br>If true, the price is per session, otherwise it is per whole pack","type":"boolean"}}},"SalesAndTaxReportEntity":{"type":"object","description":"Entity that contains invoice sales report row data","properties":{}},"TipEntity":{"type":"object","description":"Entity that contains tip information","properties":{"id":{"description":"Tip id. Auto-generated value.","type":"integer"},"ratio":{"description":"Tip ratio","type":"integer"},"is_default":{"description":"Is default tip","type":"boolean"},"tax_id":{"description":"Tax id","type":"integer"},"tax":{"description":"Tax information","$ref":"#\/components\/schemas\/TaxEntity"}}},"LocationEntity":{"type":"object","description":"Entity that contains location information","properties":{"id":{"description":"Location id. Auto-generated value.","type":"integer"},"name":{"description":"Location name","type":"string"},"description":{"description":"Location description","type":"string","nullable":true},"picture":{"description":"Picture file name","type":"string"},"picture_preview":{"description":"Path to preview picture","type":"string"},"providers":{"description":"Location providers (list of ids)","type":"array","items":{"type":"integer"}},"address1":{"description":"Location address 1","type":"string","nullable":true},"address2":{"description":"Location address 2","type":"string","nullable":true},"phone":{"description":"Phone number","type":"string","nullable":true},"city":{"description":"Location city","type":"string","nullable":true},"zip":{"description":"Location zip code","type":"string","nullable":true},"country_id":{"description":"Location country id. Must be an uppercase ISO 3166-1 alpha-2 code, e.g. \"US\".<br>Lowercase input is normalized to uppercase.","type":"string","nullable":true},"is_visible":{"description":"If location is visible on public side","type":"boolean"},"is_default":{"description":"If location is the default location for the company","type":"boolean"},"lat":{"description":"Location latitude","type":"number","format":"float"},"lng":{"description":"Location longitude","type":"number","format":"float"}}},"Promotion_BookingRestrictionEntity":{"type":"object","description":"Booking promotion restrictions info","properties":{"id":{"description":"Restriction id. Auto-generated value.","type":"integer"},"start_date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"end_date":{"description":"End date when promotion affects booking","type":"string"},"start_time":{"description":"Start time when promotion affects booking","type":"string"},"end_time":{"description":"End time when promotion affects booking","type":"string"}}},"ProviderEntity":{"type":"object","description":"Entity that contains provider information","properties":{"id":{"description":"Provider id. Auto-generated value.","type":"integer"},"name":{"description":"Provider name","type":"string"},"qty":{"description":"Provider capacity","type":"integer"},"email":{"description":"Provider email","type":"string"},"description":{"description":"Provider description","type":"string"},"phone":{"description":"Provider phone","type":"string"},"picture":{"description":"Picture file name","type":"string"},"picture_preview":{"description":"Path to preview picture","type":"string"},"color":{"description":"Provider color","type":"string"},"is_active":{"description":"If provider is active","type":"boolean"},"is_visible":{"description":"If provider is visible on public site","type":"boolean"},"services":{"description":"Array of ids of services where this provider connected.","type":"array","items":{"type":"integer"}}}},"ProductOrderEntity":{"type":"object","description":"Entity that contains product order information (list of products with quantities)","properties":{"items":{"description":"requested products","type":"array","items":{"$ref":"#\/components\/schemas\/ProductQtyEntity"}},"terms":{"description":"Terms accepted by client","type":"array","items":{"type":"integer"}},"client":{"description":"Client data","$ref":"#\/components\/schemas\/ClientEntity"}}},"TokenEntity":{"type":"object","description":"Entity that contains token information","properties":{"id":{"description":"Not used, always null","type":"string","nullable":true},"token":{"description":"Auth token","type":"string"},"company":{"description":"Company login","type":"string"},"login":{"description":"User login","type":"string"},"refresh_token":{"description":"Refresh token (use it to get new access token when old expired)","type":"string","nullable":true},"domain":{"description":"Company domain","type":"string","nullable":true},"require2fa":{"description":"Required two factor authorisation (token and refresh will be empty)","type":"boolean"},"allowed2fa_providers":{"description":"Allowed providers (sms\/ga)","type":"array","items":{"type":"string"}},"auth_session_id":{"description":"Authentication session id (pass it with 2FA request)","type":"string"}}},"BookingInfoEntity":{"type":"object","description":"Entity that contains detailed booking information","properties":{"approve_status":{"description":"Approve booking status: new\/approved\/canceled (note the spelling \"canceled\").\nnull when the booking has no approval record (Approve booking custom feature is not used)","type":"string","enum":["new","approved","canceled"]},"invoice_id":{"description":"Invoice id","type":"integer"},"status":{"description":"Booking status: confirmed\/pending\/cancelled\/error (note the spelling \"cancelled\", unlike approve_status and the admin API).\npending - waiting for approval or payment, error - payment failed","type":"string","enum":["confirmed","pending","cancelled","error"]},"id":{"description":"Booking id. Auto-generated value.","type":"integer"},"code":{"description":"Booking code. Auto-generated value.","type":"string"},"is_confirmed":{"description":"Booking is confirmed","type":"boolean"},"client_time_offset":{"description":"Client time offset in minutes (difference between client and company time), stored on booking","type":"integer"},"client_timezone":{"description":"Client timezone stored on booking (when client timezone was set on booking, see POST \/public\/clients\/timezone)","type":"string"},"client_start_datetime":{"description":"Booking start datetime in client timezone (when client timezone is stored on booking)","type":"string"},"client_end_datetime":{"description":"Booking end datetime in client timezone (when client timezone is stored on booking)","type":"string"},"start_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"record_date":{"description":"Booking creation date and time in company time zone (YYYY-MM-DD HH:MM:SS), the same time zone as start_datetime","type":"string"},"location_id":{"description":"Location id","type":"integer"},"category_id":{"description":"Category id","type":"integer"},"service_id":{"description":"Service id","type":"integer"},"provider_id":{"description":"Provider id","type":"integer"},"client_id":{"description":"Client id","type":"integer"},"duration":{"description":"Duration in minutes","type":"integer"},"service":{"description":"Service","$ref":"#\/components\/schemas\/ServiceEntity"},"provider":{"description":"Provider","$ref":"#\/components\/schemas\/ProviderEntity"},"location":{"description":"Location","$ref":"#\/components\/schemas\/LocationEntity"},"category":{"description":"Category","$ref":"#\/components\/schemas\/CategoryEntity"},"is_sequential":{"description":"Whether this booking belongs to a sequential (consecutive-services) batch","type":"boolean"}}},"SimplybookTokenEntity":{"type":"object","description":"Entity that contains token information","properties":{"token":{"description":"Auth token","type":"string"},"refresh_token":{"description":"Refresh token (use it to get new access token when old expired)","type":"string","nullable":true},"domain":{"description":"Company domain","type":"string","nullable":true},"require2fa":{"description":"Required two factor authorisation (token and refresh will be empty)","type":"boolean"},"allowed2fa_providers":{"description":"Allowed providers (sms\/ga)","type":"array","items":{"type":"string"}},"auth_session_id":{"description":"Authentication session id (pass it with 2FA request)","type":"string"}}},"PublicListProviderEntity":{"type":"object","description":"Entity that contains providers information with metadata","properties":{"data":{"description":"Providers data","type":"array","items":{"$ref":"#\/components\/schemas\/ProviderEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}},"PublicInvoiceResponseEntity":{"type":"object","description":"Invoice extended with token","properties":{"token":{"description":"token","type":"string"},"id":{"description":"Invoice id. Auto-generated value.","type":"integer"},"number":{"description":"Invoice number. Auto-generated value.","type":"string"},"datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"due_datetime":{"description":"Invoice due date. By default current datetime + payment timeout","type":"string"},"payment_datetime":{"description":"Payment payment date","type":"string","nullable":true},"refund_datetime":{"description":"Refund payment date","type":"string","nullable":true},"amount":{"description":"Invoice amount. Readonly","type":"number","format":"float"},"recurring_amount":{"description":"Invoice recurring amount. Readonly","type":"number","format":"float"},"deposit":{"description":"Invoice deposit. Readonly","type":"number","format":"float"},"rest_amount":{"description":"Invoice rest amount. Readonly","type":"number","format":"float"},"taxes":{"description":"Array of invoice taxes","type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_TaxEntity"}},"discount":{"description":"Invoice discount amount. Readonly","type":"number","format":"float"},"currency":{"description":"Invoice currency code. ISO 4217","type":"string"},"client_id":{"description":"Client id","type":"integer"},"description":{"description":"Invoice description","type":"string"},"payment_received":{"description":"Payment was received by company","type":"boolean"},"payment_processor":{"description":"Payment processor key","type":"string"},"lines":{"description":"Array of lines. The line can be one of the following types:<br><a href=\"#model-Invoice_BookingLineEntity\">Invoice_BookingLineEntity<\/a>, <a href=\"#model-Invoice_ProductLineEntity\">Invoice_ProductLineEntity<\/a>, <a href=\"#model-Invoice_MembershipLineEntity\">Invoice_MembershipLineEntity<\/a>, <a href=\"#model-Invoice_PackageLineEntity\">Invoice_PackageLineEntity<\/a>, <a href=\"#model-Invoice_PromotionLineEntity\">Invoice_PromotionLineEntity<\/a>, <a href=\"#model-Invoice_DepositLineEntity\">Invoice_DepositLineEntity<\/a>","oneOf":[{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_BookingLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_ProductLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_MembershipLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_PackageLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_PromotionLineEntity"}},{"type":"array","items":{"$ref":"#\/components\/schemas\/Invoice_DepositLineEntity"}}]},"promotion_instances":{"description":"Array of <a href=\"#model-PromotionInstanceEntity\">PromotionInstanceEntity<\/a>. Promotion instances used in invoice","type":"array","items":{"$ref":"#\/components\/schemas\/PromotionInstanceEntity"}},"package_instances":{"description":"Array of <a href=\"#model-PackageInstanceEntity\">PackageInstanceEntity<\/a>. Package instances used in invoice","type":"array","items":{"$ref":"#\/components\/schemas\/PackageInstanceEntity"}},"status":{"description":"Current invoice status","type":"string"},"can_be_paid":{"description":"True when this invoice can still be paid: status is one of new\/pending\/cancelled\/error<br>AND the payment timeout job has not reclaimed it yet. A 'cancelled'\/'error' invoice can<br>be released by that job while keeping its original status, so status alone is not<br>enough to tell - this mirrors the booking page's canPay check (CY1SDEV1-4130) so API<br>consumers (e.g. the booking widget) don't need to reimplement that rule. Only set on<br>GET \/public\/invoice\/item\/id\/{id}, not on list results.","type":"boolean"},"support_recurring_payment":{"description":"True in case this invoice can be paid with recurring payment method","type":"boolean"},"require_recurring_payment":{"description":"True in case this invoice can be paid only with recurring payment method","type":"boolean"},"recurring_profile_id":{"description":"Recurring profile id, linked to this invoice","type":"integer"}}},"ClientMembershipPaymentEntity":{"type":"object","description":"Entity that contains client membership payment information. When this membership starts, ends, rest of bookings, etc.","properties":{"rest":{"description":"Membership rest","type":"integer"},"simultaneous_rest":{"description":"Membership simultaneous rest","type":"integer"},"count":{"description":"Used bookings from membership","type":"integer"},"can_be_used":{"description":"Returns true if membership can be used","type":"boolean"},"is_expired":{"description":"Is membership expired","type":"boolean"},"invoice_id":{"description":"Invoice id, where this membership was purchased","type":"integer"},"invoice_number":{"description":"Invoice number, where this membership was purchased","type":"string"},"invoice_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 20:42:38"},"recurring_profile_id":{"description":"Recurring profile id for invoice with this membership","type":"integer"},"recurring_profile_status":{"description":"Recurring profile status for invoice with this membership","type":"string"},"status":{"description":"Current client membership status","type":"string"},"bookings":{"description":"Membership bookings array","type":"array","items":{"$ref":"#\/components\/schemas\/BookingEntity"},"nullable":true},"id":{"description":"Membership payment id. Auto-generated value.","type":"integer"},"client_id":{"description":"Client id","type":"integer"},"period_start":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"period_end":{"description":"Membership end date","type":"string"},"created":{"description":"Membership payment created date","type":"string"},"membership_id":{"description":"Membership id","type":"integer"},"membership":{"description":"Membership object","$ref":"#\/components\/schemas\/MembershipEntity"}}},"PublicClientEntity":{"type":"object","description":"Entity that contains client information (for public API)","properties":{"id":{"description":"Client id. Auto-generated value.","type":"integer"},"name":{"description":"Client name","type":"string"},"email":{"description":"Client email","type":"string"},"phone":{"description":"Client phone","type":"string"},"address1":{"description":"Client address fields<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"address2":{"description":"Client address fields<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"city":{"description":"Client city<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"zip":{"description":"Client zip code<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"country_id":{"description":"Client country id<br>These fields related to Client login custom feature and can be null.","type":"string","nullable":true},"state_id":{"description":"Client state id<br>These fields related to Client login custom feature and can be null.","type":"integer","nullable":true}}},"CompanyInfoEntity":{"type":"object","description":"Public company information","properties":{"login":{"description":"Company login","type":"string"},"name":{"description":"Company name","type":"string"},"description":{"description":"Company description","type":"string"},"timezone":{"description":"Company time zone","type":"string"},"address1":{"description":"Company address 1","type":"string","nullable":true},"address2":{"description":"Company address 2","type":"string","nullable":true},"phone":{"description":"Phone number","type":"string","nullable":true},"email":{"description":"Email","type":"string","nullable":true},"city":{"description":"Company city","type":"string","nullable":true},"zip":{"description":"Company zip code","type":"string","nullable":true},"country_id":{"description":"Company country id","type":"string","nullable":true},"public_url":{"description":"Public company url","type":"string"}}},"PublicBookingResultEntity":{"type":"object","description":"Entity that contains booking result information.\nReadonly entity","properties":{"token":{"description":"token","type":"string"},"bookings":{"description":"Array of bookings, that were booked.","type":"array","items":{"$ref":"#\/components\/schemas\/BookingEntity"}},"batch":{"description":"Booking batch","$ref":"#\/components\/schemas\/BookingBatchEntity","nullable":true}}},"AiSessionMessageEntity":{"type":"object","description":"Entity that contains AI session message information.","properties":{}},"PackageEntity":{"type":"object","description":"Entity that contains package information","properties":{"id":{"description":"Package id. Auto-generated value.","type":"integer"},"name":{"description":"Package name","type":"string"},"description":{"description":"Package description","type":"string"},"position":{"description":"Package position","type":"integer"},"file_id":{"description":"Image file id","type":"integer"},"picture":{"description":"Picture file name","type":"string"},"picture_path":{"description":"Picture path","type":"string"},"picture_preview":{"description":"Path to preview picture","type":"string"},"picture_large":{"description":"Path to large picture","type":"string"},"price":{"description":"Package price","type":"number","format":"float"},"currency":{"description":"Package price currency","type":"string"},"tax_id":{"description":"Tax id","type":"integer"},"tax":{"description":"Tax information","$ref":"#\/components\/schemas\/TaxEntity"},"duration":{"description":"Package duration","type":"integer"},"duration_type":{"description":"Package duration type","type":"string"},"sales_limit":{"description":"Package sales limit","type":"integer"},"sold":{"description":"Sold packages count","type":"integer"},"can_be_purchased":{"description":"If client can purchase this package","type":"boolean"},"is_active":{"description":"Is package active","type":"boolean"},"is_visible":{"description":"Is package visible on public site","type":"boolean"},"services":{"description":"Array of connected services (<a href=\"#model-Package_PackageServiceEntity\">Package_PackageServiceEntity<\/a>[])","type":"array","items":{"$ref":"#\/components\/schemas\/Package_PackageServiceEntity"}},"products":{"description":"Array of connected products (<a href=\"#model-Package_PackageProductEntity\">Package_PackageProductEntity<\/a>[])","type":"array","items":{"$ref":"#\/components\/schemas\/Package_PackageProductEntity"}},"paid_attributes":{"description":"Array of connected paid attributes (<a href=\"#model-Package_PackageProductEntity\">Package_PackageProductEntity<\/a>[])","type":"array","items":{"$ref":"#\/components\/schemas\/Package_PackageProductEntity"}},"has_instances":{"description":"If package has generated instances already","type":"boolean"},"is_use_package_limit":{"description":"Is use package limit","type":"boolean"},"package_limit":{"description":"Package limit","type":"integer"}}},"BookingBatchEntity":{"type":"object","description":"Entity that contains booking batch information","properties":{"id":{"description":"Batch id. Auto-generated value.","type":"integer"},"type":{"description":"Batch type. Can be 'recurring', 'multiple', 'group'.","type":"string"},"is_closed":{"description":"Flag that indicates that user has finished booking.","type":"boolean"},"is_sequential":{"description":"Whether this batch contains consecutive services booked one after another.","type":"boolean"}}},"ClientTermsEntity":{"type":"object","description":"Entity that contains client terms checkboxes","properties":{"cancellation_terms":{"description":"Cancellation terms","type":"string"},"privacy_policy":{"description":"Privacy policy","type":"string"},"simplybook_terms":{"description":"Simplybook terms","type":"string"},"user_terms":{"description":"User terms","type":"string"}}},"CountryEntity":{"type":"object","description":"Entity that represents a country.\nThis entity contains information about a country, including its ISO code,\nname, and whether it has states\/provinces. It is primarily used for address\nforms and location-based filtering.","properties":{"id":{"description":"Country ISO code<br>A two-letter ISO 3166-1 alpha-2 code that uniquely identifies the country.","type":"string"},"name":{"description":"Country name<br>The display name of the country.","type":"string"},"has_states":{"description":"Whether the country has states\/provinces<br>Indicates if the country has a list of states or provinces that can be selected.","type":"boolean"}}},"AiSessionEntity":{"type":"object","description":"Entity that contains AI session information.","properties":{}},"CompanyStatusEntity":{"type":"object","description":"Entity that contains company status information","properties":{"subscription_id":{"description":"Subscription ID","type":"integer"},"plan_code":{"description":"Subscription plan code","type":"string"},"bookings_count":{"description":"Number of bookings","type":"integer"},"registration_date":{"description":"Registration date","type":"string"},"subscription_start_date":{"description":"Subscription start date","type":"string"},"subscription_expiration_date":{"description":"Subscription expiration date","type":"string"},"custom_features":{"description":"Custom features statuses","type":"array","items":{"$ref":"#\/components\/schemas\/PluginEntity"}},"status":{"description":"Status of the company","type":"string"},"company_login":{"description":"Company login","type":"string"},"company_domain":{"description":"Company domain","type":"string"},"marketing_consent":{"description":"Whether the company has opted in to marketing emails","type":"boolean"}}},"InvoiceSalesReportEntity":{"type":"object","description":"Entity that contains invoice sales report row data","properties":{"id":{"description":"Invoice line id. Auto-generated value.","type":"integer"},"amount":{"description":"Invoice line amount. Readonly","type":"number","format":"float"},"rest_amount":{"description":"Invoice line rest amount. Readonly","type":"number","format":"float"},"qty":{"description":"Quantity of invoice line objects","type":"integer"},"currency":{"description":"Invoice currency code. ISO 4217","type":"string"},"type":{"description":"Invoice line type: 'booking'|'product'|'membership'|'promotion'|'custom'","type":"string"},"name":{"description":"Object name","type":"string"},"object_id":{"description":"Object id","oneOf":[{"type":"integer"},{"type":"string"}]},"date_name":{"description":"Date name","type":"string"},"date_id":{"description":"Date id","oneOf":[{"type":"integer"},{"type":"string"}]}}},"PublicConfigEntity":{"type":"object","description":"Entity that contains public configuration for client applications\nIncludes company information, date\/time formats, timezone, feature flags,\nand other settings required for public API initialization.","properties":{"date_format":{"description":"Date format string (e.g. 'Y-m-d')","type":"string"},"time_format":{"description":"Time format string (e.g. 'H:i')","type":"string"},"timezone":{"description":"Timezone identifier (e.g. 'Europe\/Kiev')","type":"string"},"show_booking_page_in_client_timezone":{"description":"Client may select own timezone; time slots and booking times can be returned in client timezone<br>(see POST \/public\/clients\/timezone)","type":"boolean"},"monday_is_first_day":{"description":"Monday is first day of week","type":"boolean"},"skip_address":{"description":"Skip address fields","type":"boolean"},"hide_email":{"description":"Hide company email","type":"boolean"},"hide_my_personal_data_upublic":{"description":"Hide personal data in public","type":"boolean"},"company_link":{"description":"Public company link","type":"string"},"client_email_required":{"description":"Client email required for registration","type":"boolean"},"client_phone_required":{"description":"Client phone required for registration","type":"boolean"},"country_prefix":{"description":"Country phone prefix (e.g. '+380')","type":"string"},"country_prefix_id":{"description":"Country prefix ID","type":"integer","nullable":true},"country_prefix_is_changeable":{"description":"Country prefix is changeable by client","type":"boolean"},"country_phone_initial":{"description":"Initial country ISO2 code for phone input","type":"string","nullable":true},"company_data":{"description":"Company data entity","$ref":"#\/components\/schemas\/PublicCompanyDataEntity","nullable":true},"cancelation_policy_enable_reason":{"description":"Cancelation policy reason enabled","type":"boolean"},"cancelation_policy_is_reason_required":{"description":"Cancelation policy reason required","type":"boolean"},"deposit_paid_events_is_client_can_pay_full_price":{"description":"Client can pay full price for deposit paid events","type":"boolean"},"client_login_allow_registration":{"description":"Client login allows registration","type":"boolean"},"client_login_allow_address":{"description":"Client login allows address","type":"boolean"},"client_login_require_address":{"description":"Client login requires address","type":"boolean"},"client_login_require_phone":{"description":"Client login requires phone","type":"boolean"},"client_login_hide_gdpr_report":{"description":"GDPR report hidden in client login","type":"boolean"},"client_strict_password_min_length":{"description":"Minimum password length for strict password policy","type":"integer"},"client_password_strength":{"description":"Password strength requirements (e.g. 'strong', 'medium')","type":"string"},"min_group_bookings":{"description":"Minimum group bookings allowed","type":"integer"},"max_group_bookings":{"description":"Maximum group bookings allowed","type":"integer"},"product_use_categories":{"description":"Products use categories","type":"boolean"},"product_use_menu":{"description":"Products use menu","type":"boolean"},"product_delivery_text":{"description":"Product delivery text","type":"string"},"price_includes_tax":{"description":"Price includes tax","type":"boolean"},"paid_attributes_exclusive":{"description":"Only one paid attribute (add-on) can be selected per booking","type":"boolean"},"allow_rebilling_payments":{"description":"Clients may save a payment method at checkout and reuse it for later payments.<br>When false the client applications must not offer to save or reuse a payment method,<br>and \/public\/payment-methods always returns an empty list","type":"boolean"},"captcha":{"description":"Captcha configuration (enabled flag and provider name)","type":"array","items":{"type":"integer"}},"slots_count_show_total":{"description":"Show total slots count next to available slots count (Available slots count plugin)","type":"boolean"},"react_widget_notification_url":{"description":"The merchant's page where the React widget is embedded, if explicitly configured<br>(react_widget plugin setting). Used by the widget itself to build a working payment<br>return address when it can't determine its own host page (e.g. embedded in an iframe).","type":"string","nullable":true},"react_widget_assets_url":{"description":"Base URL where the React widget's own static assets (app.js, runtime.js, ...) are<br>hosted, e.g. \"https:\/\/widget.simplybook.me\/react-widget\/public\/\". Same domain the<br>generated embed snippet uses (see getSecureDomain()). The widget can't otherwise<br>determine this at runtime, since window.location only ever reflects the host page's<br>own origin, not the origin its own script was loaded from.","type":"string"}}},"AnyUnitDataEntity":{"type":"object","description":"Entity that contains Any Unit Data information.\nReadonly entity","properties":{"id":{"description":"Provider id. Auto-generated value.","type":"string"},"name":{"description":"Any unit item name.","type":"string"},"description":{"description":"Any unit description.","type":"string"},"is_active":{"description":"Whether the option is currently active.","type":"boolean"},"position":{"description":"Display order position of the option.","type":"integer"},"is_visible":{"description":"Whether the option is visible on the public site. 0\/1 (1 = visible, 0 = hidden)","type":"integer","enum":[0,1]},"picture":{"description":"Picture file name. Nullable.","type":"string"},"picture_preview":{"description":"Path to the preview picture. Nullable.","type":"string"},"hide_other_providers":{"description":"Whether to hide other providers when this option is enabled.","type":"boolean"}}},"PackageInstanceEntity":{"type":"object","description":"Entity that contains package instance information","properties":{"id":{"description":"Package instance id. Auto-generated value.","type":"integer"},"client_id":{"description":"Client id","type":"integer"},"created":{"description":"Package instance created date","type":"string"},"period_start":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"period_end":{"description":"Package end date","type":"string"},"status":{"description":"Package status","type":"string"},"can_be_used":{"description":"If package can be used","type":"boolean"},"is_used":{"description":"If package was totally used","type":"boolean"},"package_id":{"description":"Package id","type":"integer"},"package":{"description":"Package object","$ref":"#\/components\/schemas\/PackageEntity"},"services":{"description":"Warning!<br>This is used services for invoice package instances or<br>rest of services in the package instance for package instance details","type":"array","items":{"$ref":"#\/components\/schemas\/Package_PackageServiceEntity"}},"products":{"description":"Warning!<br>This is used products for invoice package instances or<br>rest of products in the package instance for package instance details","type":"array","items":{"$ref":"#\/components\/schemas\/Package_PackageProductEntity"}},"paid_attributes":{"description":"Warning!<br>This is used attributes for invoice package instances or<br>rest of attributes in the package instance for package instance details","type":"array","items":{"$ref":"#\/components\/schemas\/Package_PackageProductEntity"}},"count_used_package_instance":{"description":"How many times packages used","type":"integer"}}},"TimezoneEntity":{"type":"object","description":"Entity that contains timezone information","properties":{"id":{"description":"Timezone identifier (e.g. 'America\/New_York')","type":"string"},"name":{"description":"Timezone display name","type":"string"},"offset":{"description":"Current offset from UTC in seconds","type":"integer"}}},"PluginEntity":{"type":"object","description":"Entity that contains plugin information.","properties":{"key":{"description":"Plugin key","type":"string"},"name":{"description":"Plugin name","type":"string"},"is_active":{"description":"Is plugin turned on and configured","type":"boolean"},"is_turned_on":{"description":"Is plugin turned on","type":"boolean"}}},"PromotionEntity":{"type":"object","description":"Entity that contains promotion information","properties":{"id":{"description":"Promotion id. Auto-generated value.","type":"integer"},"name":{"description":"Promotion name","type":"string"},"description":{"description":"Promotion description","type":"string"},"file_id":{"description":"Image file id","type":"integer"},"picture_preview":{"description":"Path to preview picture","type":"string"},"picture_large":{"description":"Path to large picture","type":"string"},"is_visible":{"description":"Is promotion visible on public site","type":"boolean"},"is_active":{"description":"Is promotion active","type":"boolean"},"position":{"description":"Promotion position","type":"integer"},"price":{"description":"Promotion price to purchase (gift card)","type":"number","format":"float"},"currency":{"description":"Promotion price currency to purchase (gift card)","type":"string"},"tax":{"description":"Promotion tax","$ref":"#\/components\/schemas\/TaxEntity"},"promotion_type":{"description":"Promotion type. Can be 'gift_card', 'discount'","type":"string"},"discount_type":{"description":"Discount type. Can be 'fixed_amount', 'percentage'<br>fixed_amount is discount for fixed amount.<br>percentage is percentage discount.","type":"string"},"discount":{"description":"Discount value (amount value or percentage value)","type":"number","format":"float"},"duration_type":{"description":"Duration type for gift cards ('year', 'month', 'week', 'day')","type":"string"},"duration":{"description":"Duration length","type":"integer"},"client_type":{"description":"Client type can be 'new' or 'all'","type":"string"},"allow_usage_count":{"description":"Limit of usage count","type":"integer"},"is_unlimited":{"description":"Is unlimited","type":"boolean"},"affect_services":{"description":"Is it possible to apply this promotion to services?","type":"boolean"},"affect_products":{"description":"Is it possible to apply this promotion to products?","type":"boolean"},"affect_paid_attributes":{"description":"Is it possible to apply this promotion to paid attribute?","type":"boolean"},"affect_memberships":{"description":"Is it possible to apply this promotion to memberships?","type":"boolean"},"affect_packages":{"description":"Is it possible to apply this promotion to packages?","type":"boolean"},"service_restrictions":{"description":"Array of services ids to which you can apply promotion","type":"array","items":{"type":"integer"}},"booking_restrictions":{"description":"Array of Promotion_BookingRestrictionEntity","type":"array","items":{"$ref":"#\/components\/schemas\/Promotion_BookingRestrictionEntity"}},"product_restrictions":{"description":"Array of product ids to which you can apply promotion","type":"array","items":{"type":"integer"}},"paid_attribute_restrictions":{"description":"Array of paid attributes ids to which you can apply promotion","type":"array","items":{"type":"integer"}},"memberships_restrictions":{"description":"Array of memberships ids to which you can apply promotion","type":"array","items":{"type":"integer"}},"package_restrictions":{"description":"Array of packages ids to which you can apply promotion","type":"array","items":{"type":"integer"}}}},"ClientTermsStatusEntity":{"type":"object","description":"Entity that contains client terms status information","properties":{"id":{"description":"Client ID","type":"integer"},"accepted_simplybook_terms":{"description":"Whether SimplyBook terms are accepted","type":"boolean"},"accepted_user_terms":{"description":"Whether user terms are accepted","type":"boolean"},"accepted_cancellation_terms":{"description":"Whether cancellation terms are accepted","type":"boolean"},"accepted_privacy_policy":{"description":"Whether privacy policy is accepted","type":"boolean"},"accepted_promotion_letters":{"description":"Whether promotion letters are accepted","type":"boolean"},"enabled_simplybook_terms":{"description":"Whether SimplyBook terms are enabled","type":"boolean"},"enabled_user_terms":{"description":"Whether user terms are enabled","type":"boolean"},"enabled_cancellation_terms":{"description":"Whether cancellation terms are enabled","type":"boolean"},"enabled_promotion_letters":{"description":"Whether promotion letters are enabled","type":"boolean"},"enabled_privacy_policy":{"description":"Whether privacy policy is enabled","type":"boolean"},"cancellation_terms_label":{"description":"Cancellation terms label","type":"string"},"accepted_simplybook_user_terms":{"description":"Whether SimplyBook user terms are accepted","type":"boolean"},"accepted_simplybook_user_privacy":{"description":"Whether SimplyBook user privacy is accepted","type":"boolean"},"simplybook_terms":{"description":"SimplyBook terms version","type":"integer","nullable":true},"user_terms":{"description":"User terms version","type":"integer","nullable":true},"cancellation_terms":{"description":"Cancellation terms version","type":"integer","nullable":true},"privacy_policy":{"description":"Privacy policy version","type":"integer","nullable":true},"promotion_letters":{"description":"Promotion letters version","type":"integer","nullable":true}}},"PromotionInstanceEntity":{"type":"object","description":"Entity that contains promotion instance information","properties":{"id":{"description":"Promotion instance id. Auto-generated value.","type":"integer"},"promotion":{"description":"Promotion information","$ref":"#\/components\/schemas\/PromotionEntity"},"start_date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"expired_date":{"description":"Promotion instance expire date","type":"string"},"is_used":{"description":"Returns true if this promotion was used already","type":"boolean"},"can_be_used":{"description":"Returns true if this promotion can still be used","type":"boolean"},"can_be_used_count":{"description":"Returns how many times left. In case this value is -1 then can be used unlimited times.","type":"integer"},"code":{"description":"Promotion instance code","type":"string"},"client_id":{"description":"Client id","type":"integer"}}},"PublicListAdditionalFieldEntity":{"type":"object","description":"Entity that contains additional fields information with metadata","properties":{"data":{"description":"Additional fields data","type":"array","items":{"$ref":"#\/components\/schemas\/AdditionalFieldEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}},"CompanySubscriptionEntity":{"type":"object","description":"Entity that contains company subscription information","properties":{"subscription_id":{"description":"Subscription ID","type":"integer"},"plan_code":{"description":"Subscription plan code","type":"string"},"subscription_start_date":{"description":"Subscription start date","type":"string"},"subscription_expiration_date":{"description":"Subscription expiration date","type":"string"}}},"PublicListServiceEntity":{"type":"object","description":"Entity that contains services information with metadata","properties":{"data":{"description":"Services data","type":"array","items":{"$ref":"#\/components\/schemas\/PublicServiceEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/PublicListMetadataEntity"}}},"TaxEntity":{"type":"object","description":"Entity that contains tax information","properties":{"id":{"description":"Tax id. Auto-generated value.","type":"integer"},"name":{"description":"Tax name","type":"string"},"ratio":{"description":"Tax ratio","type":"number","format":"float"},"is_default":{"description":"Is default tax","type":"boolean"}}}},"securitySchemes":{"CompanyLogin":{"type":"apiKey","in":"header","name":"X-Company-Login","description":"Company login from TokenEntity.company"},"ApiToken":{"type":"apiKey","in":"header","name":"X-Token","description":"Authentication token from TokenEntity.token"}}},"security":[{"CompanyLogin":[],"ApiToken":[]}]}