Name	Type	Description
company	string	Company name
login	string	User login
password	string	User password

Name	Type	Description
token	string	Auth token
company	string	Company login
login	string	User login
refresh_token	string\|null	Refresh token (use it to get new access token when old expired)
domain	string\|null	Company domain
require2fa	bool	Required two factor authorisation (token and refresh will be empty)
allowed2fa_providers	array\|string[]	Allowed providers (sms/ga)
auth_session_id	string	Authentication session id (pass it with 2FA request)

Name	Type	Description
start_datetime	string	Booking start datetime
end_datetime	string	Booking end datetime
location_id	int	Location id
category_id	int	Category id
service_id	int	Service id
provider_id	int	Provider id
client_id	int	Client id
service	ServiceEntity	Service
provider	ProviderEntity	Provider
location	LocationEntity	Location
category	CategoryEntity	Category
count	int	Group booking count. You can use either count or recurringSettings
recurring_settings	Booking_RecurringSettingsEntity	Recurring settings. You can use either count or recurringSettings
additional_fields	array\|Booking_AdditionalFieldValueEntity[]	Array of additional fields values. Booking_AdditionalFieldValueEntity[]
products	array\|ProductQtyEntity[]	Array of products (addons). ProductQtyEntity[]
client_membership_id	int	Client membership instance id.
client	ClientEntity	Client data
batch_id	int	Multiple/group booking batch
skip_membership	bool	Do not use membership for this booking
user_status_id	int	Users status id
accept_payment	bool	Set true to make payment order for booking
payment_processor	string\|null	Payment accepted by payment processor

Name	Type	Description
bookings	array\|BookingEntity[]	Array of bookings, that were booked.
batch	BookingBatchEntity\|null	Booking batch

Name	Type	Description
id	int	Booking id. Auto-generated value.
code	string	Booking code. Auto-generated value.
is_confirmed	bool	Booking is confirmed
start_datetime	string	Booking start datetime
end_datetime	string	Booking end datetime
location_id	int	Location id
category_id	int	Category id
service_id	int	Service id
provider_id	int	Provider id
client_id	int	Client id
duration	int	Duration in minutes
service	ServiceEntity	Service
provider	ProviderEntity	Provider
location	LocationEntity	Location
category	CategoryEntity	Category

Name	Type	Description
id	int	Batch id. Auto-generated value.
type	string	Batch type. Can be 'recurring', 'multiple', 'group'.
is_closed	bool	Flag that indicates that user has finished booking.

Name	Type	Description
days	int	Repeat days. Use each $days day for 'fixed' type and mask of week days for 'weekly' type.
repeat_count	int	Repeat count
type	string	Type of repeat. Can be 'fixed', 'weekly' 'weekly' means repeat every week day, that set in $days mask. 'fixed' means repeat every $days day.
mode	string	Mode when it is impossible to book appointment on some date. Can be: 'skip', 'book_available', 'book_and_move'. 'skip' - Skip all bookings 'book_available' - book only on available dates 'book_and_move' - move to next date in case some date is not available
price_per_session	bool	Price per session flag If true, the price is per session, otherwise it is per whole pack

Name	Type	Description
id	int	Additional field id
field	string	Additional field name.
value	mixed	Additional field value
file_hash	string	Cloud field file hash

Name	Type	Description
product_id	int	Product id
qty	int	Product qty
product	ProductEntity	Product entity

Name	Type	Description
id	int	Id
datetime	string	Log datetime
type	string	Event type
user_login	string\|null	User login
user_name	string\|null	User name

Name	Type	Description
date	string	Time slot date
time	string	Time slot time

Name	Type	Description
date	string	Date
slots	Timeline_SlotEntity[]	Slots

Name	Type	Description
time	string	Time
available_count	int	Available slots count
total_count	int	Total slots count

