users

clients_list

Get users list of club

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'clients_list' constant
key	string	true	Security key
params[memberships]	string		Filter users by status in club	leads, leads_passive, leads_active, new_leads_to_call, valid, not_valid, not_valid_recent, future, old, not_active, active, in_stop, in_medical_stop
params[email]	string		Search user by email, exact match
params[last_update]	time		Updated after requested datetime
params[club_id]	integer		Club id from get_clubs command
params[label_id]	string		Search user by label ID (see user/get_labels)
params[page]	integer		Page number
params[limit]	integer		Limit of items to return

Naam	Type		Omschrijving
total_count	integer		Total users count
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { updated_at: date_time Last update on user data, YYYY-MM-DD hh:mm:ss format entered: string Entered by, user name labels: string Labels, coma separated lastname: string Last name inscriptions: hash All inscriptions as hash, returned only if "memberships" param request valid members { index: { inscr_maxvisit: integer Max visits allowed by insription, blank if not limited inscrtype_id: integer Unique ID of membership inscr_last_visit: date Last visit date, DD/MM/YYYY format inscr_visitdone: integer Visits done by inscription, blank if limited inscr_stop_date: date Blank if not stopped, date in DD/MM/YYYY format if stopped manually in some custom date inscr_startdate: date Start date, DD/MM/YYYY format inscr_id: integer Unique ID of inscription period inscrtype_type: integer Inscription type id, Trial = 1, Base = 2, Time = 3, Visit = 4, Season = 6, Put money on card = 7 inscr_enddate: date End date, DD/MM/YYYY format, is normal end date, so will stay same even if inscription stopped inscrtype_name: string Title given by club } } smsLastSent: date smsLastSent date, YYYY-MM-DD format sales: string Sales person name city: string City zipcode: string ZIP valid_member_days: integer valid member days club_card_amount: string Amount left on club card member_number: string Custom id assigned by club. smsSent: integer sms sent 1 or 0 country: string Country name sex: string M or F interjection: string Interjection comment: string General comment brought_by: string Brought by name birthday: date YYYY-DD-MM format email: string Email name: string First name club_card_nr: string Card number assigned to client check_in_pincode: string Check-in pincode campaign: string Campaign title personal_coach: string Personal coach name photo: string Url to image (max 100px size) phone: string Phone number address: string Address mob_phone: string Mobile phone number province: string Reserved for future, blank now club_card_nr_qrcode: string Card QR number assigned to client } }	Users data hash

get_leads_to_call

Get the list of the leads to call

Naam	Type	verplicht	Omschrijving
method	string	true	'get_leads_to_call' constant
key	string	true	Security key
params[page]	integer		Page number
params[limit]	integer		Limit of items to return

Naam	Type		Omschrijving
total_count	integer		Total users count
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { salesperson: string Linked salesperson lastname: string Last name member_number: string Custom id assigned by club. sex: string M or F or empty '' interjection: string Interjection comment: string Comment email: string Email name: string First name address: hash Address details { data: { city: string City zipcode: string ZIP country: string Country name address: string Address } } phone: string Phone number mob_phone: string Mobile phone number } }	Users data hash

get_leads_to_followup

Get the list of the leads to followup

Naam	Type	verplicht	Omschrijving
method	string	true	'get_leads_to_followup' constant
key	string	true	Security key
params[page]	integer		Page number
params[limit]	integer		Limit of items to return

Naam	Type		Omschrijving
total_count	integer		Total users count
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { salesperson: string Linked salesperson lastname: string Last name member_number: string Custom id assigned by club. sex: string M or F or empty '' interjection: string Interjection comment: string Comment email: string Email name: string First name address: hash Address details { data: { city: string City zipcode: string ZIP country: string Country name address: string Address } } phone: string Phone number mob_phone: string Mobile phone number } }	Users data hash

get_leads_not_intrested

Get the list of the leads not intrested

Naam	Type	verplicht	Omschrijving
method	string	true	'get_leads_not_intrested' constant
key	string	true	Security key
params[page]	integer		Page number
params[limit]	integer		Limit of items to return

Naam	Type		Omschrijving
total_count	integer		Total users count
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { salesperson: string Linked salesperson lastname: string Last name member_number: string Custom id assigned by club. sex: string M or F or empty '' interjection: string Interjection comment: string Comment email: string Email name: string First name address: hash Address details { data: { city: string City zipcode: string ZIP country: string Country name address: string Address } } phone: string Phone number mob_phone: string Mobile phone number } }	Users data hash

get_companies

