{"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 \/admin\/auth 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":{"\/admin\/auth":{"post":{"tags":["auth"],"summary":"Authentication","description":"Authentication process. Return auth token info (<a href=\"#model-TokenEntity\">TokenEntity<\/a>)<br>Accepts <a href=\"#model-AdminLoginEntity\">AdminLoginEntity<\/a> data as body of request.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.<br><br>You can use either user password or API User Key for authentication:<br>- \"password\": \"<insert your user password>\" - traditional password authentication (requires 2FA and IP verification if enabled)<br>- \"password\": \"api_user_key_...\" - API User Key authentication (bypasses IP verification)<br><br>API User Keys can be generated in Settings > API User Keys section.<br>They are more secure as they allow separate keys per application and don't require sharing your password.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TokenEntity"}}}},"403":{"description":"Access denied or Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_auth","security":[],"requestBody":{"required":true,"description":"authentication process data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminLoginEntity"}}}}}},"\/admin\/auth\/openid-token":{"post":{"tags":["auth"],"summary":"OpenID sign in","description":"Authenticate via an OpenID provider (e.g. Google, Facebook) and receive an auth token.<br>Verify the provider token, resolve the linked company, and return <a href=\"#model-TokenEntity\">TokenEntity<\/a>.<br>If multiple companies are linked to the account and no login is specified,<br>returns 422 with the list of available company logins so the client can choose.<br>Accepts <a href=\"#model-AdminOpenidLoginEntity\">AdminOpenidLoginEntity<\/a> data as body of request.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TokenEntity"}}}},"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_admin_auth_openid_token","requestBody":{"required":true,"description":"OpenID login data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminOpenidLoginEntity"}}}}}},"\/admin\/auth\/2fa":{"post":{"tags":["auth"],"summary":"Second factory authentication","description":"Second factory authentication process. Return auth token info (<a href=\"#model-TokenEntity\">TokenEntity<\/a>). Required in case 2FA authentication is enabled.<br>Pass session from authentication step. In case you use SMS as 2fa provider you need to call \/admin\/auth\/sms to receive SMS with code.<br>Accepts <a href=\"#model-AdminLogin2FAEntity\">AdminLogin2FAEntity<\/a> data as body of request.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.<br>Throws AccessDenied error in case user does not have access to perform this action.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TokenEntity"}}}},"403":{"description":"Access denied or Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_auth_2fa","security":[],"requestBody":{"required":true,"description":"second factory authentication data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminLogin2FAEntity"}}}}}},"\/admin\/auth\/sms":{"get":{"tags":["auth"],"summary":"Get SMS code","description":"Send SMS to user phone number. Returns empty response.<br>Throws BadRequest error in case invalid data was provided.<br>Throws AccessDenied error in case user does not have access to perform this action.","responses":{"200":{"description":"Successful response"},"403":{"description":"Access denied or Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_auth_sms","security":[],"parameters":[{"name":"company","in":"query","required":true,"description":"company login","schema":{"type":"string"}},{"name":"session_id","in":"query","required":true,"description":"session ID from authentication step","schema":{"type":"string"}}]}},"\/admin\/auth\/refresh-token":{"post":{"tags":["auth"],"summary":"Renew token with refresh token","description":"Renew token with refresh token, that was received on authentication step. Return <a href=\"#model-TokenEntity\">TokenEntity<\/a>.<br>Accepts <a href=\"#model-RefreshTokenEntity\">RefreshTokenEntity<\/a> data as body of request.<br>Throws BadRequest error in case invalid data was provided.<br>Throws AccessDenied error in case user does not have access to perform this action.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TokenEntity"}}}},"403":{"description":"Access denied or Forbidden","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"401":{"description":"Unauthorized","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_auth_refresh_token","security":[],"requestBody":{"required":true,"description":"refresh token data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RefreshTokenEntity"}}}}}},"\/admin\/auth\/logout":{"post":{"tags":["auth"],"summary":"Logout and revoke token","description":"Revoke token that was received on authentication.<br>Accepts <a href=\"#model-AdminLogoutEntity\">AdminLogoutEntity<\/a> data as body of request.<br>Throws BadRequest error in case invalid data was provided.<br>Throws AccessDenied error in case user does not have access to perform this action.","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"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_auth_logout","requestBody":{"required":true,"description":"logout data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminLogoutEntity"}}}}}},"\/admin\/company\/info":{"get":{"tags":["company"],"summary":"Get company information","description":"Returns company profile <a href=\"#model-AdminCompanyInfoEntity\">(AdminCompanyInfoEntity)<\/a>: name, contacts, address and time zone.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminCompanyInfoEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_company_info"}},"\/admin\/config":{"get":{"tags":["company"],"summary":"Get company configuration","description":"Returns company configuration <a href=\"#model-AdminCompanyConfigEntity\">(AdminCompanyConfigEntity)<\/a>: time zone, timeline step,<br>group booking limit, first day of week, phone prefix and tax settings.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminCompanyConfigEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_config"}},"\/admin\/bookings":{"post":{"tags":["booking"],"summary":"Make new booking","description":"Make new booking and return booking result <a href=\"#model-BookingResultEntity\">(BookingResultEntity)<\/a>.<br>Accepts <a href=\"#model-AdminBookingBuildEntity\">AdminBookingBuildEntity<\/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.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BookingResultEntity"}}}},"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_admin_bookings","requestBody":{"required":true,"description":"booking data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminBookingBuildEntity"}}}}},"get":{"tags":["booking"],"summary":"Get bookings list","description":"Return bookings list <a href=\"#model-AdminReportBookingEntity\">(AdminReportBookingEntity)<\/a>.<br>Please note that result is wrapped into paginated result.<br>Throws AccessDenied error in case user does not have access to bookings report.<br>In GET parameters you can pass <b>page<\/b>, <b>on_page<\/b> and <b>filter<\/b> with following parameters:<br><b>upcoming_only<\/b> - return upcoming bookings only<br><b>status<\/b> - booking status (can be confirmed\/confirmed_pending\/pending\/canceled)<br><b>services<\/b> - array of service ids to filter by services<br><b>providers<\/b> - array of provider ids to filter by providers<br><b>client_id<\/b> - client id to filter by client id<br><b>date<\/b> - filter by date (YYYY-MM-DD format)<br><b>record_date_from<\/b> - filter by booking creation date from (YYYY-MM-DD, company time zone)<br><b>record_date_to<\/b> - filter by booking creation date to (YYYY-MM-DD, company time zone)<br><b>edited_date_from<\/b> - filter by last edit date from (YYYY-MM-DD)<br><b>edited_date_to<\/b> - filter by last edit date to (YYYY-MM-DD)<br><b>search<\/b> - search string (by code, client data)<br><b>additional_fields<\/b> - search by additional fields (&filter[additional_fields][field] = value)\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\/AdminReportBookingEntity"}},"metadata":{"$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_bookings","parameters":[{"name":"page","in":"query","required":false,"description":"in list","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page","schema":{"type":"integer"}},{"name":"filter[upcoming_only]","in":"query","required":false,"description":"return upcoming bookings only (0 or 1)","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[status]","in":"query","required":false,"description":"filter by status (enum[confirmed,confirmed_pending,pending,canceled])","schema":{"type":"string","enum":["confirmed","confirmed_pending","pending","canceled"],"description":"filter by status (confirmed\/confirmed_pending\/pending\/canceled)"}},{"name":"filter[services]","in":"query","required":false,"description":"filter by services (array of service ids)","schema":{"type":"array","items":{"type":"integer"},"description":"filter by services (array of service ids)"}},{"name":"filter[providers]","in":"query","required":false,"description":"filter by providers (array of provider ids)","schema":{"type":"array","items":{"type":"integer"},"description":"filter by providers (array of provider ids)"}},{"name":"filter[client_id]","in":"query","required":false,"description":"filter by client id","schema":{"type":"integer"}},{"name":"filter[date]","in":"query","required":false,"description":"filter by date (YYYY-MM-DD)","schema":{"type":"string"}},{"name":"filter[date_from]","in":"query","required":false,"description":"filter by date from (YYYY-MM-DD)","schema":{"type":"string"}},{"name":"filter[date_to]","in":"query","required":false,"description":"filter by date to (YYYY-MM-DD)","schema":{"type":"string"}},{"name":"filter[record_date_from]","in":"query","required":false,"description":"filter by booking creation date from (YYYY-MM-DD, company time zone)","schema":{"type":"string"}},{"name":"filter[record_date_to]","in":"query","required":false,"description":"filter by booking creation date to (YYYY-MM-DD, company time zone)","schema":{"type":"string"}},{"name":"filter[edited_date_from]","in":"query","required":false,"description":"filter by last edit date from (YYYY-MM-DD)","schema":{"type":"string"}},{"name":"filter[edited_date_to]","in":"query","required":false,"description":"filter by last edit date to (YYYY-MM-DD)","schema":{"type":"string"}},{"name":"filter[search]","in":"query","required":false,"description":"search string (by code, client data)","schema":{"type":"string"}},{"name":"filter[additional_fields]","in":"query","required":false,"description":"search by additional fields (&filter[additional_fields][field] = value)","schema":{"type":"array","items":{"type":"integer"},"description":"search by additional fields (&filter[additional_fields][field] = value)"}}]}},"\/admin\/bookings\/{id}":{"put":{"tags":["booking"],"summary":"Edit booking","description":"Modify booking and return booking result <a href=\"#model-BookingResultEntity\">(BookingResultEntity)<\/a>.<br>Accepts <a href=\"#model-AdminBookingBuildEntity\">AdminBookingBuildEntity<\/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>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\/BookingResultEntity"}}}},"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":"put_admin_bookings_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"booking data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminBookingBuildEntity"}}}}},"get":{"tags":["booking"],"summary":"Get booking details","description":"Return booking item entity by booking id. <a href=\"#model-AdminBookingDetailsEntity\">(AdminBookingDetailsEntity)<\/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\/AdminBookingDetailsEntity"}}}},"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_admin_bookings_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}]},"delete":{"tags":["booking"],"summary":"Cancel booking","description":"Cancel booking by booking id and return booking that was canceled <a href=\"#model-AdminBookingDetailsEntity\">(AdminBookingDetailsEntity)<\/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\/AdminBookingDetailsEntity"}}}},"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":"delete_admin_bookings_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}]}},"\/admin\/bookings\/{id}\/approve":{"put":{"tags":["booking"],"summary":"Approve booking with approve booking custom feature","description":"Approve booking by booking id and return booking details <a href=\"#model-AdminBookingDetailsEntity\">(AdminBookingDetailsEntity)<\/a>.<br>Throws AccessDenied error in case user does not have access to booking.<br>Throws BadRequest error in case booking can not be approved.<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\/AdminBookingDetailsEntity"}}}},"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":"put_admin_bookings_item_approve","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}]}},"\/admin\/bookings\/{id}\/decline":{"put":{"tags":["booking"],"summary":"Decline booking with approve booking custom feature","description":"Decline pending booking by booking id and return booking details <a href=\"#model-AdminBookingDetailsEntity\">(AdminBookingDetailsEntity)<\/a>.<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 booking is not pending approval.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminBookingDetailsEntity"}}}},"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":"put_admin_bookings_item_decline","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}]}},"\/admin\/bookings\/{id}\/status":{"put":{"tags":["booking"],"summary":"Apply status with status custom feature","description":"Apply booking status booking by booking id and return booking details <a href=\"#model-AdminBookingDetailsEntity\">(AdminBookingDetailsEntity)<\/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\/AdminBookingDetailsEntity"}}}},"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":"put_admin_bookings_item_status","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"booking status id","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminStatusEntity"}}}}}},"\/admin\/bookings\/{id}\/links":{"get":{"tags":["booking"],"summary":"Get booking links","description":"Return booking links entity by booking id <a href=\"#model-AdminBookingLinksEntity\">(AdminBookingLinksEntity)<\/a>.<br>Links include: booking viewing link, cancellation link, and rescheduling link (if reschedule plugin is enabled).<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\/AdminBookingLinksEntity"}}}},"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_admin_bookings_item_links","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}]}},"\/admin\/bookings\/{id}\/comment":{"put":{"tags":["booking"],"summary":"Set comment for booking","description":"Set booking comment by booking id and return booking details <a href=\"#model-AdminBookingDetailsEntity\">(AdminBookingDetailsEntity)<\/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\/AdminBookingDetailsEntity"}}}},"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":"put_admin_bookings_item_comment","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":{"comment":{"description":"booking comment","type":"string"}}}}}}}},"\/admin\/bookings\/{id}\/online-meeting-link":{"get":{"tags":["booking"],"summary":"Get online meeting link for provider","description":"Get provider's online meeting link URL by booking id (Online meetings plugin has to be enabled and set)\n\n**Return Description:** Online meeting link URL","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_admin_bookings_item_online_meeting_link","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}]}},"\/admin\/bookings\/{id}\/client-online-meeting-link":{"get":{"tags":["booking"],"summary":"Get online meeting link for client","description":"\n\n**Return Description:** Response 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_admin_bookings_item_client_online_meeting_link","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : booking id","schema":{"type":"string"}}]}},"\/admin\/schedule":{"get":{"tags":["booking"],"summary":"Get schedule","description":"Return array of day schedule <a href=\"#model-WorkDayEntity\">(WorkDayEntity)<\/a> info objects for selected service, provider and dates\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkDayEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_schedule","parameters":[{"name":"service_id","in":"query","required":true,"description":"selected service id","schema":{"type":"integer"}},{"name":"provider_id","in":"query","required":true,"description":"selected provider 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)","schema":{"type":"string","format":"date","description":"Date in format YYYY-MM-DD"}}]}},"\/admin\/schedule\/slots":{"get":{"tags":["booking"],"summary":"Get slots","description":"Return array of available slots <a href=\"#model-TimeSlotEntity\">(TimeSlotEntity)<\/a> to book as admin.<br>It just returns schedule of day divided by slots.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/TimeSlotEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_schedule_slots","parameters":[{"name":"service_id","in":"query","required":true,"description":"selected service id","schema":{"type":"integer"}},{"name":"provider_id","in":"query","required":true,"description":"selected provider id","schema":{"type":"integer"}},{"name":"date","in":"query","required":true,"description":"selected date (YYYY-MM-DD format)","schema":{"type":"string","format":"date","description":"Date in format YYYY-MM-DD"}}]}},"\/admin\/schedule\/available-slots":{"get":{"tags":["booking"],"summary":"Get available slots","description":"Return array of available slots to book <a href=\"#model-TimeSlotEntity\">(TimeSlotEntity)<\/a>.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/TimeSlotEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_schedule_available_slots","parameters":[{"name":"service_id","in":"query","required":true,"description":"selected service id","schema":{"type":"integer"}},{"name":"provider_id","in":"query","required":true,"description":"selected provider id","schema":{"type":"integer"}},{"name":"date","in":"query","required":true,"description":"selected date (YYYY-MM-DD format)","schema":{"type":"string","format":"date","description":"Date in format YYYY-MM-DD"}},{"name":"count","in":"query","required":true,"description":"group booking count","schema":{"type":"integer"}},{"name":"products","in":"query","required":false,"description":"array of selected products\/add-ons","schema":{"type":"array","items":{"type":"integer"}}}]}},"\/admin\/schedule\/first-available-slot":{"get":{"tags":["booking"],"summary":"Get first available slot","description":"Return first available slot <a href=\"#model-TimeSlotEntity\">(TimeSlotEntity)<\/a> for selected service\/provider\/date<br>It can return slot for different date in case all slots are busy for selected date.<br>Returns null when no free slot is found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TimeSlotEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_schedule_first_available_slot","parameters":[{"name":"service_id","in":"query","required":true,"description":"selected service id","schema":{"type":"integer"}},{"name":"provider_id","in":"query","required":true,"description":"selected provider id","schema":{"type":"integer"}},{"name":"date","in":"query","required":true,"description":"selected date (YYYY-MM-DD format)","schema":{"type":"string","format":"date","description":"Date in format YYYY-MM-DD"}},{"name":"count","in":"query","required":true,"description":"group booking count","schema":{"type":"integer"}}]}},"\/admin\/schedule\/calculate-end-time":{"get":{"tags":["booking"],"summary":"Calculate end time for selected start date, service, provider and products.","description":"\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TimeSlotEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_schedule_calculate_end_time","parameters":[{"name":"service_id","in":"query","required":true,"description":"selected service id","schema":{"type":"integer"}},{"name":"provider_id","in":"query","required":true,"description":"selected provider id","schema":{"type":"integer"}},{"name":"start_datetime","in":"query","required":true,"description":"selected start date and time","schema":{"type":"string","format":"date-time","description":"Date and time in format YYYY-MM-DD HH:MM:SS","example":"2026-11-22 16:12:32"}},{"name":"products","in":"query","required":false,"description":"array of selected addons","schema":{"type":"array","items":{"type":"integer"}}}]}},"\/admin\/timeline\/slots":{"get":{"tags":["booking"],"summary":"Get slots timeline","description":"Return data for slots timeline per date <a href=\"#model-Timeline_SlotsDateEntity\">(Timeline_SlotsDateEntity)<\/a>.<br>Throws BadRequest (\"Too long period\") when the period between date_from and date_to is longer than 45 days.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Timeline_SlotsDateEntity"}}}}},"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":"get_admin_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","schema":{"type":"integer"}},{"name":"count","in":"query","required":false,"description":"group bookings count, default 1","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":"Booking id to exclude from busy slots (edit booking case)","schema":{"type":"integer"}},{"name":"product_ids","in":"query","required":false,"description":"Array of selected products\/service addons ids","schema":{"type":"array","items":{"type":"integer"}}},{"name":"skip_min_max_restriction","in":"query","required":false,"description":"ignore the company's minimum time before booking and maximum booking period (1 or 0, default 0). Without it the same booking window as on the booking page applies","schema":{"type":"integer","enum":[0,1]}}]}},"\/admin\/calendar":{"get":{"tags":["booking"],"summary":"Get calendar data","description":"Return calendar data with bookings, notes and break times <a href=\"#model-Calendar_DataEntity\">(Calendar_DataEntity)<\/a>.<br>Throws AccessDenied error in case user does not have access to bookings report.<br>In GET parameters you can pass <b>mode<\/b> (day, week, provider or service) and <b>filter<\/b> with following parameters:<br><b>upcoming_only<\/b> - return upcoming bookings only<br><b>status<\/b> - booking status (can be confirmed\/confirmed_pending\/pending\/canceled)<br><b>services<\/b> - array of service ids to filter by services<br><b>providers<\/b> - array of provider ids to filter by providers<br><b>client_id<\/b> - client id. to filter by client id<br><b>date_from<\/b> - filter by date from (YYYY-MM-DD format)<br><b>date_to<\/b> - filter by date to (YYYY-MM-DD format)<br><b>search<\/b> - search string (by code, client data)<br><b>additional_fields<\/b> - search by additional fields (&filter[additional_fields][field] = value)\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Calendar_DataEntity"}}}},"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_admin_calendar","parameters":[{"name":"page","in":"query","required":false,"description":"page in list","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page","schema":{"type":"integer"}},{"name":"mode","in":"query","required":false,"description":"mode. can be enum['day','week','provider','service']","schema":{"type":"string","enum":["day","week","provider","service"],"description":"mode. can be day\/week\/provider\/service"}},{"name":"filter[upcoming_only]","in":"query","required":false,"description":"return upcoming bookings only","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[status]","in":"query","required":false,"description":"booking status. can be enum['confirmed','confirmed_pending','pending','canceled']","schema":{"type":"string","enum":["confirmed","confirmed_pending","pending","canceled"],"description":"booking status. can be confirmed\/confirmed_pending\/pending\/canceled"}},{"name":"filter[services]","in":"query","required":false,"description":"array of service ids to filter by services","schema":{"type":"array","items":{"type":"integer"},"description":"array of service ids to filter by services"}},{"name":"filter[providers]","in":"query","required":false,"description":"array of provider ids to filter by providers","schema":{"type":"array","items":{"type":"integer"},"description":"array of provider ids to filter by providers"}},{"name":"filter[client_id]","in":"query","required":false,"description":"client id to filter by","schema":{"type":"integer"}},{"name":"filter[date_from]","in":"query","required":false,"description":"filter by date from (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[date_to]","in":"query","required":false,"description":"filter by date to (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[search]","in":"query","required":false,"description":"search string (by code, client data)","schema":{"type":"string"}}]}},"\/admin\/detailed-report":{"post":{"tags":["booking"],"summary":"Generate new detailed report task","description":"Returns report generation task info<br>In POST parameters you can pass filter <a href=\"#model-accepts DetailedReportFilterEntity\">(accepts DetailedReportFilterEntity)<\/a> with following parameters:<br><b>code<\/b> Booking code<br><b>created_date_from<\/b> Created date from (YYYY-MM-DD format)<br><b>created_date_to<\/b> Created date to (YYYY-MM-DD format)<br><b>date_from<\/b> Date from (YYYY-MM-DD format)<br><b>date_to<\/b> Date to (YYYY-MM-DD format)<br><b>event_id<\/b> Service id<br><b>unit_group_id<\/b> Provider id<br><b>client_id<\/b> Client id<br><b>booking_type<\/b> one of: approved, non_approved_yet, cancelled_by_admin, cancelled_by_client, non_cancelled, cancelled, all\n\n**Return Description:** Report generation task id(s)","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"type":"integer"},"description":"Report generation task id(s)"}}}},"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_admin_detailed_report","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"export_columns":{"description":"export_columns object with columns to export","type":"object"},"order_direction":{"description":"asc or desc","type":"string"},"order_field":{"description":"field to order by","type":"string"},"filter":{"description":"filter object","$ref":"#\/components\/schemas\/DetailedReportFilterEntity"}}}}}}}},"\/admin\/detailed-report\/{id}":{"get":{"tags":["booking"],"summary":"Get report by id","description":"Return report info by id.<br>Throws AccessDenied error in case user does not have access to report.<br>Throws NotFound error in case report is not found.\n\n**Return Description:** Report information with details","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"type":"integer"},"description":"Report information with details"}}}},"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_admin_detailed_report_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : report id","schema":{"type":"string"}}]}},"\/admin\/medical-test\/status\/{id}":{"put":{"tags":["booking"],"summary":"Set medical test status for booking","description":"Allows to set medical test result status for booking (positive, negative or inconclusive)","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"}}}},"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":"put_admin_medical_test_status_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":{"status":{"description":"status (positive, negative, inconclusive)","type":"string"}}}}}}}},"\/admin\/clients":{"get":{"tags":["client"],"summary":"Get clients list","description":"Return clients list <a href=\"#model-AdminListClientEntity\">(AdminListClientEntity)<\/a>.<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass <b>page<\/b>, <b>on_page<\/b> and <b>filter<\/b> with following parameters:<br><b>search<\/b> - search string\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminListClientEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_clients","parameters":[{"name":"page","in":"query","required":false,"description":"page in list","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page","schema":{"type":"integer"}},{"name":"filter[search]","in":"query","required":false,"description":"search string","schema":{"type":"string"}}]},"post":{"tags":["client"],"summary":"Create client","description":"Create new client and return it.<br>Accepts <a href=\"#model-ClientEntity\">ClientEntity<\/a> data as body of request and returns <a href=\"#model-AdminClientEntity\">AdminClientEntity<\/a>.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.<br>Throws NotFound error in case client is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminClientEntity"}}}},"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_admin_clients","requestBody":{"required":true,"description":"client data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientEntity"}}}}}},"\/admin\/clients\/{id}":{"get":{"tags":["client"],"summary":"Get client","description":"Return client item <a href=\"#model-AdminClientEntity\">(AdminClientEntity)<\/a> by id.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws NotFound error in case client is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminClientEntity"}}}},"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_admin_clients_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client id","schema":{"type":"string"}}]},"put":{"tags":["client"],"summary":"Edit client","description":"Modify client by id and return it <a href=\"#model-AdminClientEntity\">(AdminClientEntity)<\/a>.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.<br>Throws NotFound error in case client is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminClientEntity"}}}},"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":"put_admin_clients_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client id","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"client data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ClientEntity"}}}}},"delete":{"tags":["client"],"summary":"Delete client","description":"Delete client by id. Return empty response<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws NotFound error in case client is not found.","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"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_admin_clients_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client id","schema":{"type":"string"}}]}},"\/admin\/clients\/{id}\/block":{"put":{"tags":["client"],"summary":"Block client","description":"Block client by id. Returns the updated client entity.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws BadRequest error in case client login plugin is not enabled.<br>Throws NotFound error in case client is not found or is deleted.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminClientEntity"}}}},"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":"put_admin_clients_item_block","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client id","schema":{"type":"string"}}]}},"\/admin\/clients\/{id}\/unblock":{"put":{"tags":["client"],"summary":"Unblock client","description":"Unblock client by id. Returns the updated client entity.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws BadRequest error in case client login plugin is not enabled.<br>Throws NotFound error in case client is not found or is deleted.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminClientEntity"}}}},"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":"put_admin_clients_item_unblock","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client id","schema":{"type":"string"}}]}},"\/admin\/clients\/memberships":{"get":{"tags":["client"],"summary":"Get client memberships list","description":"Return client membership list <a href=\"#model-AdminClientMembershipPaymentEntity\">(AdminClientMembershipPaymentEntity)<\/a>.<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass <b>page<\/b>, <b>on_page<\/b> and <b>filter<\/b> with following parameters:<br><b>client_id<\/b> - client id<br><b>service_id<\/b> - service id<br><b>service_start_date<\/b> - booking start date (to filter actual memberships only) (YYYY-MM-DD format)<br><b>count<\/b> - group bookings count<br><b>active_only<\/b> - active memberships only<br><b>search<\/b> - search string\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/AdminClientMembershipPaymentEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_clients_memberships","parameters":[{"name":"page","in":"query","required":false,"description":"page in list","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page","schema":{"type":"integer"}},{"name":"filter[client_id]","in":"query","required":false,"description":"client id","schema":{"type":"integer"}},{"name":"filter[service_id]","in":"query","required":false,"description":"service id","schema":{"type":"integer"}},{"name":"filter[service_start_date]","in":"query","required":false,"description":"booking start date to filter actual memberships only (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[count]","in":"query","required":false,"description":"group bookings count","schema":{"type":"integer"}},{"name":"filter[active_only]","in":"query","required":false,"description":"active memberships only","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[search]","in":"query","required":false,"description":"search string","schema":{"type":"string"}}]}},"\/admin\/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>You can also use 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_admin_clients_fields"}},"\/admin\/clients\/field-values\/{id}":{"get":{"tags":["client"],"summary":"Get client fields values","description":"Returns client fields values list <a href=\"#model-Client_DetailsEntity\">(Client_DetailsEntity)<\/a>, including name, email, phone and address fields.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws NotFound error in case client is not found.<br>You can also use Client fields custom feature.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client_DetailsEntity"}}}},"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_admin_clients_field_values_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client id","schema":{"type":"string"}}]},"put":{"tags":["client"],"summary":"Edit client with fields","description":"Modify client data from fields list and return updated client <a href=\"#model-Client_DetailsEntity\">(Client_DetailsEntity)<\/a>.<br>Returns client fields list, including name, email and phone field.<br>Note: name and email are required; phone may also be required depending on company settings.<br>You can also use Client fields custom feature.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws NotFound error in case client is not found.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.<br><br>For each field in the \"fields\" array, use the field <b>name<\/b> (not numeric id) as the identifier.<br>For built-in fields use: \"name\", \"email\", \"phone\". For custom fields use the UUID name from GET \/admin\/clients\/fields.<br>Example: {\"fields\": [{\"name\": \"email\", \"value\": \"user@example.com\"}, {\"name\": \"fa27a8fc098...\", \"value\": \"custom value\"}]}\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client_DetailsEntity"}}}},"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":"put_admin_clients_field_values_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client id","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"client data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client_EditDetailsEntity"}}}}}},"\/admin\/clients\/field-values":{"post":{"tags":["client"],"summary":"Make client with fields","description":"Makes new client from fields list and returns it <a href=\"#model-Client_DetailsEntity\">(Client_DetailsEntity)<\/a>.<br>Returns client fields list, including name, email and phone field.<br>Note: name and email are required; phone may also be required depending on company settings.<br>You can also use Client fields custom feature.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.<br><br>For each field in the \"fields\" array, use the field <b>name<\/b> (not numeric id) as the identifier.<br>For built-in fields use: \"name\", \"email\", \"phone\". For custom fields use the UUID name from GET \/admin\/clients\/fields.<br>Example: {\"fields\": [{\"name\": \"email\", \"value\": \"user@example.com\"}, {\"name\": \"fa27a8fc098...\", \"value\": \"custom value\"}]}\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client_DetailsEntity"}}}},"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_admin_clients_field_values","requestBody":{"required":true,"description":"client data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client_EditDetailsEntity"}}}}}},"\/admin\/services":{"get":{"tags":["service"],"summary":"Get services list","description":"Return services list <a href=\"#model-ServiceEntity\">(ServiceEntity)<\/a>.<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass filter  with following parameters:<br><b>search<\/b> - search string\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\/ServiceEntity"}},"metadata":{"$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_services","parameters":[{"name":"filter[search]","in":"query","required":false,"description":"search string","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"}}]},"post":{"tags":["service"],"summary":"Create a new service.","description":"Creates a new service <a href=\"#model-ServiceEntity\">(ServiceEntity)<\/a> using the provided data.<br>Accepts a <a href=\"#model-ServiceWriteableEntity\">ServiceWriteableEntity<\/a> object in the request body.<br>Please note that this is a simple create service method and does not support all available settings for a service.<br>Throws BadRequest error if the provided data is invalid.<br>Throws AccessDenied error if the user does not have access to create a service.\n\n**Return Description:** The created service entity.","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServiceEntity"}}}},"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: If the provided data is invalid.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: If the user does not have access to create a service.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_services","requestBody":{"required":true,"description":"Service data to create a new service.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServiceWriteableEntity"}}}}}},"\/admin\/services\/{id}":{"get":{"tags":["service"],"summary":"Get service","description":"Return service item <a href=\"#model-ServiceEntity\">(ServiceEntity)<\/a> by id.<br>Throws AccessDenied error in case user does not have access to service.<br>Throws NotFound error in case service is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServiceEntity"}}}},"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_admin_services_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : service id","schema":{"type":"string"}}]},"put":{"tags":["service"],"summary":"Update an existing service.","description":"Updates the details of an existing service <a href=\"#model-ServiceEntity\">(ServiceEntity)<\/a> identified by its ID.<br>Accepts a <a href=\"#model-ServiceWriteableEntity\">ServiceWriteableEntity<\/a> object in the request body.<br>Please note that this is a simple update service method and does not support all available settings for a service.<br>Throws BadRequest error if the provided data is invalid.<br>Throws NotFound error if the service does not exist.<br>Throws AccessDenied error if the user does not have access to update the service.\n\n**Return Description:** The updated service entity.","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServiceEntity"}}}},"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: If the provided data is invalid.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found: If the service does not exist.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: If the user does not have access to update the service.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"put_admin_services_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : The ID of the service to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Service data to update the service.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServiceWriteableEntity"}}}}},"delete":{"tags":["service"],"summary":"Delete a service.","description":"Deletes a service by its ID.<br>Throws NotFound error in case the service is not found.<br>Throws AccessDenied error in case user does not have access to delete the service.\n\n**Return Description:** Success response with a success flag.","responses":{"201":{"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":"delete_admin_services_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : Service ID to delete.","schema":{"type":"string"}}]}},"\/admin\/services\/products":{"get":{"tags":["service"],"summary":"Get products\/attributes for service","description":"Return list of products and attributes with default qty for selected service <a href=\"#model-Service_ProductEntity\">(Service_ProductEntity)<\/a>.<br>Used for Products for sale and Service add-ons custom features.<br>In GET parameters you can pass filter  with following parameters:<br><b>service_id<\/b> - service id<br><b>type<\/b> - type. can be 'product'\/'attribute'\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Service_ProductEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_services_products","parameters":[{"name":"filter[service_id]","in":"query","required":false,"description":"service id","schema":{"type":"string"}},{"name":"filter[type]","in":"query","required":false,"description":"type. can be enum['product','attribute']","schema":{"type":"string","enum":["product","attribute"],"description":"type. can be product\/attribute"}}]}},"\/admin\/categories":{"get":{"tags":["service"],"summary":"Get service categories list","description":"Return list of categories <a href=\"#model-CategoryEntity\">(CategoryEntity)<\/a>. (categories custom feature)<br>Please note that result is wrapped into paginated result.\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\/CategoryEntity"}},"metadata":{"$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_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"}}]}},"\/admin\/providers":{"get":{"tags":["provider"],"summary":"Get providers list","description":"Return providers list <a href=\"#model-ProviderEntity\">(ProviderEntity)<\/a>.<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass filter  with following parameters:<br><b>search<\/b> - search string<br><b>service_id<\/b> - filter providers by service (only providers that can provide this 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\/ProviderEntity"}},"metadata":{"$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_providers","parameters":[{"name":"filter[search]","in":"query","required":false,"description":"search string","schema":{"type":"string"}},{"name":"filter[service_id]","in":"query","required":false,"description":"filter providers by service (only providers that can provide this service)","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":["provider"],"summary":"Create a provider","description":"Creates a new provider <a href=\"#model-ProviderEntity\">(ProviderEntity)<\/a> using the provided data.<br>Accepts a <a href=\"#model-ProviderWritableEntity\">ProviderWritableEntity<\/a> object in the request body.<br>Please note that this is simple create provider methods and does not support all available settings for provider.<br>Throws BadRequest error if the provided data is invalid.\n\n**Return Description:** The created provider entity.","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"}}}},"400":{"description":"Bad request: If the provided data is invalid.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: If the user does not have access to create a provider.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_providers","requestBody":{"required":true,"description":"Provider data to create a new provider.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProviderWritableEntity"}}}}}},"\/admin\/providers\/{id}":{"get":{"tags":["provider"],"summary":"Get provider","description":"Return provider item <a href=\"#model-ProviderEntity\">(ProviderEntity)<\/a> by id.<br>Throws AccessDenied error in case user does not have access to provider.<br>Throws NotFound error in case provider is not found.\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"}}}},"400":{"description":"Bad request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_providers_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : provider id","schema":{"type":"string"}}]},"put":{"tags":["provider"],"summary":"Update a provider","description":"Updates the details of an existing provider <a href=\"#model-ProviderEntity\">(ProviderEntity)<\/a> identified by its ID.<br>Accepts a <a href=\"#model-ProviderWritableEntity\">ProviderWritableEntity<\/a> object in the request body.<br>Please note that this is simple update provider methods and does not support all available settings for provider.<br>Throws BadRequest error if the provided data is invalid.\n\n**Return Description:** The updated provider entity.","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"}}}},"400":{"description":"Bad request: If the provided data is invalid.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"put_admin_providers_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : The ID of the provider to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Provider data to update the provider.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProviderWritableEntity"}}}}},"delete":{"tags":["provider"],"summary":"Delete a provider","description":"Deletes an existing provider identified by its ID.<br>Throws NotFound error if the provider does not exist.\n\n**Return Description:** Empty response on successful deletion","responses":{"201":{"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: If the provider does not exist.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: If the user does not have access to delete the provider.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_admin_providers_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : The ID of the provider to delete.","schema":{"type":"string"}}]}},"\/admin\/locations":{"get":{"tags":["provider"],"summary":"Get provider locations list","description":"Return list of locations <a href=\"#model-LocationEntity\">LocationEntity<\/a>. (locations custom feature)<br>Please note that result is wrapped into paginated result.\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\/LocationEntity"}},"metadata":{"$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_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"}}]},"post":{"tags":["provider"],"summary":"Create a location","description":"Creates a new location using the provided data.<br>Accepts a <a href=\"#model-LocationEntity\">LocationEntity<\/a> object in the request body.<br>Throws BadRequest error if the provided data is invalid.\n\n**Return Description:** The created location entity.","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"}}}},"400":{"description":"Bad request: If the provided data is invalid.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: If the user does not have access to create a location.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_locations","requestBody":{"required":true,"description":"Location data to create a new location.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/LocationEntity"}}}}}},"\/admin\/locations\/{id}":{"get":{"tags":["provider"],"summary":"Get location","description":"Return location item by id.<br>Throws NotFound error in case location is not found.\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"}}}},"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_admin_locations_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : location id","schema":{"type":"string"}}]},"put":{"tags":["provider"],"summary":"Update a location","description":"Updates the details of an existing location identified by its ID.<br>Accepts a <a href=\"#model-LocationEntity\">LocationEntity<\/a> object in the request body.<br>Throws BadRequest error if the provided data is invalid.\n\n**Return Description:** The updated location entity.","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"}}}},"400":{"description":"Bad request: If the provided data is invalid.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"404":{"description":"Not found: If the location does not exist.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"put_admin_locations_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : The ID of the location to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Location data to update the location.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/LocationEntity"}}}}},"delete":{"tags":["provider"],"summary":"Delete a location","description":"Deletes an existing location identified by its ID.\n\n**Return Description:** Empty body with HTTP 200 on success.","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"}}}},"400":{"description":"Bad request: If the location cannot be deleted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}},"403":{"description":"Access denied: If the user does not have access to delete the location.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_admin_locations_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : The ID of the location to delete.","schema":{"type":"string"}}]}},"\/admin\/additional-fields":{"get":{"tags":["intake_forms"],"summary":"Get additional fields list","description":"Return intake forms fields <a href=\"#model-AdditionalFieldEntity\">(AdditionalFieldEntity)<\/a>. (intake forms custom feature)<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass filter  with following parameters:<br><b>service_id<\/b> - return fields for this 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\/AdditionalFieldEntity"}},"metadata":{"$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_additional_fields","parameters":[{"name":"filter[service_id]","in":"query","required":false,"description":"return fields for this service","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"}}]}},"\/admin\/products":{"get":{"tags":["products"],"summary":"Get products\/attributes list","description":"Return products\/attributes list <a href=\"#model-ProductEntity\">(ProductEntity)<\/a>. (products\/service addons custom features)<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass filter  with following parameters:<br><b>service_id<\/b> - return products\/attributes for selected service<br><b>search<\/b> - search string<br><b>type<\/b> - product type. can be 'product' or 'attribute'<br><b>visible_only<\/b> - visible products only\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\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_products","parameters":[{"name":"filter[service_id]","in":"query","required":false,"description":"return products\/attributes for selected service","schema":{"type":"integer"}},{"name":"filter[search]","in":"query","required":false,"description":"search string","schema":{"type":"string"}},{"name":"filter[type]","in":"query","required":false,"description":"product type. can be enum['product','attribute']","schema":{"type":"string","enum":["product","attribute"],"description":"product type. can be product\/attribute"}},{"name":"filter[visible_only]","in":"query","required":false,"description":"visible products only","schema":{"type":"integer","enum":[0,1]}},{"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"}}]}},"\/admin\/products\/{id}":{"get":{"tags":["products"],"summary":"Get product\/attribute item","description":"Return product\/attribute item <a href=\"#model-ProductEntity\">(ProductEntity)<\/a> by id.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$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"}}}},"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_admin_products_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id`","schema":{"type":"string"}}]}},"\/admin\/statuses":{"get":{"tags":["status"],"summary":"Get statuses list","description":"Return user statuses list <a href=\"#model-StatusEntity\">(StatusEntity)<\/a> (status custom feature)\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/StatusEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_statuses"}},"\/admin\/calendar-notes":{"get":{"tags":["notes"],"summary":"Get notes list","description":"Return notes list <a href=\"#model-CalendarNoteEntity\">(CalendarNoteEntity)<\/a>.<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass <b>page<\/b>, <b>on_page<\/b> and <b>filter<\/b> with following parameters:<br><b>providers<\/b> - filter by providers. array of providers ids<br><b>services<\/b> - filter by services. array of services ids<br><b>types<\/b> - filter by note types. array of types ids<br><b>search<\/b> - search string<br><b>date_from<\/b> - date from (YYYY-MM-DD format)<br><b>date_to<\/b> - date to (YYYY-MM-DD format)\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\/CalendarNoteEntity"}},"metadata":{"$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_calendar_notes","parameters":[{"name":"page","in":"query","required":false,"description":"page in list","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page","schema":{"type":"integer"}},{"name":"filter[providers]","in":"query","required":false,"description":"array of provider ids to filter by providers","schema":{"type":"array","items":{"type":"integer"},"description":"array of provider ids to filter by providers"}},{"name":"filter[services]","in":"query","required":false,"description":"array of service ids to filter by services","schema":{"type":"array","items":{"type":"integer"},"description":"array of service ids to filter by services"}},{"name":"filter[types]","in":"query","required":false,"description":"array of note type ids to filter by types","schema":{"type":"array","items":{"type":"integer"},"description":"array of note type ids to filter by types"}},{"name":"filter[search]","in":"query","required":false,"description":"search string","schema":{"type":"string"}},{"name":"filter[date_from]","in":"query","required":false,"description":"date from (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[date_to]","in":"query","required":false,"description":"date to (YYYY-MM-DD format)","schema":{"type":"string"}}]},"post":{"tags":["notes"],"summary":"Create new note","description":"Create new note and return it.<br>Accepts <a href=\"#model-CalendarNoteRequestEntity\">CalendarNoteRequestEntity<\/a> data as body of request and returns <a href=\"#model-CalendarNoteEntity\">CalendarNoteEntity<\/a>.<br>Throws AccessDenied error in case user does not have access to the calendar note.<br>Throws NotFound error in case the calendar note is not found.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CalendarNoteEntity"}}}},"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_admin_calendar_notes","requestBody":{"required":true,"description":"calendar note","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CalendarNoteRequestEntity"}}}}}},"\/admin\/calendar-notes\/{id}":{"get":{"tags":["notes"],"summary":"Get note details","description":"Return note details <a href=\"#model-CalendarNoteEntity\">(CalendarNoteEntity)<\/a> by id<br>Throws AccessDenied error in case user does not have access to the calendar note.<br>Throws NotFound error in case the calendar note is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CalendarNoteEntity"}}}},"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_admin_calendar_notes_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : calendar note id","schema":{"type":"string"}}]},"put":{"tags":["notes"],"summary":"Edit note","description":"Edit note and return it.<br>Accepts <a href=\"#model-CalendarNoteRequestEntity\">CalendarNoteRequestEntity<\/a> data as body of request and returns <a href=\"#model-CalendarNoteEntity\">CalendarNoteEntity<\/a>.<br>Throws AccessDenied error in case user does not have access to the calendar note.<br>Throws NotFound error in case the calendar note is not found.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CalendarNoteEntity"}}}},"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":"put_admin_calendar_notes_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : calendar note id","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"calendar note","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CalendarNoteRequestEntity"}}}}},"delete":{"tags":["notes"],"summary":"Delete calendar note","description":"Delete calendar note by id. Return empty response<br>Throws AccessDenied error in case user does not have access to calendar note.<br>Throws NotFound error in case calendar note is not found.","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"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_admin_calendar_notes_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : calendar note id","schema":{"type":"string"}}]}},"\/admin\/calendar-notes\/types":{"get":{"tags":["notes"],"summary":"Get note types list","description":"Return array of note types <a href=\"#model-CalendarNoteTypeEntity\">(CalendarNoteTypeEntity)<\/a>.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/CalendarNoteTypeEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_calendar_notes_types"}},"\/admin\/calendar-notes\/types\/default":{"get":{"tags":["notes"],"summary":"Get default note type","description":"Return default note type object <a href=\"#model-CalendarNoteTypeEntity\">(CalendarNoteTypeEntity)<\/a>.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CalendarNoteTypeEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_calendar_notes_types_default"}},"\/admin\/invoices":{"get":{"tags":["payments"],"summary":"Get orders\/invoices list","description":"Return orders and invoices list <a href=\"#model-AdminInvoiceEntity\">(AdminInvoiceEntity)<\/a>.<br>Note that not all data can be presented in list result. To get full info you need to get separate item.<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass <b>page<\/b>, <b>on_page<\/b> and <b>filter<\/b> with following parameters:<br><b>client_id<\/b> - client id<br><b>datetime_from<\/b> - order\/invoice date and time from (YYYY-MM-DD format)<br><b>datetime_to<\/b> - order\/invoice date and time to (YYYY-MM-DD format)<br><b>status<\/b> - order\/invoice status<br><b>booking_code<\/b> - filter by booking code\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\/AdminInvoiceEntity"}},"metadata":{"$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_invoices","parameters":[{"name":"page","in":"query","required":false,"description":"page in list","schema":{"type":"integer"}},{"name":"on_page","in":"query","required":false,"description":"items per page","schema":{"type":"integer"}},{"name":"filter[client_id]","in":"query","required":false,"description":"client id","schema":{"type":"integer"}},{"name":"filter[datetime_from]","in":"query","required":false,"description":"order\/invoice date and time from (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[datetime_to]","in":"query","required":false,"description":"order\/invoice date and time to (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[status]","in":"query","required":false,"description":"order\/invoice status","schema":{"type":"string"}},{"name":"filter[booking_code]","in":"query","required":false,"description":"filter by booking code","schema":{"type":"string"}}]}},"\/admin\/invoices\/{id}":{"get":{"tags":["payments"],"summary":"Get order\/invoice item","description":"Return order\/invoice item <a href=\"#model-AdminInvoiceEntity\">(AdminInvoiceEntity)<\/a> by id\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminInvoiceEntity"}}}},"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_admin_invoices_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : invoice\/order id","schema":{"type":"string"}}]}},"\/admin\/invoices\/{id}\/link":{"get":{"tags":["payments"],"summary":"Get order\/invoice page url","description":"Return order\/invoice page url\n\n**Return Description:** Invoice print link URL","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_admin_invoices_item_link","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : invoice\/order id","schema":{"type":"string"}}]}},"\/admin\/invoices\/{id}\/accept-payment":{"put":{"tags":["payments"],"summary":"Accept payment","description":"Manual accept payment. The order <a href=\"#model-AdminInvoiceEntity\">(AdminInvoiceEntity)<\/a> will be marked as paid with provided payment processor.<br>You can pass <b>payment_processor<\/b> as GET parameter and in body of request.<br>Throws AccessDenied error in case user does not have access to order.<br>Throws BadRequest error in case invalid data was provided with detailed errors.<br>Throws NotFound error in case order\/invoice is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminInvoiceEntity"}}}},"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":"put_admin_invoices_item_accept_payment","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : order id","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"payment_processor":{"description":"payment processor","type":"string"}}}}}}}},"\/admin\/invoices\/{id}\/rebill":{"put":{"tags":["payments"],"summary":"Accept payment with saved payment method","description":"Accept payment with client saved payment method.<br>The order will be marked as paid only after confirmation from payment system.<br>You have to pass order_id as URL path parameter (id) and payment_method_id in body of request.<br>Throws AccessDenied error in case user does not have access to order.<br>Throws BadRequest error in case invalid data was provided with detailed errors.<br>Throws NotFound error in case order\/invoice is not found.\n\n**Return Description:** empty message","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"}}}},"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":"put_admin_invoices_item_rebill","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : order id (URL path parameter)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"payment_method_id":{"description":"payment method id (request body)","type":"integer"}}}}}}}},"\/admin\/invoices\/{id}\/payment-link":{"get":{"tags":["payments"],"summary":"Get payment link","description":"Generates payment link for order\/invoice.<br>Throws AccessDenied error in case user does not have access to order.<br>Throws BadRequest error in case invalid data was provided with detailed errors.<br>Throws NotFound error in case order\/invoice is not found.","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"}}}},"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_admin_invoices_item_payment_link","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : order id","schema":{"type":"string"}}]}},"\/admin\/invoices\/{id}\/send-payment-link":{"put":{"tags":["payments"],"summary":"Send payment link","description":"Generates payment link and send to customer.<br>You have to pass order_id as URL path parameter (id) and type (email\/sms) as query parameter or in body of request.<br>Throws AccessDenied error in case user does not have access to order.<br>Throws BadRequest error in case invalid data was provided with detailed errors.<br>Throws NotFound error in case order\/invoice is not found.\n\n**Return Description:** payment link","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"}}}},"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":"put_admin_invoices_item_send_payment_link","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : order id (URL path parameter)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"description":"message type. can be email\/sms (query parameter or request body)","type":"string","enum":["email","sms"]}}}}}}}},"\/admin\/invoices\/{id}\/apply-promo-code":{"put":{"tags":["payments"],"summary":"Apply promo code","description":"Apply promo code to order\/invoice and return updated invoice <a href=\"#model-AdminInvoiceEntity\">AdminInvoiceEntity<\/a>. Coupons & Gift Cards custom feature.<br>You can apply promo code only to pending and new orders.<br>You have to pass order_id as URL path parameter (id) and code as query parameter or in body of request.<br>Throws AccessDenied error in case user does not have access to order.<br>Throws BadRequest error in case invalid data was provided with detailed errors.<br>Throws NotFound error in case order\/invoice is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminInvoiceEntity"}}}},"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":"put_admin_invoices_item_apply_promo_code","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : order id (URL path parameter)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"code":{"description":"promo code (query parameter or request body)","type":"string"}}}}}}}},"\/admin\/invoices\/{id}\/promo-code\/{instanceId}":{"delete":{"tags":["payments"],"summary":"Remove applied promo code","description":"Remove applied promo code from order\/invoice and return updated invoice <a href=\"#model-AdminInvoiceEntity\">(AdminInvoiceEntity)<\/a>. Coupons & Gift Cards custom feature.<br>You can remove promo code only from pending and new orders.<br>Both order_id and instanceId are passed as URL path parameters.<br>Throws AccessDenied error in case user does not have access to order.<br>Throws BadRequest error in case invalid data was provided with detailed errors.<br>Throws NotFound error in case order\/invoice is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminInvoiceEntity"}}}},"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":"delete_admin_invoices_item_promo_code_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : order id (URL path parameter)","schema":{"type":"string"}},{"name":"instanceId","in":"path","required":true,"description":"Path parameter `instanceId` : promo code instance id (URL path parameter)","schema":{"type":"string"}}]}},"\/admin\/invoices\/{id}\/tip":{"put":{"tags":["payments"],"summary":"Apply tip","description":"Apply tip to order\/invoice and return updated invoice <a href=\"#model-AdminInvoiceEntity\">(AdminInvoiceEntity)<\/a>. Tips custom feature.<br>You can apply tip only to pending and new orders.<br>You have to pass order_id as URL path parameter (id) and percent or amount as query parameter or in body of request.<br>Throws AccessDenied error in case user does not have access to order.<br>Throws BadRequest error in case invalid data was provided with detailed errors.<br>Throws NotFound error in case order\/invoice is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminInvoiceEntity"}}}},"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":"put_admin_invoices_item_tip","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : order id (URL path parameter)","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"percent":{"description":"tip percent (query parameter or request body)","type":"integer"},"amount":{"description":"tip amount (query parameter or request body)","type":"number","format":"float"}}}}}}},"delete":{"tags":["payments"],"summary":"Remove applied tip","description":"Remove applied tip from order\/invoice and return updated invoice <a href=\"#model-AdminInvoiceEntity\">(AdminInvoiceEntity)<\/a>. Tips custom feature.<br>You can remove tip only from pending and new orders.<br>Throws AccessDenied error in case user does not have access to order.<br>Throws BadRequest error in case invalid data was provided with detailed errors.<br>Throws NotFound error in case order\/invoice is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminInvoiceEntity"}}}},"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":"delete_admin_invoices_item_tip","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id`","schema":{"type":"string"}}]}},"\/admin\/invoices\/{id}\/make-terminal-payment":{"post":{"tags":["payments"],"summary":"Make payment with terminal","description":"Initiates a terminal (card reader) payment for the given order.<br>Marks the invoice as pending and delegates payment to the terminal via the configured payment system.<br>Throws AccessDenied if user does not have access to the invoice.<br>Throws BadRequest if the invoice has already been processed or payment system returns an error.\n\n**Return Description:** Terminal payment response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"type":"integer"},"description":"Terminal payment response data"}}}},"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_admin_invoices_item_make_terminal_payment","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : order id","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"paymentSystem":{"description":"payment system","type":"string"},"readerId":{"description":"reader id","type":"string"}}}}}}}},"\/admin\/invoices\/terminal\/reader\/list":{"get":{"tags":["payments"],"summary":"Get terminal readers cross payment systems","description":"Returns a list of available terminal readers across all configured payment systems.<br>Throws AccessDenied if user does not have access to invoice management.<br>Throws BadRequest if the payment system returns an error.\n\n**Return Description:** List of available terminal readers","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"type":"integer"},"description":"List of available terminal readers"}}}},"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":"get_admin_invoices_terminal_reader_list"}},"\/admin\/invoices\/terminal\/stripe-connection-token":{"post":{"tags":["payments"],"summary":"Create stripe connection token","description":"Creates (or fetches) a Stripe connection token that the client (or terminal SDK)<br>can use to talk to a Stripe reader via SBPay infrastructure.","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"}}}}},"operationId":"post_admin_invoices_terminal_stripe_connection_token"}},"\/admin\/invoices\/terminal\/stripe-config-location":{"get":{"tags":["payments"],"summary":"Get stripe terminal location from config","description":"Retrieves the configured Stripe Terminal location (or location settings)<br>stored in your system for the given company context.","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"}}}}},"operationId":"get_admin_invoices_terminal_stripe_config_location"}},"\/admin\/invoices\/{id}\/package":{"post":{"tags":["payments"],"summary":"Apply package instance to invoice","description":"Apply a package instance credit to an invoice. Packages custom feature.<br>The package instance must be active and have remaining credits for the booked service.<br>Throws AccessDenied if user does not have access to the invoice.<br>Throws BadRequest if the package instance cannot be used (expired, fully used, wrong service).<br>Throws NotFound if the invoice is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminInvoiceEntity"}}}},"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_admin_invoices_item_package","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","type":"integer"}}}}}}}},"\/admin\/invoices\/{id}\/package\/{instanceId}":{"delete":{"tags":["payments"],"summary":"Remove package instance from invoice","description":"Remove a previously applied package instance from an invoice. Packages custom feature.<br>Throws AccessDenied if user does not have access to the invoice.<br>Throws NotFound if the invoice is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminInvoiceEntity"}}}},"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_admin_invoices_item_package_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : invoice id","schema":{"type":"string"}},{"name":"instanceId","in":"path","required":true,"description":"Path parameter `instanceId` : package instance id","schema":{"type":"string"}}]}},"\/admin\/payment-methods\/{id}":{"get":{"tags":["payments"],"summary":"Get client saved payment methods list","description":"Returns array of client saved payment methods <a href=\"#model-PaymentMethodEntity\">(PaymentMethodEntity)<\/a>.<br>The <b>id<\/b> is client id and it is required.\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"}}}}},"operationId":"get_admin_payment_methods_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client id","schema":{"type":"string"}}]}},"\/admin\/tickets\/{code}":{"get":{"tags":["tickets"],"summary":"Get ticket info by code","description":"Return ticket info <a href=\"#model-AdminTicketEntity\">(AdminTicketEntity)<\/a> by code (Tickets custom feature).<br>Throws AccessDenied error in case user does not have access to ticket.<br>Throws NotFound error in case ticket is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminTicketEntity"}}}},"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_admin_tickets_item","parameters":[{"name":"code","in":"path","required":true,"description":"Path parameter `code` : ticket code","schema":{"type":"string"}}]}},"\/admin\/tickets\/{code}\/check-in":{"put":{"tags":["tickets"],"summary":"Check in ticket","description":"Check in ticket by code and return the ticket info <a href=\"#model-AdminTicketEntity\">(AdminTicketEntity)<\/a>.<br>Please note that the reason of unavailable check in will be in ticket object.<br>Throws AccessDenied error in case user does not have access to ticket.<br>Throws NotFound error in case ticket is not found.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminTicketEntity"}}}},"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":"put_admin_tickets_item_check_in","parameters":[{"name":"code","in":"path","required":true,"description":"Path parameter `code` : ticket code","schema":{"type":"string"}}]}},"\/admin\/promotions":{"get":{"tags":["promotions"],"summary":"Get promotions list","description":"Return promotions list <a href=\"#model-PromotionEntity\">(PromotionEntity)<\/a>. (Coupons & Gift cards custom feature)<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass filter  with following parameters:<br><b>service_id<\/b> - filter by service<br><b>visible_only<\/b> - visible only promotions<br><b>promotion_type<\/b> - gift_card\/discount\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\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_promotions","parameters":[{"name":"filter[service_id]","in":"query","required":false,"description":"filter by service","schema":{"type":"integer"}},{"name":"filter[visible_only]","in":"query","required":false,"description":"visible only promotions","schema":{"type":"integer","enum":[0,1]}},{"name":"filter[promotion_type]","in":"query","required":false,"description":"promotion type. can be enum['gift_card','discount']","schema":{"type":"string","enum":["gift_card","discount"],"description":"promotion type. can be gift_card\/discount"}},{"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"}}]}},"\/admin\/promotions\/gift-cards":{"get":{"tags":["promotions"],"summary":"Get gift cards list","description":"Return promotion instances list <a href=\"#model-PromotionInstanceEntity\">(PromotionInstanceEntity)<\/a>. (Coupons & Gift cards custom feature)<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass filter  with following parameters:<br><b>purchased_by_client_id<\/b> - filter by client who purchased gift card<br><b>used_by_client_id<\/b> - filter by client who used gift card<br><b>service_id<\/b> - filter by service<br><b>user_id<\/b> - user, who issued gift card<br><b>duration<\/b> - duration<br><b>duration_type<\/b> - duration type<br><b>price_from<\/b> - gift card price from<br><b>price_to<\/b> - gift card price to<br><b>status<\/b> - filter by status (outdated, used, disabled, valid)<br><b>expired_date_from<\/b> - expired date from (YYYY-MM-DD format)<br><b>expired_date_to<\/b> - expired date to (YYYY-MM-DD format)<br><b>start_date_from<\/b> - start date from (YYYY-MM-DD format)<br><b>start_date_to<\/b> - start date to (YYYY-MM-DD format)<br><b>discount_from<\/b> - discount from<br><b>discount_to<\/b> - discount to<br><b>used_amount_from<\/b> - used amount from<br><b>used_amount_to<\/b> - used amount to<br><b>code<\/b> - filter by code\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\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_promotions_gift_cards","parameters":[{"name":"filter[purchased_by_client_id]","in":"query","required":false,"description":"filter by client who purchased gift card","schema":{"type":"integer"}},{"name":"filter[used_by_client_id]","in":"query","required":false,"description":"filter by client who used gift card","schema":{"type":"integer"}},{"name":"filter[service_id]","in":"query","required":false,"description":"filter by service","schema":{"type":"integer"}},{"name":"filter[user_id]","in":"query","required":false,"description":"user who issued gift card","schema":{"type":"integer"}},{"name":"filter[duration]","in":"query","required":false,"description":"duration","schema":{"type":"integer"}},{"name":"filter[duration_type]","in":"query","required":false,"description":"duration type","schema":{"type":"string"}},{"name":"filter[price_from]","in":"query","required":false,"description":"gift card price from","schema":{"type":"number","format":"float"}},{"name":"filter[price_to]","in":"query","required":false,"description":"gift card price to","schema":{"type":"number","format":"float"}},{"name":"filter[status]","in":"query","required":false,"description":"filter by status. can be enum['outdated','used','disabled','valid']","schema":{"type":"string","enum":["outdated","used","disabled","valid"],"description":"filter by status. can be outdated\/used\/disabled\/valid"}},{"name":"filter[expired_date_from]","in":"query","required":false,"description":"expired date from (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[expired_date_to]","in":"query","required":false,"description":"expired date to (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[start_date_from]","in":"query","required":false,"description":"start date from (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[start_date_to]","in":"query","required":false,"description":"start date to (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[discount_from]","in":"query","required":false,"description":"discount from","schema":{"type":"number","format":"float"}},{"name":"filter[discount_to]","in":"query","required":false,"description":"discount to","schema":{"type":"number","format":"float"}},{"name":"filter[used_amount_from]","in":"query","required":false,"description":"used amount from","schema":{"type":"number","format":"float"}},{"name":"filter[used_amount_to]","in":"query","required":false,"description":"used amount to","schema":{"type":"number","format":"float"}},{"name":"filter[code]","in":"query","required":false,"description":"filter by code","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"}}]}},"\/admin\/promotions\/coupons":{"get":{"tags":["promotions"],"summary":"Get coupons list","description":"Return promotion instances list <a href=\"#model-PromotionInstanceEntity\">(PromotionInstanceEntity)<\/a>. (Coupons & Gift cards custom feature)<br>Please note that result is wrapped into paginated result.<br>In GET parameters you can pass filter (see http example) with following parameters:<br><b>used_by_client_id<\/b> - filter by client who used coupon<br><b>service_id<\/b> - filter by service<br><b>user_id<\/b> - user, who issued coupon<br><b>duration<\/b> - duration<br><b>duration_type<\/b> - duration type<br><b>status<\/b> - filter by status (outdated, used, disabled, valid)<br><b>expired_date_from<\/b> - expired date from (YYYY-MM-DD format)<br><b>expired_date_to<\/b> - expired date to (YYYY-MM-DD format)<br><b>start_date_from<\/b> - start date from (YYYY-MM-DD format)<br><b>start_date_to<\/b> - start date to (YYYY-MM-DD format)<br><b>discount_from<\/b> - discount from<br><b>discount_to<\/b> - discount to<br><b>code<\/b> - filter by code\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\/AdminListMetadataEntity"}}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_promotions_coupons","parameters":[{"name":"filter[used_by_client_id]","in":"query","required":false,"description":"filter by client who used coupon","schema":{"type":"integer"}},{"name":"filter[service_id]","in":"query","required":false,"description":"filter by service","schema":{"type":"integer"}},{"name":"filter[user_id]","in":"query","required":false,"description":"user who issued coupon","schema":{"type":"integer"}},{"name":"filter[duration]","in":"query","required":false,"description":"duration","schema":{"type":"integer"}},{"name":"filter[duration_type]","in":"query","required":false,"description":"duration type","schema":{"type":"string"}},{"name":"filter[status]","in":"query","required":false,"description":"filter by status. can be enum['outdated','used','disabled','valid']","schema":{"type":"string","enum":["outdated","used","disabled","valid"],"description":"filter by status. can be outdated\/used\/disabled\/valid"}},{"name":"filter[expired_date_from]","in":"query","required":false,"description":"expired date from (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[expired_date_to]","in":"query","required":false,"description":"expired date to (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[start_date_from]","in":"query","required":false,"description":"start date from (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[start_date_to]","in":"query","required":false,"description":"start date to (YYYY-MM-DD format)","schema":{"type":"string"}},{"name":"filter[discount_from]","in":"query","required":false,"description":"discount from","schema":{"type":"number","format":"float"}},{"name":"filter[discount_to]","in":"query","required":false,"description":"discount to","schema":{"type":"number","format":"float"}},{"name":"filter[code]","in":"query","required":false,"description":"filter by code","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"}}]}},"\/admin\/promotions\/issue-gift-card":{"post":{"tags":["promotions"],"summary":"Issue gift card","description":"Allows issuing both personalized and non-personalized gift cards.<br>Accepts <a href=\"#model-AdminPromotionIssueGiftCardEntity\">AdminPromotionIssueGiftCardEntity<\/a> data as body of request and returns <a href=\"#model-PromotionInstanceEntity\">PromotionInstanceEntity<\/a> array.<br><br>For non-personalized gift cards, set <b>personalized<\/b> to <code>false<\/code> and specify <b>count<\/b> (number of cards to issue).<br>Required fields: <b>promotion_id<\/b>, <b>start_date<\/b> (YYYY-MM-DD format), <b>personalized<\/b>, <b>count<\/b>.<br><br>For personalized gift cards, set <b>personalized<\/b> to <code>true<\/code> and provide <b>clients<\/b> (array of client IDs).<br>Optionally, you can set <b>send_email<\/b> to <code>true<\/code> and provide <b>email_body<\/b> and <b>email_subject<\/b> for sending emails to clients.<br>Required fields: <b>promotion_id<\/b>, <b>start_date<\/b> (YYYY-MM-DD format), <b>personalized<\/b>, <b>clients<\/b>.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/PromotionInstanceEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_promotions_issue_gift_card","requestBody":{"required":true,"description":"issue gift card request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AdminPromotionIssueGiftCardEntity"}}}}}},"\/admin\/memberships\/make-membership-instance":{"post":{"tags":["membership"],"summary":"Make membership instance","description":"Creates membership instance and returns empty response body. (Membership custom feature)<br>Accepts <a href=\"#model-MakeMembershipInstanceRequestEntity\">MakeMembershipInstanceRequestEntity<\/a> data as body of request.","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"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"post_admin_memberships_make_membership_instance","requestBody":{"required":true,"description":"membership instance data","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/MakeMembershipInstanceRequestEntity"}}}}}},"\/admin\/memberships\/cancel-client-membership\/{id}":{"delete":{"tags":["membership"],"summary":"Cancel membership","description":"","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"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_admin_memberships_cancel_client_membership_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : client membership id","schema":{"type":"string"}}]}},"\/admin\/tariff\/current":{"get":{"tags":["tariffs"],"summary":"Get current subscription information for the logged-in user.","description":"Returns the current subscription details <a href=\"#model-CompanyTariffEntity\">(CompanyTariffEntity)<\/a> for the authenticated user.<br>Throws AccessDenied error if the user does not have access to this information.\n\n**Return Description:** Current tariff details.","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanyTariffEntity"}}}},"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_admin_tariff_current"}},"\/admin\/statistic":{"get":{"tags":["statistics"],"summary":"Get statistics","description":"Returns statistics data <a href=\"#model-StatisticEntity\">(StatisticEntity)<\/a>:<br>- Most popular provider and its number of bookings (last 30 days).<br>- Most popular service and its number of bookings (last 30 days).<br>- Number of bookings today.<br>- Number of bookings this week (Monday-Sunday).\n\n**Return Description:** Statistics data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/StatisticEntity"}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_statistic"}},"\/admin\/webhooks":{"get":{"tags":["webhooks"],"summary":"Get webhooks list","description":"Return webhooks list.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/WebhookEntity"}}}}},"401":{"description":"Unauthorized: invalid token, or token expired (code 419 in the response body)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"get_admin_webhooks","parameters":[{"name":"is_active","in":"query","required":false,"description":"filter by active status (0 or 1); when omitted, only active (1) subscriptions are returned","schema":{"type":"integer","enum":[0,1]}}]},"post":{"tags":["webhooks"],"summary":"Create webhook","description":"Create new webhook and return it.<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws BadRequest error in case invalid data was provided with detailed errors per field.<br><br><b>event<\/b> is one of:<br><b>cancel_booking<\/b> fired after a booking is cancelled<br><b>change_booking<\/b> fired after a booking is changed<br><b>new_booking<\/b> fired after a new booking is created<br><b>new_invoice<\/b> fired after a new invoice is created<br><b>new_offer<\/b> fired after a new offer is created<br><b>new_client<\/b> fired after a new client is created<br><b>change_client<\/b> fired after a client's data is updated<br><b>delete_client<\/b> fired after a client is deleted\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebhookEntity"}}}},"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_admin_webhooks","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","properties":{"url":{"description":"webhook url, must be a valid absolute URL (http\/https)","type":"string"},"event":{"description":"webhook event:","type":"string"}}}}}}}},"\/admin\/webhooks\/{id}":{"delete":{"tags":["webhooks"],"summary":"Delete webhook","description":"Delete webhook by id. Return empty response<br>Throws AccessDenied error in case user does not have access to perform this action.<br>Throws NotFound error in case webhook is not found.","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"}}}},"404":{"description":"Not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApiErrorEntity"}}}}},"operationId":"delete_admin_webhooks_item","parameters":[{"name":"id","in":"path","required":true,"description":"Path parameter `id` : webhook id","schema":{"type":"string"}}]}},"\/admin\/plugins":{"get":{"tags":["custom_features"],"summary":"Get custom features list","description":"Returns the list of all available custom features with their current status.\n\n**Return Description:** Response data","responses":{"200":{"description":"Successful response","content":{"application\/json":{"schema":{"$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_admin_plugins"}}},"components":{"schemas":{"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"}}},"AdminCompanyInfoEntity":{"type":"object","description":"Admin company information entity","properties":{"login":{"description":"Company login (read-only)","type":"string"},"name":{"description":"Company name","type":"string"},"description":{"description":"Company description","type":"string"},"email":{"description":"Company email","type":"string"},"phone":{"description":"Company phone","type":"string","nullable":true},"address1":{"description":"Company address line 1","type":"string","nullable":true},"address2":{"description":"Company address line 2","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},"state_id":{"description":"Company state id","type":"string","nullable":true},"lat":{"description":"Latitude","type":"number","nullable":true},"lng":{"description":"Longitude","type":"number","nullable":true},"web":{"description":"Company website","type":"string","nullable":true},"cpr_number":{"description":"CPR number","type":"string","nullable":true},"skip_address":{"description":"Skip address on public page","type":"boolean","nullable":true},"hide_email":{"description":"Hide email from public","type":"boolean","nullable":true},"whatsapp":{"description":"WhatsApp phone number","type":"string","nullable":true},"timezone":{"description":"Company timezone","type":"string","nullable":true},"social_links":{"description":"","type":"array","items":{"type":"integer"},"nullable":true}}},"AdminListClientEntity":{"type":"object","description":"Entity that contains client information with metadata","properties":{"data":{"description":"Clients data","type":"array","items":{"$ref":"#\/components\/schemas\/AdminClientEntity"}},"metadata":{"description":"Metadata for the public list","$ref":"#\/components\/schemas\/AdminListMetadataEntity"}}},"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"}}},"ProductQtyEntity":{"type":"object","description":"Entity that contains product qty information","properties":{"product_id":{"description":"Product id","type":"integer"},"qty":{"description":"Product qty","type":"integer"}}},"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 16:12:32"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"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"}}},"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}}},"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}}},"AdminVaccinationSlotsReportEntity":{"type":"object","description":"","properties":{"id":{"description":"Message id. Auto generated value.","type":"integer"}}},"WebhookEntity":{"type":"object","description":"Entity that contains webhook information","properties":{"id":{"description":"Webhook id. Auto-generated value.","type":"integer"},"url":{"description":"Webhook URL","type":"string"},"event":{"description":"Webhook event cancel_booking\/change_booking\/new_booking\/new_invoice\/new_offer\/new_client\/change_client\/delete_client\n<b>cancel_booking<\/b> fired after a booking is cancelled\n<b>change_booking<\/b> fired after a booking is changed\n<b>new_booking<\/b> fired after a new booking is created\n<b>new_invoice<\/b> fired after a new invoice is created\n<b>new_offer<\/b> fired after a new offer is created\n<b>new_client<\/b> fired after a new client is created\n<b>change_client<\/b> fired after a client's data is updated\n<b>delete_client<\/b> fired after a client is deleted","type":"string","enum":["cancel_booking","change_booking","new_booking","new_invoice","new_offer","new_client","change_client","delete_client"]},"is_active":{"description":"Webhook is active","type":"boolean"}}},"Client_EditFieldValueEntity":{"type":"object","description":"Client field value object\nPLEASE NOTE: this entity is simplified version of Client_FieldValueEntity and used only for API documentation purposes,\nto avoid confusion with many other options of client field value entities.","properties":{"id":{"description":"Field identifier. For built-in fields use the field name (e.g. \"email\", \"phone\", \"name\").<br>For custom fields use the field name (UUID string), not the numeric id.<br>The name can be obtained from GET \/admin\/clients\/fields response.","type":"string"},"value":{"description":"Field value","oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]}}},"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_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_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_EditDetailsEntity":{"type":"object","description":"Client data each field value is in separate [[Client_EditFieldValueEntity]] object.\nThis entity is used when editing client details.\nPLEASE NOTE: this entity is simplified version of Client_DetailsEntity and used only for API documentation purposes,\nto avoid confusion with many other options of client details entities.","properties":{"id":{"description":"Id of client","type":"integer"},"fields":{"description":"Array of fields with values","type":"array","items":{"$ref":"#\/components\/schemas\/Client_EditFieldValueEntity"}}}},"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"}}}},"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 16:12:32"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"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"}}},"UserEntity":{"type":"object","description":"Entity that contains user information.\nThis entity will be returned only by admin API","properties":{"id":{"description":"User id. Auto-generated value.","type":"integer"},"login":{"description":"User login","type":"string"},"firstname":{"description":"User first name","type":"string"},"lastname":{"description":"User last name","type":"string"},"email":{"description":"User email","type":"string"},"phone":{"description":"User phone","type":"string"},"company":{"description":"User company","$ref":"#\/components\/schemas\/CompanyEntity"}}},"SimplybookLoginEntity":{"type":"object","description":"Entity that contains admin login information (input only)","properties":{}},"AdminTicketEntity":{"type":"object","description":"Detailed ticket information object","properties":{"booking":{"description":"Booking details","$ref":"#\/components\/schemas\/AdminBookingDetailsEntity"},"check_in_allowed":{"description":"Check in is allowed","type":"boolean"},"processed":{"description":"Ticket has been processed within this request","type":"boolean"},"unavailable_check_in_reason":{"description":"In case check in is unavailable the reason can be<br>'ticket_error_too_early', 'ticket_error_too_late', 'ticket_error_validated', 'ticket_error_inactive'","type":"string"},"check_in_date_time_from":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"check_in_date_time_to":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"id":{"description":"Ticket identifier","type":"integer"},"created":{"description":"When ticket was created","type":"string"},"is_used":{"description":"Is ticket already used","type":"boolean"},"used_datetime":{"description":"Ticket checked in datetime","type":"string"},"code":{"description":"ticket code","type":"string"},"booking_id":{"description":"Booking id","type":"integer"},"client_id":{"description":"Client id","type":"integer"},"template_id":{"description":"Ticket template id","type":"integer"},"is_active":{"description":"Ticket is active","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"}}}},"AdminPackageInstanceEntity":{"type":"object","description":"Extended package instance entity with client information and\nother information that should be available only for admin","properties":{"client":{"description":"Client","$ref":"#\/components\/schemas\/ClientEntity"},"user_id":{"description":"User ID that issued packages instance","type":"integer"},"user":{"description":"User object that issued packages instance","$ref":"#\/components\/schemas\/UserEntity"},"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"}}},"AiSessionMessageEntity":{"type":"object","description":"Entity that contains AI session message information.","properties":{}},"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"}}},"CalendarNoteTypeEntity":{"type":"object","description":"Calendar note type oject","properties":{"id":{"description":"Note type id","type":"integer"},"name":{"description":"Note type name","type":"string"},"color":{"description":"Note type color","type":"string"},"is_default":{"description":"Type is default","type":"boolean"},"position":{"description":"Note type position","type":"integer"}}},"AdminPromotionIssueGiftCardEntity":{"type":"object","description":"Request to issue gift cards","properties":{"promotion_id":{"description":"Gift card id","type":"integer"},"start_date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"personalized":{"description":"Gift card type personalized\/non-personalized","type":"boolean"},"send_email":{"description":"Send email (for personalized cards only)","type":"boolean","nullable":true},"send_sms":{"description":"Send sms (for personalized cards only)","type":"boolean","nullable":true},"email_subject":{"description":"Email subject (for personalized cards only)","type":"string","nullable":true},"email_body":{"description":"Email body (for personalized cards only)","type":"string","nullable":true},"sms_body":{"description":"SMS body (for personalized cards only)","type":"string","nullable":true},"clients":{"description":"Client ids (for personalized cards only)","type":"array","items":{"type":"integer"}},"count":{"description":"Count of non-personalized gift cards","type":"integer","nullable":true}}},"AdminNotificationSettingsEntity":{"type":"object","description":"Entity that contains notification settings information (input only)","properties":{}},"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_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_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_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_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_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"}}},"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"}}},"TimeSlotEntity":{"type":"object","description":"Entity that contains time slot information","properties":{"id":{"description":"Time slot id (the same as date)","type":"string"},"date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"time":{"description":"Time slot time","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 16:12:32"},"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}}},"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"}}},"StatisticEntity":{"type":"object","description":"Entity that contains statistics data","properties":{"most_popular_provider":{"description":"Most popular provider name.","$ref":"#\/components\/schemas\/ProviderEntity","nullable":true},"most_popular_provider_bookings":{"description":"Number of bookings for the most popular provider.","type":"integer"},"most_popular_service":{"description":"Most popular service name.","$ref":"#\/components\/schemas\/ServiceEntity","nullable":true},"most_popular_service_bookings":{"description":"Number of bookings for the most popular service.","type":"integer"},"bookings_today":{"description":"Number of bookings today.","type":"integer"},"bookings_this_week":{"description":"Number of bookings this week.","type":"integer"},"bookings":{"description":"Number of bookings this month.","type":"integer"}}},"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"}]}}},"CompanyTariffEntity":{"type":"object","description":"Entity that contains company subscription information.\nThis entity represents the subscription details of a company, including\nsubscription name, start and expire dates, expiration status, and limits.","properties":{"subscription_name":{"description":"Subscription name","type":"string"},"expire_date":{"description":"Expire date","type":"string"},"start_date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"is_expired":{"description":"Is subscription expired","type":"boolean"},"expire_in":{"description":"Expire in days","type":"integer"},"subscription_link":{"description":"Subscription link","type":"string"}}},"SalesAndTaxReportEntity":{"type":"object","description":"Entity that contains invoice sales report row data","properties":{}},"AdminLoginEntity":{"type":"object","description":"Entity that contains admin login information (input only)","properties":{"company":{"description":"Company name","type":"string"},"login":{"description":"User login","type":"string"},"password":{"description":"User password","type":"string"}}},"CalendarNoteRequestEntity":{"type":"object","description":"Calendar note info","properties":{"id":{"description":"Calendar note id","type":"integer"},"provider_id":{"description":"Provider id (optional)","type":"integer"},"service_id":{"description":"Service id (optional)","type":"integer"},"start_date_time":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"end_date_time":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"note_type_id":{"description":"Note type id","type":"integer"},"note":{"description":"Note body","type":"string"},"mode":{"description":"Note mode (service\/provider\/all)","type":"string"},"time_blocked":{"description":"Time is blocked","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"}}},"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"}}},"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"}}},"AdminReportBookingEntity":{"type":"object","description":"Admin booking list info entity\nClass AdminReportBookingEntity","properties":{"provider":{"description":"Booking provider details entity","$ref":"#\/components\/schemas\/ProviderEntity"},"service":{"description":"Booking service details entity","$ref":"#\/components\/schemas\/ServiceEntity"},"client":{"description":"Client details entity","$ref":"#\/components\/schemas\/ClientEntity"},"status":{"description":"Booking status: confirmed\/pending\/process\/canceled (depending on approve booking status and accept payment).\nprocess - part of a batch (multiple\/group booking) that is not confirmed yet","type":"string","enum":["confirmed","pending","process","canceled"]},"membership_id":{"description":"Client membership id","type":"integer","nullable":true},"invoice_id":{"description":"Invoice id","type":"integer","nullable":true},"invoice_status":{"description":"Booking payment status ('deleted', 'new', 'pending', 'cancelled', 'cancelled_by_timeout', 'error', 'paid')","type":"string","nullable":true},"invoice_payment_received":{"description":"Payment was received","type":"boolean","nullable":true},"invoice_number":{"description":"Invoice number","type":"string","nullable":true},"invoice_datetime":{"description":"Invoice datetime","type":"string","nullable":true},"invoice_payment_processor":{"description":"Payment processor key","type":"string","nullable":true},"ticket_code":{"description":"Booking ticket code","type":"string","nullable":true},"ticket_validation_datetime":{"description":"Booking ticket validation date and time","type":"string","nullable":true},"ticket_is_used":{"description":"Ticket was already validated","type":"boolean","nullable":true},"testing_status":{"description":"Medical testing status (positive\/negative\/inconclusive\/pending or null)","type":"string","nullable":true},"user_status_id":{"description":"Status custom feature id","type":"integer","nullable":true},"category_id":{"description":"Service category id","type":"integer","nullable":true},"location_id":{"description":"Provider location id","type":"integer","nullable":true},"category":{"description":"Service category entity","$ref":"#\/components\/schemas\/CategoryEntity","nullable":true},"location":{"description":"Provider location entity","$ref":"#\/components\/schemas\/LocationEntity","nullable":true},"can_be_edited":{"description":"Can this booking be edited by user","type":"boolean"},"can_be_canceled":{"description":"Can this booking be canceled by user","type":"boolean"},"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 16:12:32"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"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"},"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"},"is_sequential":{"description":"Whether this booking belongs to a sequential (consecutive-services) batch","type":"boolean"}}},"AdminBookingDetailsEntity":{"type":"object","description":"Detailed booking info. allowed only for admin API.","properties":{"provider":{"description":"Booking provider details entity","$ref":"#\/components\/schemas\/ProviderEntity"},"service":{"description":"Booking service details entity","$ref":"#\/components\/schemas\/ServiceEntity"},"client":{"description":"Client details entity","$ref":"#\/components\/schemas\/ClientEntity"},"status":{"description":"Booking status: confirmed\/pending\/process\/canceled (depending on approve booking status and accept payment).\nprocess - part of a batch (multiple\/group booking) that is not confirmed yet","type":"string","enum":["confirmed","pending","process","canceled"]},"membership_id":{"description":"Client membership id","type":"integer","nullable":true},"invoice_id":{"description":"Invoice id","type":"integer","nullable":true},"invoice_status":{"description":"Booking payment status ('deleted', 'new', 'pending', 'cancelled', 'cancelled_by_timeout', 'error', 'paid')","type":"string","nullable":true},"invoice_payment_received":{"description":"Payment was received","type":"boolean","nullable":true},"invoice_number":{"description":"Invoice number","type":"string","nullable":true},"invoice_datetime":{"description":"Invoice datetime","type":"string","nullable":true},"invoice_payment_processor":{"description":"Payment processor key","type":"string","nullable":true},"ticket_code":{"description":"Booking ticket code","type":"string","nullable":true},"ticket_validation_datetime":{"description":"Booking ticket validation date and time","type":"string","nullable":true},"ticket_is_used":{"description":"Ticket was already validated","type":"boolean","nullable":true},"testing_status":{"description":"Medical testing status (positive\/negative\/inconclusive\/pending or null)","type":"string","nullable":true},"user_status_id":{"description":"Status custom feature id","type":"integer","nullable":true},"category_id":{"description":"Service category id","type":"integer","nullable":true},"location_id":{"description":"Provider location id","type":"integer","nullable":true},"category":{"description":"Service category entity","$ref":"#\/components\/schemas\/CategoryEntity","nullable":true},"location":{"description":"Provider location entity","$ref":"#\/components\/schemas\/LocationEntity","nullable":true},"can_be_edited":{"description":"Can this booking be edited by user","type":"boolean"},"can_be_canceled":{"description":"Can this booking be canceled by user","type":"boolean"},"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 16:12:32"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"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"},"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"},"is_sequential":{"description":"Whether this booking belongs to a sequential (consecutive-services) batch","type":"boolean"},"log":{"description":"Booking edit log","type":"array","items":{"$ref":"#\/components\/schemas\/Booking_LogEntity"}},"additional_fields":{"description":"Booking intake form details","type":"array","items":{"$ref":"#\/components\/schemas\/Booking_AdditionalFieldValueEntity"}},"products":{"description":"Booking detailed products list","type":"array","items":{"$ref":"#\/components\/schemas\/Booking_DetailedProductQtyEntity"}},"attributes":{"description":"Booking detailed attributes list","type":"array","items":{"$ref":"#\/components\/schemas\/Booking_DetailedProductQtyEntity"}},"invoice":{"description":"Invoice entity","$ref":"#\/components\/schemas\/AdminInvoiceEntity","nullable":true},"membership":{"description":"Client membership object","$ref":"#\/components\/schemas\/ClientMembershipPaymentEntity","nullable":true},"user_status":{"description":"User status entity","$ref":"#\/components\/schemas\/StatusEntity","nullable":true},"comment":{"description":"Booking comment","type":"string"},"resources":{"description":"Booking resources list","type":"array","items":{"$ref":"#\/components\/schemas\/ResourceEntity"}}}},"AdminOpenidLoginEntity":{"type":"object","description":"Entity for OpenID \/ social login input data","properties":{"provider":{"description":"OpenID provider identifier (e.g. google, facebook)","type":"string"},"token":{"description":"Access token obtained from the OpenID provider","type":"string"},"company":{"description":"Company login to sign into (optional, required when multiple companies are linked)","type":"string","nullable":true}}},"AdminReportMessageEntity":{"type":"object","description":"Entity that contains message information for report","properties":{"id":{"description":"Message id. Auto generated value.","type":"integer"},"datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"recipient":{"description":"Recipient email or phone number (depends on transport type)","type":"string"},"recipient_name":{"description":"Recipient name","type":"string"},"transport":{"description":"Transport type. Can be 'email' or 'sms'","type":"string"},"status":{"description":"Message status","type":"string"},"subject":{"description":"Message subject","type":"string"},"body":{"description":"Message body","type":"string"}}},"ServiceWriteableEntity":{"type":"object","description":"Entity that contains service information (input only)","properties":{"id":{"description":"Service ID","type":"integer"},"name":{"description":"Service name","type":"string"},"description":{"description":"Service description","type":"string"},"price":{"description":"Service price in company currency<br>You can set only if accept payments custom feature is enabled.","type":"number","format":"float"},"deposit_price":{"description":"Deposit price in company currency<br>You can set only if accept payments and deposit custom features are enabled.","type":"number","format":"float"},"tax_id":{"description":"Tax ID<br>You can set only if accept payments custom feature is enabled.","type":"integer"},"duration":{"description":"Service duration","type":"integer"},"is_visible":{"description":"Visibility status","type":"boolean"},"providers":{"description":"Provider IDs that can perform this service. `null` means \"leave existing<br>connections untouched\" (patch semantic on update); `[]` clears all,<br>which in SimplyBook.me effectively means \"any provider can perform it\".","type":"array","items":{"type":"integer"},"nullable":true}}},"AdminListMetadataEntity":{"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"},"alphabet_index":{"description":"Alphabet index of the list (client list only, absent for other lists)","type":"array","items":{"$ref":"#\/components\/schemas\/AdminAlphabetIndexEntity"}}}},"AdminChangePasswordEntity":{"type":"object","description":"Entity that contains change password information (input only)","properties":{"password":{"description":"Current password","type":"string"},"new_password":{"description":"New password","type":"string"},"new_password_repeat":{"description":"Repeat new password","type":"string"}}},"Booking_LogEntity":{"type":"object","description":"Entity that contains booking log information. Readonly object","properties":{"id":{"description":"Id","type":"integer"},"datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"type":{"description":"Event type","type":"string"},"user_login":{"description":"User login","type":"string","nullable":true},"user_name":{"description":"User name","type":"string","nullable":true}}},"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"}}},"Booking_DetailedProductQtyEntity":{"type":"object","description":"Booking product details info. Read only object","properties":{"product":{"description":"Product entity","$ref":"#\/components\/schemas\/ProductEntity"},"product_id":{"description":"Product id","type":"integer"},"qty":{"description":"Product qty","type":"integer"}}},"Calendar_BookingEntity":{"type":"object","description":"Calendar booking info","properties":{"id":{"description":"Booking object id","type":"integer"},"service_name":{"description":"Service name","type":"string"},"service_id":{"description":"Service id","type":"integer"},"provider_name":{"description":"Provider name","type":"string"},"provider_color":{"description":"Provider color","type":"string"},"provider_id":{"description":"Provider id","type":"integer"},"client_name":{"description":"Client name","type":"string"},"client_email":{"description":"Client email","type":"string"},"client_phone":{"description":"Client phone","type":"string"},"client_id":{"description":"Client id","type":"integer"},"from":{"description":"Booking datetime from","type":"string"},"to":{"description":"Booking datetime to","type":"string"},"status":{"description":"Booking status: confirmed\/pending\/canceled","type":"string","enum":["confirmed","pending","canceled"]},"invoice_id":{"description":"Invoice id","type":"integer"},"invoice_status":{"description":"Invoice status","type":"string"},"invoice_payment_received":{"description":"Payment was received","type":"boolean"},"user_status":{"description":"User status","$ref":"#\/components\/schemas\/StatusEntity"},"duration":{"description":"Duration in minutes","type":"integer"}}},"Calendar_NoteEntity":{"type":"object","description":"Note calendar info","properties":{"id":{"description":"Note object id","type":"integer"},"note":{"description":"Note","type":"string"},"note_type":{"description":"Note type","$ref":"#\/components\/schemas\/CalendarNoteTypeEntity"},"time_blocked":{"description":"Time is blocked","type":"boolean"},"service_name":{"description":"Service name","type":"string"},"service_id":{"description":"Service id","type":"integer"},"provider_name":{"description":"Provider name","type":"string"},"provider_id":{"description":"Provider id","type":"integer"},"from":{"description":"Note datetime from","type":"string"},"to":{"description":"Note datetime to","type":"string"}}},"Calendar_ColumnEntity":{"type":"object","description":"Calendar column data","properties":{"id":{"description":"Column object id","type":"integer"},"name":{"description":"Column name","type":"string"},"date":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"type":{"description":"Column type","type":"string"},"from":{"description":"Column work time from","type":"string"},"to":{"description":"Column work time to","type":"string"},"is_day_off":{"description":"Is day off for this day","type":"boolean"},"is_special_day":{"description":"Is special day","type":"boolean"},"breaktimes":{"description":"Breaktimes array","type":"array","items":{"$ref":"#\/components\/schemas\/Calendar_TimePeriodEntity"}},"blocked":{"description":"Blocked time array","type":"array","items":{"$ref":"#\/components\/schemas\/Calendar_TimePeriodEntity"}},"bookings":{"description":"Calendar events array","type":"array","items":{"$ref":"#\/components\/schemas\/Calendar_BookingEntity"}},"notes":{"description":"Calendar notes array","type":"array","items":{"$ref":"#\/components\/schemas\/Calendar_NoteEntity"}}}},"Calendar_TimePeriodEntity":{"type":"object","description":"Time period object","properties":{"from":{"description":"Time from","type":"string"},"to":{"description":"Time to","type":"string"}}},"Calendar_DataEntity":{"type":"object","description":"Calendar info object","properties":{"from":{"description":"Work day from time","type":"string"},"to":{"description":"Work day to time","type":"string"},"columns":{"description":"Columns array","type":"array","items":{"$ref":"#\/components\/schemas\/Calendar_ColumnEntity"}}}},"AdminInvoiceFeeEntity":{"type":"object","description":"Payment fee entity","properties":{"id":{"description":"Transaction id","type":"integer"},"number":{"description":"Invoice number","type":"string"},"fee_amount":{"description":"Fee amount","type":"number","format":"float"},"currency":{"description":"Currency","type":"string"},"record_datetime":{"description":"Record datetime","type":"string"},"charged":{"description":"Charged","type":"boolean"},"charge_datetime":{"description":"Charge datetime","type":"string"}}},"AdminBookingBuildEntity":{"type":"object","description":"Entity that contains information to make booking from admin side","properties":{"service_id":{"description":"Service id","type":"integer"},"provider_id":{"description":"Provider id","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 16:12:32"},"skip_membership":{"description":"Do not use membership for this booking: skips the membership check, so client_membership_id is not required<br>for services that need a membership","type":"boolean"},"user_status_id":{"description":"Users status id","type":"integer"},"accept_payment":{"description":"Set true to make payment order for booking","type":"boolean"},"payment_processor":{"description":"Payment accepted by payment processor","type":"string","nullable":true},"recurring_settings":{"description":"Recurring settings. You can use either count or recurringSettings","$ref":"#\/components\/schemas\/Booking_RecurringSettingsEntity"},"client_membership_id":{"description":"Client membership instance id.<br>Required when the Membership custom feature is enabled and the service can be booked only with a membership<br>(error \"Membership is required\"), unless skip_membership is set.","type":"integer"},"count":{"description":"Group booking count. You can use either count or recurringSettings","type":"integer"},"additional_fields":{"description":"Array of additional fields values. <a href=\"#model-Booking_AdditionalFieldValueEntity\">Booking_AdditionalFieldValueEntity<\/a>[]","type":"array","items":{"$ref":"#\/components\/schemas\/Booking_AdditionalFieldValueEntity"}},"batch_id":{"description":"Multiple\/group booking batch","type":"integer"},"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"},"end_datetime":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"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"},"client_id":{"description":"Client id","type":"integer"},"is_sequential":{"description":"Whether this booking belongs to a sequential (consecutive-services) batch","type":"boolean"}},"required":["service_id","provider_id","start_datetime"]},"CompanyEntity":{"type":"object","description":"Entity that contains company information.\nThis entity will be returned only by admin API","properties":{"login":{"description":"Company login","type":"string"},"name":{"description":"Company name","type":"string"},"dashboard_url":{"description":"Dashboard company url","type":"string"},"public_url":{"description":"Public company url","type":"string"}}},"AdminLogoutEntity":{"type":"object","description":"Entity that contains logout info","properties":{"auth_token":{"description":"Auth token","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"}}}},"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"}}},"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"}}},"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}}},"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 16:12:32"},"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"}}},"AdminBookingLinksEntity":{"type":"object","description":"Entity that contains booking links for admin API.","properties":{"booking_link":{"description":"Booking viewing link URL","type":"string"},"cancel_link":{"description":"Booking cancellation link URL","type":"string"},"reschedule_link":{"description":"Booking rescheduling link URL","type":"string"}}},"AdminVaccinationSecondAppointmentReportEntity":{"type":"object","description":"","properties":{"id":{"description":"Message id. Auto generated value.","type":"integer"}}},"DetailedReportFilterEntity":{"type":"object","description":"Entity that contains filter for detailed report\nThis entity is used to filter detailed reports based on various criteria such as date ranges, event IDs, unit group IDs, client IDs, booking types, and codes.","properties":{"created_date_from":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"created_date_to":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"date_from":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"date_to":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"event_id":{"description":"Filter for event ID (service ID)","type":"string"},"unit_group_id":{"description":"Filter for provider ID (unit group ID)","type":"string"},"client_id":{"description":"Filter for client ID","type":"string"},"booking_type":{"description":"Filter for booking type (one of: approved, non_approved_yet, cancelled_by_admin, cancelled_by_client, non_cancelled, cancelled, all)","type":"string"},"code":{"description":"Filter for booking code","type":"string"}}},"RefreshTokenEntity":{"type":"object","description":"Entity that contains refresh token information","properties":{"company":{"description":"Company login","type":"string"},"refresh_token":{"description":"Refresh token","type":"string"},"device_token":{"description":"Device token","type":"string","nullable":true}}},"AdminLogin2FAEntity":{"type":"object","description":"Entity that contains admin login information for 2 FA (input only)","properties":{"company":{"description":"Company name","type":"string"},"session_id":{"description":"Login session id","type":"string"},"type":{"description":"2FA type (sms\/ga\/email)","type":"string"},"code":{"description":"Code","type":"string"}}},"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"}}},"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"}}},"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}}},"AdminAlphabetIndexEntity":{"type":"object","description":"Alphabet index item of the client list","properties":{"letter":{"description":"First letter of client name","type":"string"},"index":{"description":"Position (zero-based offset) of the first client with this letter in the full list","type":"integer"}}},"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"}}},"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"}}},"AdminCompanyConfigEntity":{"type":"object","description":"Admin company configuration entity","properties":{"time_frame":{"description":"Timeline step in minutes (company \"timeframe\" setting)","type":"integer"},"company_domain":{"description":"Company domain (booking page host)","type":"string"},"group_booking_max_participants":{"description":"Maximum number of participants in a group booking","type":"integer"},"monday_is_first_day":{"description":"Whether the week starts on Monday","type":"boolean"},"phone_country_prefix":{"description":"Default phone country prefix (fixed company prefix, or detected from X-Country-Code header; empty string if unknown)","type":"string"},"price_includes_tax":{"description":"Whether prices include tax","type":"boolean"},"company_timezone":{"description":"Company time zone (e.g. Europe\/Berlin). Booking dates and times are in this time zone","type":"string"},"sbpay_pro_enabled":{"description":"Whether SimplyBook Pay Pro is enabled","type":"boolean"},"paid_attributes_exclusive":{"description":"Only one paid attribute (add-on) can be selected per booking","type":"boolean"}}},"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"}}}},"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"}}},"AiSessionEntity":{"type":"object","description":"Entity that contains AI session information.","properties":{}},"BookingResultEntity":{"type":"object","description":"Entity that contains booking result information.\nReadonly entity","properties":{"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}}},"MakeMembershipInstanceRequestEntity":{"type":"object","description":"Entity that contains information about membership instance creation request","properties":{"membership_id":{"description":"Membership id.","type":"integer"},"clients":{"description":"Client ids","type":"array","items":{"type":"integer"}},"period_start":{"description":"Date in format YYYY-MM-DD","type":"string","format":"date"},"is_invoice_needed":{"description":"Generate an invoice","type":"boolean"},"payment_processor":{"description":"Paid via","type":"string","nullable":true},"auto_confirm_prolonging":{"description":"Membership auto prolonging","type":"boolean"},"repeat_count":{"description":"Number of times to prolong","type":"integer","nullable":true}}},"AdminStatusEntity":{"type":"object","description":"Admin status entity\nThis entity is used to represent the status of an admin action.\nIt contains a status ID that can be set and retrieved.","properties":{"status_id":{"description":"Status id","type":"integer"}}},"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"}}},"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"}}},"CalendarNoteEntity":{"type":"object","description":"Calendar note info","properties":{"id":{"description":"Calendar note id","type":"integer"},"provider_id":{"description":"Provider id (optional)","type":"integer"},"service_id":{"description":"Service id (optional)","type":"integer"},"provider":{"description":"Provider data (optional). Read only.","$ref":"#\/components\/schemas\/ProviderEntity"},"service":{"description":"Service data (optional). Read only.","$ref":"#\/components\/schemas\/ServiceEntity"},"start_date_time":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"end_date_time":{"description":"Date and time in format YYYY-MM-DD HH:MM:SS","type":"string","format":"date-time","example":"2026-11-22 16:12:32"},"note_type_id":{"description":"Note type id","type":"integer"},"note_type":{"description":"Note type object. Read only.","$ref":"#\/components\/schemas\/CalendarNoteTypeEntity"},"note":{"description":"Note body","type":"string"},"mode":{"description":"Note mode (service\/provider\/all)","type":"string"},"time_blocked":{"description":"Time is blocked","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}}},"SimplybookRefreshTokenEntity":{"type":"object","description":"Entity that contains refresh token information","properties":{"refresh_token":{"description":"Refresh token","type":"string"}}},"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"}}},"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"}}},"CompanyTariff_LimitEntity":{"type":"object","description":"Entity that contains company subscription limit information.\nThis entity represents the limits associated with a company subscription, including\nthe key, total limit, and remaining limit.","properties":{"key":{"description":"Limit key<br>Represents the unique identifier for the limit.","type":"string"},"total":{"description":"Limit value<br>Represents the total value of the limit.","type":"integer"},"rest":{"description":"Limit rest<br>Represents the remaining value of the limit.","type":"integer"}}},"AdminPromotionInstanceEntity":{"type":"object","description":"Extended promotion instance entity with client information and\nother information that should be available only for admin","properties":{"client":{"description":"Purchased by client","$ref":"#\/components\/schemas\/ClientEntity"},"user_id":{"description":"User id that created instance","type":"integer"},"user":{"description":"User that created instance","$ref":"#\/components\/schemas\/UserEntity"},"status":{"description":"Promotion status","type":"string"},"used_count":{"description":"Used count","type":"integer"},"used_amount":{"description":"Used amount","type":"number","format":"float"},"rest_amount":{"description":"Rest amount. Applied only to gift cards.","type":"number","format":"float"},"allowed_to_use_full_amount":{"description":"Allowed to use full amount","type":"boolean"},"created":{"description":"Created date","type":"string"},"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"}}},"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"}}},"ResourceEntity":{"type":"object","description":"Resource info","properties":{"id":{"description":"Resource id","type":"integer"},"name":{"description":"Resource name","type":"string"}}},"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"}}},"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"}}},"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"}}},"ProviderWritableEntity":{"type":"object","description":"Entity that contains provider information (input only)","properties":{"id":{"description":"Provider id","type":"integer"},"name":{"description":"Provider name","type":"string"},"qty":{"description":"Provider quantity","type":"integer"},"email":{"description":"Provider email","type":"string"},"description":{"description":"Provider description","type":"string"},"phone":{"description":"Provider phone","type":"string"},"is_visible":{"description":"Provider visibility","type":"boolean"},"color":{"description":"Provider color","type":"string"},"services":{"description":"Service IDs the provider can perform. `null` means \"leave existing<br>connections untouched\" (patch semantic on update); `[]` clears all.","type":"array","items":{"type":"integer"},"nullable":true}}},"AdminInvoiceRecurringProfileEntity":{"type":"object","description":"Extended invoice recurring profile entity with client information and\nother information that should be available only for admin","properties":{"client":{"description":"Client","$ref":"#\/components\/schemas\/ClientEntity"},"cancelled_by_user_id":{"description":"User ID that cancelled recurring profile","type":"integer"},"cancelled_by_user":{"description":"User object that cancelled recurring profile","$ref":"#\/components\/schemas\/UserEntity"},"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},"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 16:12:32"},"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}}},"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"}}},"Service_ProductEntity":{"type":"object","description":"Product information for service (with default qty info)","properties":{"product":{"description":"Product","$ref":"#\/components\/schemas\/ProductEntity"},"qty":{"description":"Qty","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"}}},"AdminClientMembershipPaymentEntity":{"type":"object","description":"Entity that contains client membership payment information. When this membership starts, ends, rest of bookings, etc.","properties":{"client":{"description":"Client details","$ref":"#\/components\/schemas\/ClientEntity"},"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 16:12:32"},"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"}}},"StatusEntity":{"type":"object","description":"User status entity","properties":{"id":{"description":"Status id. Auto-generated value.","type":"integer"},"name":{"description":"Status name.","type":"string"},"description":{"description":"Status description.","type":"string"},"color":{"description":"Status color","type":"string"},"is_default":{"description":"Is status default","type":"boolean"}}},"AdminClientEntity":{"type":"object","description":"Entity that contains client information","properties":{"can_be_edited":{"description":"Indicates whether the client can be edited","type":"boolean"},"is_deleted":{"description":"Indicates whether the client is deleted","type":"boolean"},"email_promo_subscribed":{"description":"Indicates whether the client is subscribed to email promotions","type":"boolean"},"sms_promo_subscribed":{"description":"Indicates whether the client is subscribed to SMS promotions","type":"boolean"},"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}}},"AdminInvoiceEntity":{"type":"object","description":"Extended invoice entity with client information and\nother information that available only for admin","properties":{"client":{"description":"Client","$ref":"#\/components\/schemas\/AdminClientEntity"},"created_by_user_id":{"description":"User ID that created invoice","type":"integer"},"created_by_user":{"description":"User object that created invoice","$ref":"#\/components\/schemas\/UserEntity"},"approved_by_user_id":{"description":"User ID that receive payment (for manual and delay payments)","type":"integer"},"approved_by_user":{"description":"User object that receive payment (for manual and delay payments)","$ref":"#\/components\/schemas\/UserEntity"},"refunded_by_user_id":{"description":"User ID that refunded payment","type":"integer"},"refunded_by_user":{"description":"User object that refunded payment","$ref":"#\/components\/schemas\/UserEntity"},"late_confirmation_issues":{"description":"Unresolved follow-up issues left by a late\/released-invoice payment confirmation\n(CY1SDEV1-4515) - e.g. money received but the package\/promotion credit it depended on was\nno longer available, or the payment was accepted but a booking could not be revived\nbecause its slot was no longer free. Empty when there is nothing to follow up on.","type":"array","items":{"type":"integer"}},"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 16:12:32"},"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"}}}},"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":[]}]}