Name	Type	Description
id	int	Location id. Auto-generated value.
name	string	Location name
description	string\|null	Location description
picture	string	Picture file name
picture_preview	string	Path to preview picture
providers	array\|int[]	Location providers (list of ids)
address1	string\|null	Location address 1
address2	string\|null	Location address 2
phone	string\|null	Phone number
city	string\|null	Location city
zip	string\|null	Location zip code
country_id	string\|null	Location country id
is_visible	bool	If location is visible on public side
lat	float	Location latitude
lng	float	Location longitude

Name	Type	Description
date	string	Work day date
time_from	string	Work day time from
time_to	string	Work day time to
is_day_off	bool	Is day off

Name	Type	Description
id	int	Category id. Auto-generated value.
name	string	Category name
services	array\|int[]	Category services (list of ids)
is_visible	bool	If category is visible on public side

Name	Type	Description
id	int	Provider id. Auto-generated value.
name	string	Provider name
qty	int	Provider capacity
email	string	Provider email
description	string	Provider description
phone	string	Provider phone
picture	string	Picture file name
picture_preview	string	Path to preview picture
color	string	Provider color
is_active	bool	If provider is active
is_visible	bool	If provider is visible on public site
services	array\|int[]	Array of ids of services where this provider connected.

Name	Type	Description
id	int	Service id. Auto-generated value.
name	string	Service name
description	string	Promotion description
price	float	Service price
currency	string	Service price currency
deposit_price	float	Deposit price
tax_id	int	Tax id
tax	TaxEntity	Tax information
duration	int	Duration in minutes
buffer_time_after	int	Buffer time after in minutes
recurring_settings	Booking_RecurringSettingsEntity\|null	Service recurring settings (in case it is recurring service)
memberships	array\|int[]	Array of ids of memberships where this service presents.
providers	array\|int[]	Array of ids of providers where this service connected.
picture	string	Picture file name
picture_preview	string	Path to preview picture
is_active	bool	If service is active
is_visible	bool	If service is visible on public side
limit_booking	int	Limit bookings value. Will be null in case "Limit bookings" is turned off. Will take common value from config in case this value is empty or 0 for event.
min_group_booking	int	Min group booking value. Will be null in case "Group booking" is turned off.

Name	Type	Description
id	int	Status id. Auto-generated value.
name	string	Status name.
description	string	Status description.
color	string	Status color
is_default	bool	Is status default

Name	Type	Description
id	int	Client id. Auto-generated value.
name	string	Client name
email	string	Client email
phone	string	Client phone

Name	Type	Description
id	string	Field id
title	string	Field title
default_value	mixed	Default field value
values	array\|Client_FieldSelectOptionEntity[]	Array of available values for select field
value	mixed	Field value
is_visible	bool	Field is visible on public site
is_optional	bool	Field is optional
is_built_in	bool	Field is built-in
type	string	Field type

Name	Type	Description
id	int	Id of client
fields	array\|Client_FieldValueEntity[]	Array of fields with values

Name	Type	Description
value	string	Option value
is_default	bool	Is default value
position	int	Position

Name	Type	Description
id	int	User id. Auto-generated value.
login	string	User login
firstname	string	User first name
lastname	string	User last name
email	string	User email
phone	string	User phone
company	CompanyEntity	User company

Get api token

Get event list

Get performer list

Filter performers by service

Get closest day with available time slots

Disable not working time in calendar

Get available time slots

Check if additional fields plugin is activated

Get additional fields

Perform booking

Summary

Authorization

Client API(yrityksen julkinen palvelu) autorisaatio

User/Admin API(Yrityksen hallintopalvelu) autorisointi

Valtuutus palvelinpuolen koodista

Tietojen hakeminen Simplybook-palvelimelta

Salaisen API-avaimen käyttö

Simplybook Plugins

Booking functionality codeflow

Palvelun URL-osoite https://user-api.simplybook.me/login

getServiceUrl ($companyLogin)

getToken ($companyLogin, $apiKey)

getUserToken ($companyLogin, $userLogin, $userPassword)

getApplicationToken ($applicationApiKey)

