Bookings Models

Area

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
code	Code	string	no	no
name	Name	string	yes	no
image	Image	image	no	no
startTime	Start time	time	yes	no
endTime	End time	time	yes	no
increment	Increment	duration	yes	no
timeout	Prebooking timeout	duration	yes	no
cardTag	Card tag	string	no	no
tags	Customers tags	manyToMany	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Blocking

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
name	Name	string	yes	no
area	Area	int	no	no
resourceType	Resource type	int	no	no
resource	Resource	int	no	no
bgColor	Color	color	no	no
comments	Observations	text	no	no
allowCrossings	Allow crossings	bool	yes	no
tags	Customer tags	manyToMany	no	no
disabled	Disabled	bool	yes	no
timeout	Expiration before start	duration	no	no
allowAdmin	Allow in back office	bool	yes	no
slots	Slots	int	no	no
startDate	Start date	date	no	no
endDate	End date	date	no	no
daysOfWeek	Days of the week	daysOfWeek	no	no
startTime	Start time	time	no	no
endTime	End time	time	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Booking

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
reference	Locator	string	yes	yes
groupId	Group	int	no	yes
description	Description	string	no	no
name	Name	string	no	no
email	Email	email	no	no
phone	Phone	phone	no	no
customer	Customer	int	no	no
area	Area	int	yes	yes
resource	Resource	int	yes	no
type	Booking type	int	no	no
categoryName	Category	string	yes	no
start	Start date	datetime	yes	no
end	End date	datetime	yes	no
cancelation	Cancellation date	datetime	no	no
crossing	Crossing	bool	yes	yes
extra	Extra	bool	yes	yes
minCapacity	Minimum slots	int	no	no
maxCapacity	Maximum slots	int	no	no
payPerPerson	Price per person	bool	yes	no
hasParticipants	Has participants	bool	yes	no
parent	Main booking	int	no	no
timeout	Expiration date	datetime	no	yes
product	Product	int	no	no
sale	Sale	int	no	yes
checkin	Checkin	bool	yes	no
checkout	Checkout	bool	yes	no
price	Price	currency	yes	no
status	Status	select	yes	yes
needInfo	Requires information	bool	yes	yes
online	Created online	bool	yes	yes
api	API	bool	yes	yes
notify	Notify	bool	yes	no
remind	Reminder	bool	yes	no
noShow	No show	bool	yes	no
confirmationSent	Confirmation sent	bool	yes	yes
reminderSent	Reminder envoy	bool	yes	no
byDays	Book by days	bool	yes	no
beneficiary	Beneficiary	int	no	no
origin	Source	int	no	no
tag	Tag	string	no	no
comments	Observations	text	no	no
onlineComments	Online observations	text	no	no
multipack	Pack	int	no	no
pin	PIN	string	no	no
automaticExtras	Automatic extras	json	no	no
afterMailSent	Subsequent email sent	bool	yes	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Values for status

Value	Name
0	Draft
1	For free
2	Not paid
3	Paid
4	Discarded

Booking rule

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
name	Name	string	yes	no
priority	Priority	int	yes	no
typeTag	Reserve -type label	int	no	no
customerTag	Customer tag	int	no	no
customerMode	Client mode	select	yes	no
ignoreInAdmin	Ignore in administration	bool	yes	no
amount	Amount	int	yes	no
period	Period	select	yes	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Values for customerMode

Value	Name
0	All
1	Customer

Values for period

Value	Name
0	Fringe
1	Hour
2	Day
3	Week
4	Month
5	Year
6	Active bookings