Get the list of the companies

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'get_companies' constant
key	string	true	Security key
params[company_type]	string		Filter users by company type	client, supplier, lead, potential, reseller, insurance, repairer, school
params[page]	integer		Page number
params[limit]	integer		Limit of items to return

Naam	Type		Omschrijving
total_count	integer		Total users count
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { lastname: string Last name outlets: array Connected outlets member_number: string Custom id assigned by club. sex: string M or F or empty '' interjection: string Interjection comment: string Comment email: string Email name: string First name company_type: string Company type address: hash Address details { data: { city: string City zipcode: string ZIP country: string Country name address: string Address } } phone: string Phone number mob_phone: string Mobile phone number } }	Users data hash

get_company

Get the company by ID

Naam	Type	verplicht	Omschrijving
method	string	true	'get_company' constant
key	string	true	Security key
params[company_id]	integer	true	Company database ID

Naam	Type		Omschrijving
users	hash	{ id: { labels: string Labels, coma separated lastname: string Last name standard_sales_values: hash Standard purchase invoice creation values { data: { bookkeeping_diary: hash Bookkeeping diary details amount_vat_deductible: double Amount VAT deductible bookkeeping_type_cost: hash Bookkeeping type cost details percent_vat_deductible: double VAT deductible subject_text: string Subject text price_incl_vat: double Amount incl VAT price_excl_vat: double Amount excl VAT currency: hash Currency vat_amount: double VAT amount standard__values_type: integer Standard invoice values type vat_code: double Vat code bookkeeping_cost_center: hash Bookkeeping cost place details is_recurrent: bool Is recurrent bookkeeping_number: hash Bookkeeping number details tax: hash Tax details process_automatically: bool Is process automatically } } outlets: array Connected outlets member_number: string Custom id assigned by club. financial: hash financial company data { data: { custom_storno_email: string Custom email for Storno/Reminders iban: string IBAN payment_method: hash Default payment method is_do_not_charge_reminders_extra_fee: bool Don't charge extra fee for sending reminders invoice_terms: string Invoice terms sepa_custom_payer: bool Is other parson pay by SEPA vat_nr: string VAT number is_paid_by_company: bool Is paid by company is_no_storno_emails: bool Is no storno kvk: string KVK number fin_account_owner: string Account owner fin_mandate: string Mandate custom_storno: bool Is use custom email for Storno/Reminders fin_mandate_signed_ar: date Mandate signed at group_id: integer Reduction group ID fixed_discount: double Fixed discount % bank_account_status: bool Bank account status: 'true' - is verified, 'false' - is not verified no_reminders: bool Is No reminders is_fixed_discount_date: bool Is use discount date limit fixed_euro_discount: double Fixed discount € invoice_due_days: integer Invoice due days } } is_receive_mailings: bool Nieuwsbrief sex: string M or F or empty '' interjection: string Interjection comment: string Comment fax: string Fax email: string Email name: string First name address: hash Address details { data: { city: string City zipcode: string ZIP country: string Country name address: string Address } } company_type: string Company type phone: string Phone number peppol: hash Peppol data mob_phone: string Mobile phone number standard_purchase_values: hash Standard purchase invoice creation values { data: { bookkeeping_diary: hash Bookkeeping diary details amount_vat_deductible: double Amount VAT deductible bookkeeping_type_cost: hash Bookkeeping type cost details percent_vat_deductible: double VAT deductible subject_text: string Subject text price_incl_vat: double Amount incl VAT price_excl_vat: double Amount excl VAT currency: hash Currency vat_amount: double VAT amount standard__values_type: integer Standard invoice values type vat_code: double Vat code bookkeeping_cost_center: hash Bookkeeping cost place details is_recurrent: bool Is recurrent bookkeeping_number: hash Bookkeeping number details tax: hash Tax details process_automatically: bool Is process automatically } } website: string Website } }	Comapany details

get_valid_clients_small

Get users list of club, shorter/faster than clients_list

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'get_valid_clients_small' constant
key	string	true	Security key
params[page]	integer		Page number
params[per_page]	integer		Limit of items to return
params[memberships]	string		Filter users by status in club	leads, leads_passive, leads_active, valid, not_valid, not_valid_recent, future, old, not_active, active, in_stop, in_medical_stop, user_is_blocked
params[last_update]	time		Updated after requested datetime
params[club_id]	integer		Club id from get_clubs command
params[access]	string		Put 'access' to get all people who linked to club id
params[starters_from]	date		Date to fetch started members, YYYY-MM-DD
params[starters_until]	date		Date to fetch started members, YYYY-MM-DD
params[stopped_from]	date		Date to fetch stopped members, YYYY-MM-DD
params[stopped_until]	date		Date to fetch stopped members, YYYY-MM-DD

Naam	Type		Omschrijving
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { next_reservation: datetime Timestamp of next reservation lastname: string Last name outlet_ids: string Coma separated outlet id's, to use in club_id param to filter members from specific club main_outlet_id: integer Main outlet id qrcode_card: string Card number member_number: string Custom id assigned by club. barcode_card: string Card number sex: string M or F interjection: string Interjection qr_codes: string Coma separated QR code numbers club_card: string Card number glan_card: string Card number email: string Email name: string First name blocked: boolean Is user blocked rfid_card: date Birthday check_in_pincode: string Check-in pincode } }	Users data hash

validate_qr

Validate number without check-in

Naam	Type	verplicht	Omschrijving
method	string	true	'validate_qr' constant
key	string	true	Security key
params[qr_code]	string	true	QR code read from phone

dynamic_qr_firststgen_check_in

Validate number without check-in

Naam	Type	verplicht	Omschrijving
method	string	true	'validate_qr' constant
key	string	true	Security key
params[qr]	string	true	QR code
params[hardware_point_id]	integer	true	QR hardware point id
params[staff_id]	string		Staff that will check in, used to determine outlet
params[outlet_id]	string		Staff that will check in, used to determine outlet

Naam	Type	Omschrijving
user_id	integer	User id in case check in are ok, message if not
visit_id	integer	Visit id
revisit	integer	How many times user checked in today
check_out	date	When check out was registered

dynamic_qr_check_in

Check in using Dynamic-QR

Naam	Type	verplicht	Omschrijving
method	string	true	'dynamic_qr_check_in' constant
key	string	true	Security key
params[qr]	string	true	QR code
params[qr_hardware_point_id]	integer	true	QR hardware point id
params[staff_id]	string		Staff that will check in, used to determine outlet

Naam	Type	Omschrijving
user_id	integer	User id in case check in are ok, message if not
visit_id	integer	Visit id
revisit	integer	How many times user checked in today
check_out	date	When check out was registered

club_card_check_in

Check in using static card number

Naam	Type	verplicht	Omschrijving
method	string	true	'club_card_check_in' constant
key	string	true	Security key
params[club_card_number]	string	true	Club card number
params[hardware_point_id]	string		Hardware point ID
params[staff_id]	string		Staff that will check in, used to determine outlet

Naam	Type	Omschrijving
user_id	integer	User id in case check in are ok, message if not
visit_id	integer	Visit id
revisit	integer	How many times user checked in today

get_valid_clients_vending

Get users list of club, having vending and normal membership

Naam	Type	verplicht	Omschrijving
method	string	true	'get_valid_clients_vending' constant
key	string	true	Security key
params[page]	integer		Page number
params[limit]	integer		Limit of items to return

Naam	Type		Omschrijving
current_page	integer		Page number that was requested
total_pages	integer		Total number of pages for request
users	hash	{ id: { vending_code: string Special qr code number for Vending sales next_reservation: datetime Timestamp of next reservation lastname: string Last name outlet_ids: string Coma separated outlet id's, to use in club_id param to filter members from specific club main_outlet_id: integer Main outlet id qrcode_card: string Card number member_number: string Custom id assigned by club. barcode_card: string Card number sex: string M or F interjection: string Interjection qr_codes: string Coma separated QR code numbers club_card: string Card number glan_card: string Card number email: string Email name: string First name rfid_card: string Card number check_in_pincode: string Check-in pincode } }	Users data hash

client_detail

Get user detail by unique ID

Naam	Type	verplicht	Omschrijving
method	string	true	'client_detail' constant
key	string	true	Security key
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'

Naam	Type	Omschrijving
json_code	integer	Constant value: 14
club_id	integer	Reserved for future, blank now
members_name	string	First name
members_interjection	string	Interjection
members_lastname	string	Last name
members_sex	string	M or F
birthday	date	YYYY-DD-MM format
bank_account	string	Bank account
bank_bic	string	Bank bic
members_address	string	Address
country	string	Country
province	string	Province
members_zipcode	string	Zipcode
members_city	string	City
members_phone	string	Phone
members_mob_phone	string	Mobile phone
members_email	string	Email
personal_coach	string	Personal coach
brought_by	string	Brought by
campaign	string	Campaign
labels	string	Client labels assigned by club, comma separated
entered	string	Entered by
client_photo	string	Url to image (max 100px size)
sales	string	Sales person
club_card_amount	double	Amount stored on club_card
smsSent	integer	sms sent 1 or 0
smsLastSent	date	smsLastSent date, YYYY-MM-DD format

add_money_to_clubcard

Add money to club card

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'add_money_to_clubcard' constant
key	string	true	Security key
payment_reference	string	true
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'
params[payment_method_type_id]	integer	true	Payment method type, 1 = Cash, 2 = Bank, 3 = PIN, 10 = Online	1, 2, 3, 10
params[amount]	double	true	Amount to add to user club card'

Naam	Type	Omschrijving
json_code	integer	Constant value: 14
old_club_card_amount	double	Old amount on club card
club_card_amount	double	Current amount on club card

set_card_number

Set new card number to user

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'get_client_by' constant
key	string	true	Security key
params[field]	string	true	One of the values: club_card_nr, club_card_nr_qrcode	club_card_nr, club_card_nr_qrcode
params[value]	string	true	New value of field
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'

Naam	Type		Omschrijving
json_code	integer		Constant value: 14

update_client_info

Update client info by id

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'update_client_info' constant
key	string	true	Security key
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[bank_bic]	string		Bank bic
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email

Naam	Type		Omschrijving
json_code	integer		Constant value: 14

get_client_by

Get user detail by identifier

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'get_client_by' constant
key	string	true	Security key
params[field]	string	true	One of the values: member_number, club_card_nr, club_card_nr_qrcode	member_number, club_card_nr, club_card_nr_qrcode
params[value]	string	true	Value of field

Naam	Type	Omschrijving
json_code	integer	Constant value: 14
client_id	integer	Uniq id of customer
p_persoon	integer	Custom id assigned by School
club_id	integer	Reserved for future, blank now
members_name	string	First name
members_interjection	string	Interjection
club_card_nr_qrcode	string	Club card QR-code
club_card_nr	string	Card number assigned to client
members_lastname	string	Last name
members_sex	string	M or F
birthday	date	YYYY-DD-MM format
bank_account	string	Bank account
bank_bic	string	Bank bic
members_address	string	Address
country	string	Country
province	string	Province
members_zipcode	string	Zipcode
members_city	string	City
members_phone	string	Phone
members_mob_phone	string	Mobile phone
members_email	string	Email
personal_coach	string	Personal coach
brought_by	string	Brought by
campaign	string	Campaign
instelnr	string	Instelnr
school_name	string	School
vestcode	string	Vestcode
vestiging	string	Vestiging
department	string	Afdeling
depcode	string	Afdcode
department_year	string	Afdelingsjaar
class_name	string	Klas
class_number	string	Klasnr
degree	string	Graad
learn_year	integer	Leerjaar
begin_date	date	Begindatum (YYYY-MM-DD)
end_date	date	Einddatum (YYYY-MM-DD)
stop_date	date	Uitgeschreven (YYYY-MM-DD)
labels	string	Client labels assigned by club, comma separated
entered	string	Entered by
client_photo	string	Url to image (max 100px size)
sales	string	Sales person
club_card_amount	double	Amount stored on club_card
smsSent	integer	sms sent 1 or 0
smsLastSent	date	smsLastSent date, YYYY-MM-DD format

req_clientinfo

Get client info

Naam	Type	verplicht	Omschrijving
method	string	true	'get_client_by' constant
key	string	true	Security key
params[client_id]	integer	true	User database ID, not 'Custom ID assigned by club'

Naam	Type		Omschrijving
json_code	integer		Constant value: 6
member_number	string		Custom id assigned by club
client_name	string		First name
client_interjection	string		Interjection
client_lastname	string		Last name
client_sex	string		M or F
client_birthday	date		YYYY-DD-MM format
client_email	string		Email
client_minutes	double		In development, always return 0.0 now
client_address	string		Client address
client_country	string		Client country
client_province	string		Province
client_client_zipcode	string		Zipcode
client_city	string		City
client_phone	string		Phone
client_mob_phone	string		Mobile
client_club_card_amount	string		Amount left on club card
client_photo	string		Url to image (max 100px size)
personal_coach	string		Personal coach name
brought_by	string		Brought by
campaign	string		Campaign
labels	string		Client labels assigned by club, comma separated
entered	string		Entered by
sales	string		Sales person
smsSent	integer		sms sent 1 or 0
smsLastSent	date		smsLastSent date, YYYY-MM-DD format
comment	string		General comment
client_inscription	hash	{ index: { inscr_maxvisit: integer Max visits allowed by insription, blank if not limited inscrtype_id: integer Unique ID of membership inscr_last_visit: date Last visit date, DD/MM/YYYY format inscr_visitdone: integer Visits done by inscription, blank if limited inscr_stop_date: date Blank if not stopped, date in DD/MM/YYYY format if stopped manually in some custom date inscr_startdate: date Start date, DD/MM/YYYY format inscrtype_type: integer Inscription type id, Trial = 1, Base = 2, Time = 3, Visit = 4, Season = 6, Put money on card = 7 inscr_enddate: date End date, DD/MM/YYYY format, is normal end date, so will stay same even if inscription stopped inscrtype_name: string Title given by club } }	Client inscription data hash

login

Get user unique ID by login/email and password

Naam	Type	verplicht	Omschrijving
method	string	true	'login' constant
key	string	true	Security key
params[username]	string	true	Login
params[password]	string	true	Password

Naam	Type		Omschrijving
client_id	integer		Unique ID

req_add_new_prospect

Add new prospect

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[language_id]	integer		Language ID (See 'get_languages' into General section). 4628 (Dutch) is set if not defined
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email
params[password]	string		Password
params[password]	string		Password confirmation
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[club_card_nr_qrcode]	string		Club card QR-code
params[club_card_nr]	string		Club card code
params[member_number]	integer		Auto generated if blank
params[retention_labels]	array		ID's of labels from 'get_labels' command
params[as_client]	integer		1 to mark user as valid client

Naam	Type	Omschrijving
json_code	integer	Constant value: 29
client_id	integer	Client unique ID
client_number	integer	Client number
username	string	Username
password	string	Password

add_trial

Add new trial/lead

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[lesson_id]	integer	true	Lesson id
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[p_persoon]	integer		Auto generated if blank
params[name]	string	true	First name
params[lastname]	string		Last name
params[phone]	string		Phone number
params[mobile_phone]	string		Mobile phone number
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[email]	string		Email
params[start_date]	date		Start date, DD/MM/YYYY format

Naam	Type	Omschrijving
json_code	integer	Constant value: 33
client_id	integer	Client unique ID
reservation_id	integer	Reservation id added by the call
password	string	Password

get_client_fin_info

Get client invoices

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'get_client_fin_info' constant
key	string	true	Security key
params[field]	string	true	One of the values: id, member_number, club_card_nr, club_card_nr_qrcode	id, member_number, club_card_nr, club_card_nr_qrcode
params[value]	string	true	Value of field

Naam	Type		Omschrijving
invoices	hash	{ index: { date: date Date of booking in ledgers due_date: date Due date pay_url: string Url to pay invoice online title: string Invoice code price: float Paid amount payment_reference: string Payment reference pdf_url: string Url to Pdf } }	Invoices data hash

add_new_student

Add new student

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'add_new_student' constant
key	string	true	Security key
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[bank_bic]	string		Bank bic
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email
params[password]	string		Password
params[password]	string		Password confirmation
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[club_card_nr_qrcode]	string		Club card QR-code
params[club_card_nr]	string		Club card code
params[p_persoon]	integer		Auto generated if blank
params[instelnr]	string		Instelnr
params[school_name]	string		School
params[vestcode]	string		Vestcode
params[vestiging]	string		Vestiging
params[department]	string		Afdeling
params[depcode]	string		Afdcode
params[department_year]	string		Afdelingsjaar
params[class_name]	string		Klas
params[class_number]	string		Klasnr
params[degree]	string		Graad
params[learn_year]	integer		Leerjaar
params[begin_date]	date		Begindatum (YYYY-MM-DD)
params[end_date]	date		Einddatum (YYYY-MM-DD)
params[retention_labels]	array		ID's of labels from 'get_labels' command
params[as_client]	integer		1 to mark user as valid client

Naam	Type	Omschrijving
json_code	integer	Constant value: 31
client_id	integer	Client unique ID
client_number	integer	Client number
username	string	Username
password	string	Password

update_student_information

Update student information

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'update_student_information' constant
key	string	true	Security key
params[field]	string	true	One of the values: member_number, club_card_nr, club_card_nr_qrcode	member_number, club_card_nr, club_card_nr_qrcode
params[value]	string	true	Value of field
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[bank_bic]	string		Bank bic
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email
params[instelnr]	string		Instelnr
params[vestcode]	string		Vestcode
params[vestiging]	string		Vestiging
params[department]	string		Afdeling
params[depcode]	string		Afdcode
params[department_year]	string		Afdelingsjaar
params[class_name]	string		Klas
params[class_number]	string		Klasnr
params[degree]	string		Graad
params[begin_date]	date		Begindatum (YYYY-MM-DD)
params[end_date]	date		Einddatum (YYYY-MM-DD)
params[stop_date]	date		Uitgeschreven (YYYY-MM-DD)
params[smsSent]	boolean		sms sent	0, 1
params[smsLastSent]	date		smsLastSent date (YYYY-MM-DD)
params[school_name]	string		School
params[learn_year]	integer		Leerjaar
params[retention_labels]	array		ID's of labels from 'get_labels' command

Naam	Type		Omschrijving
json_code	integer		Constant value: 32
client_number	integer		Client number

get_student_sales

Get student sales

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'get_student_sales' constant
key	string	true	Security key
params[field]	string	true	One of the values: member_number, club_card_nr, club_card_nr_qrcode	member_number, club_card_nr, club_card_nr_qrcode
params[value]	string	true	Value of field

Naam	Type		Omschrijving
products	hash	{ index: { date: date Date of booking in ledgers title: string Product title price: double Quantity payment_reference: string Payment reference code: string Invoice code: year-order_index } }	Products data hash

get_student_information_query

Get students list by filter

custom_blocks

Get list of custom blocks and fields

custom_blocks_submit

Submit new data to grid style blocks

custom_blocks_values

Read data of blocks of user

mailing

get_user_segments

Get advanced search templates

get_user_segments_details

Get users by extra search segment ID

mailing

Mailing and SMS groups, if details not suppressed, will return all users in group, which can cause speed problems

get_mails_details

Mailing inbox

get_mails

Mailing inbox/outbox

sales

get_sales_invoices

Get user invoices by user identifier

get_invoice

Get user invoice by ID

get_payments

Get all payment by payment method

get_payments_total

Get payments total by payment method by month

purchase

get_purchase_invoices

Get user invoices by user identifier

get_purchase_invoice

Get user invoice by ID

pos

buy_product_from_club_card

Sell product, pay by club card

get_products

Get products list

get_product_categories

Get product categories

get_service_categories

Get service categories

get_service_category

Get service category details

get_services

Get services

get_service

Get service

products

Get products, paginated

user

loyalty

reservations

req_activity_groups

Get activity group types

req_activity_group_details

Get activity group details

req_reservation

Get reservation

req_cancel

Сancel reservation

req_current_reservations

Get current reservation

req_addtowaitlist

Add to waitlist

get_reservations

Get reservations

get_reservation_groups

Get reservation groups

get_reservation_group

Get reservation group

get_waitlist

Get waitlist

reserve_from_waitlist

Move user from waitlist to reservation

req_act_shedule

Return shedule of activities

get_holidays

Get holidays

get_exceptions

Get exceptions

stopperiods

inscriptions

inscrtypes_list_online

Get list of inscription types

inscrtype_activities

Get list of activities of inscription

add_inscription

Add inscription

general

get_clubs

Get outlets list

get_club_info

Get outlets info

get_payment_methods

Get outlet payment methods

get_staffs

Get staffs

get_agenda

Get staff's agenda

get_tasks

Get staff's tasks

get_full_clubs

Get outlets list with POSes

get_departments

Get departments list

get_retention_goals

Get retention goals list

get_task_types

Get task types list

get_task_type

Get task type details

get_retention_activities

Get list of retention activities

get_retention_activity

Get retention activitiy by ID

get_planning

Get planing

get_planning_info

Get planing details

get_leave

Get leave

get_absence

Get absence

get_locations

Get locations

get_branding

Get branding

get_languages

Get languages

visits

external

get_inscription_invoice_date

Get inscription price and pro rata by date

add_new_student_with_inscription

Sell inscription with start date

add_new_student_with_inscription

/cp_api?{"method":"add_new_student_with_inscription", "key":"xxxxxxxx", "params":{......} }

In

Naam	Type	verplicht	Omschrijving	Geldige waardes
method	string	true	'get_inscription_invoice_date' constant
key	string	true	Security key
params[inscription_id]	integer	true	Inscription ID
params[start_date]	date	true	Inscription start date, YYYY-DD-MM format
params[name]	string	true	First name
params[interjection]	string	true	Interjection
params[lastname]	string		Last name
params[members_gender]	boolean		Gender	M, F
params[birthdate]	date		Birthdate, DD/MM/YYYY format
params[address]	string		Address
params[zipcode]	string		ZIP
params[city]	string		City
params[phone]	string		Phone number
params[bank_account]	string		Bank account
params[bank_bic]	string		Bank bic
params[mobile_phone]	string		Mobile phone number
params[comment]	string		General comment
params[email]	string		Email
params[password]	string		Password
params[password]	string		Password confirmation
params[country_id]	integer		Country id, 159 for Netherlands, 20 for Belgium
params[club_id]	integer		Outlet id from get_clubs command
params[club_card_nr_qrcode]	string		Club card QR-code
params[club_card_nr]	string		Club card code
params[p_persoon]	integer		Auto generated if blank
params[instelnr]	string		Instelnr
params[school_name]	string		School
params[vestcode]	string		Vestcode
params[vestiging]	string		Vestiging
params[department]	string		Afdeling
params[depcode]	string		Afdcode
params[department_year]	string		Afdelingsjaar
params[class_name]	string		Klas
params[class_number]	string		Klasnr
params[degree]	string		Graad
params[learn_year]	integer		Leerjaar
params[begin_date]	date		Begindatum (YYYY-MM-DD)
params[end_date]	date		Einddatum (YYYY-MM-DD)
params[payment_method_id]	integer	true	Payment method type, 1 = Cash, 2 = Bank, 3 = PIN, 10 = Online	1, 2, 3, 10

Out

Naam	Type	Omschrijving
json_code	integer	Constant value 30
client_id	integer	Client internal id
inscription_id	integer	Inscription ID that was sold
payment_reference_one	string	Invoice reference number for first period
period_one	float	Total price for first period
payment_reference_two	string	Invoice reference number for next period, blank if no next period
period_two	float	Total price for first period, blank if no next period

GYMXP

get_menu_types

Get menu types

get_nutrition_master_group_foods

Get nutrition master group foods

get_nutrition_food_groups

Get nutrition food groups

get_nutrition_foods

Get nutrition foods

get_nutrition_menu_list

Get nutrition_menu list

get_coaching_exercises

Get coaching exercises

get_coaching_exercise

Get coaching exercise

get_exercise_muslce_regions

Get exercise regions

get_exercise_materials

Get coaching exercise materials

get_exercise_types

Get coaching exercise types

get_meal_types

Get meal types

get_calorie_group_numbers

Get calorie group numbers

get_coaching_categories

Get coaching categories

get_nutrition_menus

Get coaching nutrition menus

get_recipe_types

Get coaching recipe types

get_coaching_recipe_tags

Get coaching recipe tags

get_coaching_recipes

Get coaching recipes

get_coaching_recipe

Get coaching recipe by ID

get_internal_sport_activities

Get internal sport activities

get_coaching_workout_groups

Get coaching workout groups

get_coaching_workout_subgroups

Get coaching workout subgroups

get_coaching_workouts

Get coaching workouts

get_coaching_workout

Get coaching workout

get_coaching_targets

Get coaching targets

get_coaching_target

Get coaching target

get_client_body_composition

Get user body composition

get_valid_clients_benfit

Get valid clients benfit

Bookkeeping

get_ledger_types

Get ledger types

get_ledger_modules

Get list of modules linked to the ledger

get_ledger_groups

Get ledger groups

get_ledgers

Get ledgers

get_ledger

Get ledger

get_tax_types

Get list of taxes types

get_tax_eu_services

Get list of taxes eu_services

get_taxes

Get taxes

get_tax

Get tax

get_bookkeeping_number_diaries

Get bookkeeping number diaries

get_bookkeeping_cost_centers

Get bookkeeping number cost centers

get_bookkeeping_cost_types

Get bookkeeping number cost types

Naam	Type	verplicht	Omschrijving
params[user_id]	integer	true	User ID from clients_list
params[block_id]	integer	true	Block ID from custom_blocks command
params[fields]	hash	true	Hash of values, key is ID of field from custom_blocks, value is actual value to store

Naam	Type	Omschrijving
user_id	integer	Uniq id of user
member_number	string	Custom id assigned (member number)
user_name	string	First name
user_interjection	string	Interjection
user_lastname	string	Last name
user_gender	string	M or F
birthday	date	YYYY-DD-MM format
user_address	string	Address
country	string	Country
user_zipcode	string	Zipcode
user_city	string	City
user_phone	string	Phone
user_mob_phone	string	Mobile phone
user_email	string	Email
users	hash	Users data hash

Naam	Type	Omschrijving
params[club_id]	integer	Club id, not implemented, now all mailings/sms groups is global
params[SMSGroups]	boolean	Sms group, 0 - get mailing groups, 1 - get sms groups
params[group]	integer	Group id, return all or specific group by id
params[suppress_details]	boolean	Suppress details, 0 - get users in groups, 1 - only name and id of groups returned

Naam	Type	Omschrijving	Geldige waardes
params[email_type]	string	Gender	all, in, out
params[from]	string	Date from 'YYYY-MM-DD hh:mm'. By default, the start of the month is used if no time is specified.
params[until]	string	Date until YYYY-MM-DD hh:mm'. Default is the current time if no time is specified
params[field]	string	One of the values: id, member_number, email	id, member_number, email
params[value]	string	Value of field
params[page]	integer	Page number
params[limit]	integer	Limit of items to return

Naam	Type		Omschrijving
count	integer		Total count of services
services	hash	{ id: { order_idx: integer Unique ID of service title: string Title of service } }	Services data hash

Naam	Type		Omschrijving
json_code	integer		Constant value: 2
activities	hash	{ index: { location: hash Location. See General 'get_locations' command schedule: hash Activity start times { index: { start: time Activity start time, HH:MM:SS format waitlist_size: integer Number of users in waitlist available: integer Free places left id: integer Lesson id (of specific time/place) } } staff_name: string Name of staff activity_id_name: string Activity title start_time: time Time of first lesson starts staff_id: integer ID of staff capacity: integer Maximum capacity of persons end_time: time Time of finishing lesson ext_description: string Name of staff activity_id: integer Activity ID description: string Basic description of activity } }	Activities data hash

Naam	Type	verplicht	Omschrijving
params[count]	integer		Сount reservations
params[client_id]	integer	true	Client ID
params[date_time]	date	true	Date time, dd/mm/yyyy HH:MM:SS
params[activity_id]	integer	true	Activity ID

Naam	Type		Omschrijving
waitlist	hash	{ index: { user_id: integer User ID id: integer Waitlist ID user_name: string Full name of user } }	waitlist data hash
activity_title	string		Activity title

Naam	Type		Omschrijving
status	boolean		Is operation done
message	string		Text explanation of error/success result

Naam	Type	Omschrijving
params[sub_type_id]	integer	0 - Activity, 1 - Event, 2 - Workshop
params[staff_id]	integer	ID of staff from 'clients_list'
params[club_id]	integer	Club ID of staff from 'get_clubs'

Naam	Type	Omschrijving
json_code	integer	Constant value: 30
client_id	integer	Unique ID of user
inscription_id	integer	Unique ID of inscription period
to_pay	double	Invoice unpaid amount
total	double	Total price

Naam	Type	verplicht	Omschrijving	Geldige waardes
params[date]	date	true	Date YYYY-MM-DD format
params[club_id]	integer	true	Club ID

Naam	Type	verplicht	Omschrijving
params[time]	DateTime	true	DateTime YYYY-MM-DD hh:mm format. 30 min ago be default
params[club_id]	integer		Club ID
params[page]	integer		Page number
params[limit]	integer		Limit of items to return

Naam	Type	verplicht	Omschrijving
params[visits]	array	true	Array of hash values, in hash - keys are 'user_id' or 'member_number' and 'at', where at is time field in YYYY-MM-DD HH:MM:SS format
params[user_id]	string		User id
params[member_number]	integer		Member number
params[qr_code]	string		If special QR-codes option is ON
params[member_number]	integer		Member number

Naam	Type	Omschrijving
saved	integer	Count of saved records
saved	integer	Count of saved records
errors	array	Errors of not saved records

Naam	Type	Omschrijving
total	float	Total price to be paid by client
pro_rata	float	Price per period, discount is applied for this
start_fee	float	Membership start fee
period_price	float	Total pro rata price to be paid by client for all period

Hoe het werkt

users

clients_list

clients_list

In

Out

get_leads_to_call

get_leads_to_call

In

Out

get_leads_to_followup

get_leads_to_followup

In

Out

get_leads_not_intrested

get_leads_not_intrested

In

Out

get_companies

get_companies

In

Out

get_company

get_company

In

Out

get_valid_clients_small

get_valid_clients_small

In

Out

validate_qr

validate_qr

In

Out

dynamic_qr_firststgen_check_in

dynamic_qr_firststgen_check_in

In

Out

dynamic_qr_check_in

dynamic_qr_check_in

In

Out

club_card_check_in

club_card_check_in

In

Out

get_valid_clients_vending

get_valid_clients_vending

In

Out

client_detail

client_detail

In

Out

add_money_to_clubcard

add_money_to_clubcard

In

Out

set_card_number

set_card_number

In

Out

update_client_info

update_client_info

In

Out

get_client_by

get_client_by

In

Out

req_clientinfo

req_clientinfo

In

Out

login

login

In

Out

req_add_new_prospect

req_add_new_prospect