Palvelun URL-osoite https://user-api.simplybook.me/

getUnitList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

getEventList ($isVisibleOnly, $asArray, $handleClasses, $searchString)

getCategoriesList ($isPublic)

getLocationsList ($isPublic)

getPaymentProcessorConfig ($paymentProcessor)

validatePayment ($paymentInfo, $cartId)

getBookingCart ($bookingIds)

getBookingCartInfo ($cartId, $sign)

getBookingCartStatus ($id)

confirmBookingCart ($cartId, $paymentProcessor, $sign)

confirmBooking ($id, $sign)

confirmBookingPayment ($id, $paymentProcessor, $sign)

confirmBookingBatch ($batchId, $batchType, $sign)

getBooking ($id, $sign)

getBookingDetails ($id, $sign)

isPaymentRequired ($eventId)

book ($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId, $recurringData)

getRecurringDatetimes ($eventId, $unitId, $date, $time, $recurringData, $productIds)

hasUpcommingPromotions ()

validatePromoCode ($code, $startDateTime, $eventId, $count, $clientData)

getPromocodeInfo ($code)

getPromotionRewardInfo ($commonPromotionId, $clientId, $hash)

getUserLicenseText ()

getPrivacyPolicyText ()

getClientInfo ($clientId, $sign)

getClientInfoByLoginPassword ($login, $password)

remindClientPassword ($email)

getClientByLoginHash ($hash, $setExpired, $expireOtherHashes)

modifyClientPassword ($clientId, $data, $sign)

modifyClientInfo ($clientId, $data, $sign)

getMembershipList ()

getClientMembershipList ($filter, $clientId, $sign)

getClientBookings ($clientId, $sign, $filter)

getProductList ($filter)

getClassesList ($filter)

rescheduleBook ($shedulerId, $sign, $startDate, $startTime, $endDate, $endTime, $additional, $clientTimeOffset, $clientTimezone)

getCompanyParam ($key)

getCompanyParams ($keys)

getCancellationPolicy ()

getTimelineType ()

calculateEndTime ($startDateTime, $eventId, $unitId, $productIds)

getWorkCalendar ($year, $month, $data)

getReservedTime ($from, $to, $eventId, $unitId, $count)

getWorkDaysInfo ($from, $to, $unitId, $eventId, $count, $productIds)

getFirstWorkingDay ($data)

getStartTimeMatrix ($from, $to, $eventId, $unitId, $count, $bookingId, $productIds)

getCartesianStartTimeMatrix ($from, $to, $eventId, $unitId, $count, $bookingId, $productIds)

getAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

getServiceAvailableTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count)

getReservedTimeIntervals ($dateFrom, $dateTo, $eventId, $unitId, $count, $bookingId)

getAvailableUnits ($eventId, $dateTime, $count, $unitId, $productIds)

getAnyUnitData ()

getAdditionalFields ($eventId)

getTimeframe ()

isPluginActivated ($pluginName)

Name	Type	Description
id	int	Product id. Auto-generated value.
name	string	Product name
barcode	string	Product barcode
description	string	Product description
type	string	Product type. It can be 'product' or 'attribute'
price	float	Product price
currency	string	Product currency
tax_id	int	Tax id
tax	TaxEntity	Tax information
duration	int	Product duration