Booking type

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
product	Product	int	no	no
name	Name	string	yes	no
description	Short description	text	no	no
longDescription	Long description	text	no	no
image	Image	image	no	no
area	Area	int	yes	no
duration	Duration	duration	yes	no
hasCrossings	Has crossings	bool	yes	no
multiple	Multiples	int	no	no
separable	Separable	bool	yes	no
isPack	It's pack	bool	yes	no
hasParticipants	Has participants	bool	yes	no
minCapacity	Minimum slots	int	no	no
maxCapacity	Maximum slots	int	no	no
payPerPerson	Price per person	bool	yes	no
participantAsCustomer	Participant as client	bool	yes	no
isExtra	It is extra	bool	yes	no
identifyCustomer	Identify the client	bool	yes	no
identifyAsText	Identify by name	bool	yes	no
identifySearchByMemberCode	Search by membership number	bool	yes	no
identifySearchByName	Search by name in the club's database	bool	yes	no
customerRequired	Require a client	bool	yes	no
confirmationEmailCopy	Confirmation copy	bool	yes	no
startDate	Start date	date	no	no
endDate	End date	date	no	no
daysOfWeek	Days of the week	daysOfWeek	no	no
holidays	Holidays	select	no	no
startTime	Start time	time	no	no
endTime	End time	time	no	no
minLimit	Limit before the start to book	duration	no	no
maxLimit	Limit in advance to book	duration	no	no
minLimitFullDays	Limit for full days	bool	yes	no
maxLimitFullDays	Advance limit for full days	bool	yes	no
resourceType	Resource type	int	no	no
resource	Resource	int	no	no
customerTags	Customer tags	manyToMany	no	no
allowAsGuest	Allow as guest	bool	yes	no
online	Available online	bool	yes	no
uniqueParticipants	Do not repeat participants	bool	yes	no
allowPaymentPending	Allow pending payment	bool	yes	no
allowCancel	Allow cancel	bool	yes	no
cancelLimit	Limit to cancel	duration	no	no
levelMin	Minimum level	int	no	no
levelMax	Maximum level	int	no	no
ageMin	Minimum age	int	no	no
ageMax	Maximum age	int	no	no
gender	Gender	select	no	no
minAmount	Minimum quantity	int	no	no
maxAmount	Maximum quantity	int	no	no
tags	Booking type labels	manyToMany	no	no
color	Text Color	color	no	no
bgColor	Background color	color	no	no
icon	Icon	string	no	no
crossings		BookingCrossing[]	yes	no
category	Category	int	no	no
priority	Priority	int	yes	no
calendar	Calendar	int	no	no
confirmTemplate	Confirmation email	int	no	no
cancelTemplate	Cancellation email	int	no	no
remindTemplate	Reminder email	int	no	no
consumerTags	Card tag	manyToMany	no	no
apiTags	API tags	string	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Values for holidays

Value	Name
0	Include holidays
1	Exclude holidays

Values for gender

Value	Name
0	Mixed
1	Male
2	Female

Customer area alert

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
start	Start date	date	no	no
end	End date	date	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Participant

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
booking	Booking	int	yes	no
bookingType		int	yes	no
name	Name	string	no	no
email	Email	email	no	no
customer	Customer	int	no	no
checkin	Checkin	bool	yes	no
price	Price	currency	yes	no
paid	Paid	bool	yes	yes
online	Signed up online	bool	yes	yes
timeout	Expiration date	datetime	no	yes
start	Start	datetime	yes	no
onlineComments	Online observations	text	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Resource

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
area	Area	int	yes	no
name	Name	string	yes	no
type	Type	int	no	no
slots	Slots	int	no	no
preventMixed	Prevent loose slots	bool	yes	no
priority	Priority	int	no	no
multiple		bool	yes	no
icon		string	yes	no
online	Available online	bool	yes	no
periods		BookingPeriod[]	no	no
color	Background color	color	no	no
minCapacity	Minimum capacity	int	no	no
maxCapacity	Maximum capacity	int	no	no
teacher	Coach	int	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes

Resource type

Endpoints

Fields

Name	Label	Type	Required	Readonly
id	ID	int	no	yes
area	Area	int	yes	no
name	Name	string	yes	no
icon	Icon	string	no	no
isExtra	It is extra	bool	yes	no
assignRandom	Randomly assign	bool	yes	no
multiple	Multiple	bool	yes	no
priority	Priority	int	no	no
online	Available online	bool	yes	no
image	Image	image	no	no
color	Background color	color	no	no
showCheckoutButton	Show checkout button	bool	yes	no
checkoutChangesEndDate	Checkout changes the end date	bool	yes	no
shortDescription	Description	markdown	no	no
consumerTags	Card tag	manyToMany	no	no
created	Creation date	datetime	no	yes
createUser	Created by	int	no	yes
updated	Update date	datetime	no	yes
updateUser	Updated by	int	no	yes
deleted	Removed	bool	no	yes