Name	Type	Description
id	int	Invoice id. Auto-generated value.
number	string	Invoice number. Auto-generated value.
datetime	string	Invoice datetime. Readonly
due_datetime	string	Invoice due date. By default current datetime + payment timeout
payment_datetime	string\|null	Payment payment date
refund_datetime	string\|null	Refund payment date
amount	float	Invoice amount. Readonly
recurring_amount	float	Invoice recurring amount. Readonly
deposit	float	Invoice deposit. Readonly
rest_amount	float	Invoice rest amount. Readonly
taxes	array\|TaxEntity">Invoice_TaxEntity[]	Array of invoice taxes
discount	float	Invoice discount amount. Readonly
currency	string	Invoice currency code. ISO 4217
client_id	int	Client id
description	string	Invoice description
payment_received	bool	Payment was received by company
payment_processor	string	Payment processor key
lines	array	Array of lines. The line can be one of the following types: Invoice_BookingLineEntity, Invoice_ProductLineEntity, Invoice_MembershipLineEntity, Invoice_PackageLineEntity, Invoice_PromotionLineEntity, Invoice_DepositLineEntity
promotion_instances	array\|PromotionInstanceEntity[]	Array of PromotionInstanceEntity. Promotion instances used in invoice
package_instances	array\|PackageInstanceEntity[]	Array of PackageInstanceEntity. Package instances used in invoice
status	string	Current invoice status
support_recurring_payment	bool	True in case this invoice can be payed with recurring payment method
require_recurring_payment	bool	True in case this invoice can be payed only with recurring payment method
recurring_profile_id	int	Recurring profile id, linked to this invoice
client	AdminClientEntity	Client
created_by_user_id	int	User ID that created invoice
created_by_user	UserEntity	User object that created invoice
approved_by_user_id	int	User ID that receive payment (for manual and delay payments)
approved_by_user	UserEntity	User object that receive payment (for manual and delay payments)
refunded_by_user_id	int	User ID that refunded payment
refunded_by_user	UserEntity	User object that refunded payment

Name	Type	Description
id	int	Invoice line id. Auto-generated value.
invoice_id	int	Invoice id
name	string	Invoice line name
type	string	Invoice line type. Can be booking, product, membership, custom
discount_ratio	float	Invoice line discount ratio
discount_amount	float	Invoice line discount fixed amount
discount	float	Invoice line discount
price	float	Invoice line price
final_price	float	Invoice line final price (including tax and discount)
qty	float	Invoice line qty
package_qty	float	Invoice line qty, that was purchased by using package
tax	TaxEntity	Tax entity related to this invoice line Note: Use tax_rate in calculations as rate in this object can be different.
tax_ratio	float	Invoice line tax ratio
tax_amount	float	Invoice line tax amount
amount	float	Invoice line amount
deposit	float	Invoice line deposit
rest_amount	float	Invoice line rest amount
booking_ids	array	Booking ids, that were purchased. It can have multiple ids in case recurring booking and group booking. In case recurring booking qty will be equal 1, because client pays for session. In case group booking qty will be equal count of group booking.
bookings	array\|BookingEntity[]	Bookings, that were purchased

Name	Type	Description
id	int	Tax id. Auto-generated value.
name	string	Tax name
ratio	float	Tax ratio
is_default	bool	Is default tax
amount	float	Tax amount

Name	Type	Description
id	int	Membership payment id. Auto-generated value.
client_id	int	Client id
period_start	string	Membership start date
period_end	string	Membership end date
created	string	Membership payment created date
membership_id	int	Membership id
membership	MembershipEntity	Membership object
rest	int	Membership rest
simultaneous_rest	int	Membership simultaneous rest
count	int	Used bookings from membership
can_be_used	bool	Membership start date
is_expired	bool	Is membership expired
invoice_id	int	Invoice id, where this membership was purchased
invoice_number	string	Invoice number, where this membership was purchased
invoice_datetime	string	Invoice datetime, where this membership was purchased
recurring_profile_id	int	Recurring profile id for invoice with this membership
recurring_profile_status	string	Recurring profile status for invoice with this membership
status	string	Current client membership status
bookings	array\|BookingEntity[]\|null	Membership bookings array

Name	Type	Description
id	int	Promotion instance id. Auto-generated value.
promotion	PromotionEntity	Promotion information
start_date	string	Promotion instance start date
expired_date	string	Promotion instance expire date
is_used	bool	Returns true if this promotion was used already
can_be_used	bool	Returns true if this promotion was used already
can_be_used_count	int	Returns how many times left. In case this value is -1 then can be used unlimited times.
code	string	Promotion instance code
client_id	int	Client id

Name	Type	Description
id	int	Package instance id. Auto-generated value.
client_id	int	Client id
created	string	Package instance created date
period_start	string	Package start date
period_end	string	Package end date
status	string	Package status
can_be_used	bool	If package can be used
is_used	bool	If package was totally used
package_id	int	Package id
package	PackageEntity	Package object
services	array\|Package_PackageServiceEntity[]	Warning! This is used services for invoice package instances or rest of services in the package instance for package instance details
products	array\|Package_PackageProductEntity[]	Warning! This is used products for invoice package instances or rest of products in the package instance for package instance details
paid_attributes	array\|Package_PackageProductEntity[]	Warning! This is used attributes for invoice package instances or rest of attributes in the package instance for package instance details
count_used_package_instance	int	How many times packages used

Name	Type	Description
id	int	Package id. Auto-generated value.
name	string	Package name
description	string	Package description
position	int	Package position
file_id	int	Image file id
picture	string	Picture file name
picture_path	string	Picture path
picture_preview	string	Path to preview picture
picture_large	string	Path to large picture
price	float	Package price
currency	string	Package price currency
tax_id	int	Tax id
tax	TaxEntity	Tax information
duration	int	Package duration
duration_type	string	Package duration type
sales_limit	int	Package sales limit
sold	int	Sold packages count
can_be_purchased	bool	If client can purchase this package
is_active	bool	Is package active
is_visible	bool	Is package visible on public site
services	array\|Package_PackageServiceEntity[]	Array of connected services (Package_PackageServiceEntity[])
products	array\|Package_PackageProductEntity[]	Array of connected products (Package_PackageProductEntity[])
paid_attributes	array\|Package_PackageProductEntity[]	Array of connected paid attributes (Package_PackageProductEntity[])
has_instances	bool	If package has generated instances already
is_use_package_limit	bool	Is use package limit
package_limit	int	Package limit

Name	Type	Description
id	int	Package service entity id. Auto-generated value.
service_id	int	Service id
qty	int	Qty in package
name	string	Service name
is_visible	bool	Is visible

Name	Type	Description
id	int	Promotion id. Auto-generated value.
name	string	Promotion name
description	string	Promotion description
file_id	int	Image file id
picture_preview	string	Path to preview picture
picture_large	string	Path to large picture
is_visible	bool	Is promotion visible on public site
is_active	bool	Is promotion active
position	int	Promotion position
price	float	Promotion price to purchase (gift card)
currency	string	Promotion price currency to purchase (gift card)
tax	TaxEntity	Promotion tax
promotion_type	string	Promotion type. Can be 'gift_card', 'discount'
discount_type	string	Discount type. Can be 'fixed_amount', 'percentage' fixed_amount is discount for fixed amount. percentage is percentage discount.
discount	float	Discount value (amount value or percentage value)
duration_type	string	Duration type for gift cards ('year', 'month', 'week', 'day')
duration	int	Duration length
client_type	string	Client type can be 'new' or 'all'
allow_usage_count	int	Limit of usage count
is_unlimited	bool	Is unlimited
affect_services	bool	Is it possible to apply this promotion to services?
affect_products	bool	Is it possible to apply this promotion to products?
affect_paid_attributes	bool	Is it possible to apply this promotion to paid attribute?
affect_memberships	bool	Is it possible to apply this promotion to memberships?
affect_packages	bool	Is it possible to apply this promotion to packages?
service_restrictions	array\|int[]	Array of services ids to which you can apply promotion
booking_restrictions	array\|Promotion_BookingRestrictionEntity[]	Array of Promotion_BookingRestrictionEntity
product_restrictions	array\|int[]	Array of product ids to which you can apply promotion
paid_attribute_restrictions	array\|int[]	Array of paid attributes ids to which you can apply promotion
memberships_restrictions	array\|int[]	Array of memberships ids to which you can apply promotion
package_restrictions	array\|int[]	Array of packages ids to which you can apply promotion