| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'clients_list' constant | ||
| key | string | 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 }mob_phone: string city: string zipcode: string sex: string smsSent: integer club_card_amount: string email: string inscriptions: hash { smsLastSent: dateindex: { }inscrtype_type: integer }inscrtype_id: integer inscr_visitdone: integer inscr_maxvisit: integer inscr_startdate: date inscrtype_name: string inscr_last_visit: date inscr_id: integer inscr_stop_date: date inscr_enddate: date sales: string entered: string campaign: string brought_by: string photo: string interjection: string labels: string phone: string province: string valid_member_days: integer club_card_nr: string birthday: date country: string member_number: string address: string lastname: string name: string club_card_nr_qrcode: string personal_coach: string check_in_pincode: string comment: string |
Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_leads_to_call' constant | ||
| key | string | 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: { }sex: string }mob_phone: string email: string interjection: string phone: string salesperson: string member_number: string address: hash { lastname: stringdata: { }city: string }zipcode: string country: string address: string name: string comment: string |
Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_leads_to_followup' constant | ||
| key | string | 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: { }sex: string }mob_phone: string email: string interjection: string phone: string salesperson: string member_number: string address: hash { lastname: stringdata: { }city: string }zipcode: string country: string address: string name: string comment: string |
Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_leads_not_intrested' constant | ||
| key | string | 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: { }sex: string }mob_phone: string email: string interjection: string phone: string salesperson: string member_number: string address: hash { lastname: stringdata: { }city: string }zipcode: string country: string address: string name: string comment: string |
Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_companies' constant | ||
| key | string | 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: { }company_type: string }sex: string mob_phone: string outlets: array email: string interjection: string phone: string member_number: string address: hash { lastname: stringdata: { }city: string }zipcode: string country: string address: string name: string comment: string |
Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_company' constant | ||
| key | string | Security key | ||
| params[company_id] | integer | true | Company database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| users | hash |
{
id: { }is_receive_mailings: bool }company_type: string sex: string mob_phone: string fax: string outlets: array email: string website: string interjection: string standard_purchase_values: hash { labels: stringdata: { }bookkeeping_type_cost: hash }price_incl_vat: double standard__values_type: integer bookkeeping_cost_center: hash vat_amount: double amount_vat_deductible: double tax: hash bookkeeping_number: hash price_excl_vat: double bookkeeping_diary: hash process_automatically: bool currency: hash percent_vat_deductible: double is_recurrent: bool subject_text: string vat_code: double phone: string member_number: string standard_sales_values: hash { address: hashdata: { }bookkeeping_type_cost: hash }price_incl_vat: double standard__values_type: integer bookkeeping_cost_center: hash vat_amount: double amount_vat_deductible: double tax: hash bookkeeping_number: hash price_excl_vat: double bookkeeping_diary: hash process_automatically: bool currency: hash percent_vat_deductible: double is_recurrent: bool subject_text: string vat_code: double { lastname: stringdata: { }city: string }zipcode: string country: string address: string name: string financial: hash { comment: stringdata: { }is_no_storno_emails: bool }vat_nr: string fin_account_owner: string is_do_not_charge_reminders_extra_fee: bool no_reminders: bool invoice_due_days: integer fin_mandate: string group_id: integer kvk: string is_paid_by_company: bool custom_storno: bool invoice_terms: string iban: string custom_storno_email: string sepa_custom_payer: bool bank_account_status: bool fin_mandate_signed_ar: date is_fixed_discount_date: bool fixed_euro_discount: double fixed_discount: double payment_method: hash |
Comapany details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_valid_clients_small' constant | ||
| key | string | 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 | |
| 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: { }sex: string }glan_card: string email: string next_reservation: datetime rfid_card: date qr_codes: string barcode_card: string interjection: string qrcode_card: string club_card: string member_number: string lastname: string name: string outlet_ids: string main_outlet_id: integer check_in_pincode: string |
Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'validate_qr' constant | ||
| key | string | Security key | ||
| params[qr_code] | string | true | QR code read from phone |
| Naam | Type | Omschrijving |
|---|
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'dynamic_qr_check_in' constant | ||
| key | string | Security key | ||
| params[qr] | string | QR code | ||
| params[qr_hardware_point_id] | integer | 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'club_card_check_in' constant | ||
| key | string | Security key | ||
| params[club_card_number] | string | Club card number | ||
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_valid_clients_vending' constant | ||
| key | string | 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: { }sex: string }glan_card: string email: string next_reservation: datetime rfid_card: string qr_codes: string vending_code: string barcode_card: string interjection: string qrcode_card: string club_card: string member_number: string lastname: string name: string outlet_ids: string main_outlet_id: integer check_in_pincode: string |
Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'client_detail' constant | ||
| key | string | 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 | ||
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'add_money_to_clubcard' constant | ||
| key | string | Security key | ||
| payment_reference | string | |||
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_client_by' constant | ||
| key | string | 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'update_client_info' constant | ||
| key | string | 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 |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| json_code | integer | Constant value: 14 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_client_by' constant | ||
| key | string | 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 | ||
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_client_by' constant | ||
| key | string | 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 | ||
| 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: { }inscrtype_type: integer }inscrtype_id: integer inscr_visitdone: integer inscr_maxvisit: integer inscr_startdate: date inscrtype_name: string inscr_last_visit: date inscr_stop_date: date inscr_enddate: date |
Client inscription data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'login' constant | ||
| key | string | Security key | ||
| params[username] | string | true | Login | |
| params[password] | string | true | Password |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| client_id | integer | Unique ID |
| 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[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 | |||
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[name] | 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 | |||
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_client_fin_info' constant | ||
| key | string | 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 | |
|---|---|---|---|
| invocies | hash |
{
index: { }due_date: date }pdf_url: string price: float title: string date: date pay_url: string payment_reference: string |
Invocies data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'add_new_student' constant | ||
| key | string | 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 | |||
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'update_student_information' constant | ||
| key | string | 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 | |||
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_student_sales' constant | ||
| key | string | 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: { }price: double }title: string date: date code: string payment_reference: string |
Products data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_student_information_query' constant | ||
| key | string | Security key | ||
| params[instelnr] | string | Filter students by Instelnr | ||
| params[school_name] | string | Filter students by School | ||
| params[vestcode] | string | Filter students by Vestcode | ||
| params[vestiging] | string | Filter students by Vestiging | ||
| params[department] | string | Filter students by Afdeling | ||
| params[depcode] | string | Filter students by Afdcode | ||
| params[department_year] | string | Filter students by Afdelingsjaar | ||
| params[class_name] | string | Filter students by Klas | ||
| params[class_number] | string | Filter students by Klasnr | ||
| params[degree] | string | Filter students by Graad | ||
| params[learn_year] | integer | Filter students by Leerjaar | ||
| params[begin_date] | date | Filter students by Begindatum (YYYY-MM-DD) | ||
| params[end_date] | date | Filter students by Einddatum (YYYY-MM-DD) | ||
| params[stop_date] | date | Filter students by Uitgeschreven (YYYY-MM-DD) | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| p_persoon | string | Custom id assigned by School | |
| club_card_nr_qrcode | string | Club card QR-code | |
| club_card_nr | string | Card number assigned to client | |
| student_id | integer | Uniq id of student | |
| student_name | string | First name | |
| student_interjection | string | Interjection | |
| student_lastname | string | Last name | |
| student_gender | string | M or F | |
| birthday | date | YYYY-DD-MM format | |
| bank_account | string | Bank account | |
| bank_bic | string | Bank bic | |
| student_address | string | Address | |
| country | string | Country | |
| student_zipcode | string | Zipcode | |
| student_city | string | City | |
| student_phone | string | Phone | |
| student_mob_phone | string | Mobile phone | |
| student_email | string | ||
| 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 | |
| current_page | integer | Page number that was requested | |
| total_pages | integer | Total number of pages for request | |
| users | hash | Users data hash |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| blocks | hash |
{
index: { }id: integer }fields: hash { title: stringindex: { }Title: string }id: integer values: string is_required: boolean type_id: integer |
Blocks |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| 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 | |
|---|---|---|---|
| saved | integer | Count of saved records |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[user_id] | integer | true | User ID from clients_list | |
| params[block_id] | integer | true | Block ID from custom_blocks command |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| data | hash |
{
index: { }index: string } |
Data |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_user_segments' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| user_segments | hash |
{
id: { }outlet: hash }title: string |
Advanced search templates |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_service_category' constant | ||
| key | string | Security key | ||
| params[segment_id] | integer | true | Service category database ID | |
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| 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 | ||
| users | hash | Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| 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 | |
|---|---|---|---|
| groups | hash |
{
index: { }group_id: integer }group_values: hash { group_name: stringindex: { }mailing_name: string }members_mob_phone: string username: string mailing_lastname: string mailing_interjection: string mailing_email: string password: string |
Groups |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_sales_invoices' constant | ||
| key | string | 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: { }due_date: date }pdf_url: string id: integer price: double date: date payments: hash { type_id: integerindex: { }at: datetime }payment_method: string amount: double code: string paid: double payment_reference: string |
Invoices data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_invoice' constant | ||
| key | string | Security key | ||
| params[invoice_id] | integer | true | Invoice database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| invoice | hash |
{
id: { }due_date: date }pdf_url: string products: array [ price: double{ ]quantity: double }bookkeeping_type_cost: hash vat_price: double bookkeeping_tax: hash bookkeeping_cost_center: hash price: double custom_product_name: string vat_deductible: double line_number: integer bookkeeping_number: hash excl_vat_price: double vat: double bookkeeping_diary: hash discount_fixed: double description: string summable_discount: double discount_percent: double product: hash total_price: double vat_deductible_total: double date: date vat_total: double payments: hash { type_id: integerindex: { }at: datetime }payment_method: string amount: double discount_total: double code: string paid: double payment_reference: string |
Invoice details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_payments' constant | ||
| key | string | Security key | ||
| params[payment_method_type_id] | integer | true | Payment method type, 1 = Cash, 2 = Bank, 3 = PIN, 10 = Online | 1, 2, 3, 10 |
| data_from | string | Start data('yyyy-mm-dd') of period | ||
| data_to | string | End data('yyyy-mm-dd') of period | ||
| by_terminal | string | Select payment payd by terminal. Only for PIN. |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| payments | hash | Payments data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_payments' constant | ||
| key | string | Security key | ||
| params[payment_method_type_id] | integer | true | Payment method type, 1 = Cash, 2 = Bank, 3 = PIN, 10 = Online | 1, 2, 3, 10 |
| data_from | string | Start data('yyyy-mm-dd') of period | ||
| data_to | string | End data('yyyy-mm-dd') of period | ||
| by_terminal | string | Select payment payd by terminal. Only for PIN. |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| payments | hash | Payments data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'buy_product_from_club_card' constant | ||
| key | string | Security key | ||
| params[client_id] | integer | true | User database ID, not 'Custom ID assigned by club' | |
| params[product_id] | integer | true | Product database ID | |
| params[quantity] | integer | true | Quantity of products to sell | |
| params[amount] | double | true | Total amount in format 123.45 |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| json_code | integer | Constant value: 6 | |
| old_club_card_amount | double | Amount on club card before sale | |
| club_card_amount | double | Amount on club card after sale |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_products' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| products | hash |
{
index: { }vatpercent: double }category_id: integer articleno: string priceinclvat: double prod_id: integer title: string descr: string priceexclvat: double destroyed: boolean |
Products data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_product_categories' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| categories | hash |
{
index: { }category_id: integer }title: string |
Categories data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_service_categories' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| categories | hash |
{
index: { }category_id: integer }title: string |
Service categories data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_service_category' constant | ||
| key | string | Security key | ||
| params[category_id] | integer | true | Service category database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| category | hash |
{
id: { }order_idx: integer }outlet: string department: hash parent: hash title: string show_in_pos: boolean show_on_site: boolean staffs: array color: string logo: string |
Service categoriy data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_services' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| count | integer | Total count of services | |
| services | hash |
{
id: { }order_idx: integer }title: string |
Services data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_service' constant | ||
| key | string | Security key | ||
| params[service_id] | integer | true | Service database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| service | hash |
{
id: { }order_idx: integer }service_duration: integer outlets: array service_after: hash in_pos: boolean service_type: string prepayment_percent: double article_number: integer is_show_online: boolean barcode: string staffs: array category: hash service_before: hash selling_total_price_rounded: double color_in_pos: string |
Services data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'products' constant | ||
| key | string | Security key | ||
| params[in_stock] | boolean | Get products in stock^ 1 - in stock | ||
| 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 | |
| products | hash |
{
id: { }pos_ids: array }price: double title: string vat: double outlet_ids: array |
Products data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_labels' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| labels | hash |
{
index: { }title: string }label_id: integer max_per_day: double allowed_minus: double |
Labels data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_labels' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| company_labels | hash |
{
index: { }title: string }color: string label_id: integer |
Company Labels data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'req_activity_groups' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| groups | hash |
{
index: { }event: string }group_id: string group_name: string |
Group types data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'req_activity_group_details' constant | ||
| key | string | Security key | ||
| params[date] | date | Date | ||
| params[group_id] | integer | Activity group type ID | ||
| params[club_id] | integer | Outlet id from get_clubs command |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| json_code | integer | Constant value: 2 | |
| activities | hash |
{
index: { }staff_name: string }activity_id: integer capacity: integer end_time: time ext_description: string staff_id: integer schedule: hash { description: stringindex: { }id: integer }start: time waitlist_size: integer available: integer start_time: time activity_id_name: string |
Activities data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| 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 | |
|---|---|---|---|
| json_code | integer | Constant value: 4 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[count] | integer | Сount reservations | ||
| params[client_id] | integer | true | Client ID | |
| params[date_time] | date | true | Date | |
| params[activity_id] | integer | true | Activity ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| json_code | integer | Constant value: 4 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[client_id] | integer | true | Client ID | |
| params[start_date] | date | true | Start date | |
| params[end_date] | date | true | End date |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| activities | hash |
{
index: { }price: string }start: time activity_id: integer count: string date: date activity_id_name: string status: string |
Activities data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[client_id] | integer | true | Client ID | |
| params[date_time] | date | true | Date | |
| params[activity_id] | integer | true | Activity ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| json_code | integer | Constant value: 37 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[date_time] | date | true | Date time, dd/mm/yyyy HH:MM:SS | |
| params[activity_id] | integer | true | Activity ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| reservations | hash |
{
index: { }id: integer }user_id: integer |
Reservations data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_reservation_groups' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| reservation_groups | hash |
{
id: { }title: string } |
Reservation group, id and title |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_reservation_group' constant | ||
| key | string | Security key | ||
| params[group_id] | integer | true | Reservation group database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| reservation_group | hash |
{
id: { }by_gender: string }booked_until: string activity_title: string activity_type: string clear_user_list: array users: array title: string max_capacity: integer waiting_list: array date_time: string max_trial_lesson_limit: integer max_waiting_list_capacity: integer capacity_taken: integer avg_age: integer |
Reservation group details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| 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_name: string }id: integer user_id: integer |
waitlist data hash |
| activity_title | string | Activity title |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[waitlist_id] | integer | true | Waitlist ID from 'get_waitlist' |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| status | boolean | Is operation done | |
| message | string | Text explanation of error/success result |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| 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 | |
|---|---|---|---|
| shedule | hash |
{
index: { }club_id: integer }is_active: boolean group_id: integer activity_id: integer with_membership_price: double enddate: date staff_id: integer no_membership_price: double sub_type_id: integer startdate: date activity_id_name: string shedule: hash { index: { }weekday: integer }start: time |
Shedule |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| holidays | hash | Holidays |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[client_id] | integer | true | Client ID | |
| params[start_date] | date | true | Start date | |
| params[weeks] | string | true | Weeks of stopperiod |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| json_code | integer | Constant value: 25 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[client_id] | integer | true | Client ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| stopperiods | hash |
{
index: { }reason: string }start_date: date end_date: date |
Stopperiods data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[client_id] | integer | true | Client ID | |
| params[start_date] | date | true | Start date YYYY-MM-DD format |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| json_code | integer | Constant value: 37 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'inscrtypes_list_online' constant | ||
| key | string | Security key | ||
| params[club_id] | integer | Club ID of staff from 'get_clubs' |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| inscrtypes | hash |
{
index: { }free_period_membership_id: integer }have_custom_link_of_activities: boolean is_active: boolean start_from_first_of_month: boolean id: integer price_start_one: hash price: double payment_period_title: string period_title: string type: integer is_show_in_reports: bool price_one: hash description: string online_discount_description: string auto_renew: boolean name: string price_start_two: hash price_two: hash |
Memberships data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'inscrtype_activities' constant | ||
| key | string | Security key | ||
| params[inscription_id] | integer | true | Unique ID of inscription period |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| inscrtype_activities | hash |
{
index: { }free_period_membership_id: integer }description: string online_discount_description: string |
Activities data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[client_id] | integer | true | Client ID | |
| params[inscription_id] | integer | true | Unique ID of inscription period | |
| params[start_date] | date | true | Start date YYYY-MM-DD format | |
| params[discount_percent] | double | Discount percent - leading | ||
| params[discount_money] | double | Discount money | ||
| params[prepaid_amount] | double | Prepaid amount | ||
| params[payment_method] | integer | Payment method, where 1 = Cash, 2 = Bank, 5 = SEPA, 10 = Online | 1, 2, 5, 10 |
| 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 |
|---|---|---|---|---|
| method | string | 'get_clubs' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| clubs | hash |
{
id: { }title: string } |
Outlets, id and title |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_club_info' constant | ||
| key | string | Security key | ||
| params[outlet_id] | integer | true | Club database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| clubs | hash |
{
id: { }vat_nr: string }city: string fax: string physical_house_nr: string email: string facebook_url: string website: string kvk: string latitude: string title: string iban: string language: string phone: string instragram_url: string longitude: string physical_address: string zip: string country: string pwa_logo: string business_bank_code: string physical_house_nr_two: string logo: string short_title: string |
Info for Outlet |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_staffs' constant | ||
| key | string | Security key | ||
| params[club_id] | integer | Club id from get_clubs command | ||
| params[access] | string | Put 'access' to get all people who linked to club id | access, admin | |
| 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 | |
| staffs | hash |
{
id: { }sex: string }agreement_commission_amount: double date_service: date insurance_number: string glan_card: string email: string id: integer rfid_card: string barcode_card: string interjection: string photo: string title: string qrcode_card: string commission_vat_person: double club_card: string color_mark: string tax_credit: date member_number: string agreement_subtype_title: string agreement_type_title: string lastname: string bsn_number: string |
Staffs, id and title |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| clubs | hash |
{
id: { }poses: hash }{ id: integerid: { }id: integer }title: string title: string |
Outlets info |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_departments' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| departments | hash |
{
id: { }title: string } |
Departments, id and title |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_retention_goals' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| retention_goals | hash |
{
id: { }title: string }description: string retention_activities: array average_visit_frequency: double coaching_target: hash |
Retention goals, id and title |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_task_types' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| task_types | hash |
{
id: { }title: string } |
Task types, id and title |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_task_type' constant | ||
| key | string | Security key | ||
| params[task_id] | integer | true | Task type database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| task_type | hash |
{
id: { }reminder_min: integer }department: hash is_schow_in_lead_manager: boolean title: string is_schow_in_coaching: boolean is_show_in_retention_manager: boolean color: string |
Task type details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_retention_activities' constant | ||
| key | string | 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 | |
| retention_activities | hash |
{
id: { }title: string } |
Retention activities data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_retention_activities' constant | ||
| key | string | Security key | ||
| params[retention_activity_id] | integer | true | Retention activity ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| retention_activity | hash |
{
id: { }is_no_show_in_reports: boolean }is_active: boolean is_no_send_reminder: boolean public_title: string capacity: integer full_description: string title: string is_no_show_in_continuation: boolean is_no_confirmation_required: boolean retention_activity_follow_ups: array duration: integer retention_goals: array is_no_show_in_customer_satisfaction: boolean is_startable: boolean |
Task type details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_planning' constant | ||
| key | string | Security key | ||
| params[staff_id] | integer | Staff ID | ||
| params[from] | string | Date from 'YYYY-mm-dd'. Default is the beginning of the current month if no date is specified) | ||
| params[until] | string | Date until YYYY-mm-dd'. Default is the end of the current year if no date is specified) | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| planning | hash |
{
id: { }work_time: string }date_until: date description: hash color: string date_from: date |
Planning |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_planning' constant | ||
| key | string | Security key | ||
| params[planning_id] | integer | true | Planning ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| planning | hash |
{
id: { }work_time: string }date_until: date department: hash location: hash date: date status_title: string description: hash day_part: string color: string hours: integer weekday_name: array date_from: date |
Staff planning details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_leave' constant | ||
| key | string | Security key | ||
| params[staff_id] | integer | Staff ID | ||
| params[status_id] | integer | Status ID (Pending: 0, Scheduled: 1, Taken: 2, Rejected: 3, Cancelled: 4) | 0, 1, 2, 3, 4 | |
| params[from] | string | Date from 'YYYY-mm-dd'. Default is the beginning of the current month if no date is specified) | ||
| params[until] | string | Date until YYYY-mm-dd'. Default is the end of the current year if no date is specified) | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| leave | hash |
{
id: { }date_until: date }status: string comment: string date_from: date staff: hash |
Leave |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_absence' constant | ||
| key | string | Security key | ||
| params[staff_id] | integer | Staff ID | ||
| params[status_id] | integer | Status ID (Pending: 0, Scheduled: 1, Taken: 2, Rejected: 3, Cancelled: 4) | 0, 1, 2, 3, 4 | |
| params[from] | string | Date from 'YYYY-mm-dd'. Default is the beginning of the current month if no date is specified) | ||
| params[until] | string | Date until YYYY-mm-dd'. Default is the end of the current year if no date is specified) | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| absence | hash |
{
id: { }date_until: date }status: string comment: string date_from: date staff: hash |
Absence |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| params[date] | date | true | Date YYYY-MM-DD format | |
| params[club_id] | integer | true | Club ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| visits | hash |
{
index: { }client_id: integer }date_time: date |
Visits |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| 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 | Omschrijving | |
|---|---|---|---|
| visits | hash |
{
index: { }activities: array }membership_info: hash client_id: integer date_time: date |
Visits |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| 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 | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_inscription_invoice_date' constant | ||
| key | string | Security key | ||
| params[inscription_id] | integer | Inscription ID | ||
| params[date] | date | Inscription start date, YYYY-DD-MM format |
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_inscription_invoice_date' constant | ||
| key | string | Security key | ||
| params[inscription_id] | integer | Inscription ID | ||
| params[start_date] | date | 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 | |||
| 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 |
| 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 |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_menu_types' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| menu_types | hash |
{
id: { }title: string } |
Nutrition menu types |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_nutrition_master_group_foods' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| master_group_foods | hash |
{
id: { }title: string }source_title: string |
Nutrition master group_foods |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_nutrition_food_groups' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| group_foods | hash |
{
id: { }title: string }source_title: string |
Nutrition food groups |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_nutrition_foods' constant | ||
| key | string | Security key | ||
| params[master_food_group_id] | integer | master food group ID | ||
| params[food_group_id] | integer | Food group ID | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| nutrition_foods | hash |
{
id: { }nutrition_master_food_group: hash }prot: double use_mult: boolean nutrition_food_group: hash quan: double title: string weight: string image_path: string carb: double kcal: double group: integer source_title: string fatt: double gr: integer |
Nutrition foods list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_nutrition_menu_list' constant | ||
| key | string | Security key | ||
| params[nutrition_menutype_id] | integer | nutrition menutype ID | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| menu_list | hash |
{
id: { }type_idx: integer }cal_group: integer number: integer title: string day_idx: integer source_title: string nutrition_menu_type: hash |
Nutrition foods list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_exercises' constant | ||
| key | string | Security key | ||
| params[image_set] | integer | Image type: 1 - 3D ; 2 - Pictures ; 3 - Video's ; | 1, 2, 3 | |
| params[region_id] | integer | region ID | ||
| params[materials] | integer | Material ID | ||
| params[type] | integer | Exercise type (see 'get_exercise_types') | ||
| params[source] | integer | Source IDx: 1 - CTRL+ ; 2 - Club; 3 - Favorites | 1, 2, 3 | |
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_exercises | hash |
{
id: { }image_set_title: hash }exercise_type: hash title: string coaching_materials: array coaching_exercise_regions: array source_title: string |
Nutrition foods list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_exercise' constant | ||
| key | string | Security key | ||
| params[exercise_id] | integer | true | Exercise database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| exercise | hash |
{
id: { }standard_parameters: hash }{ title: stringorder_idx: { }value_2: hash }value_1: hash type_title: string unit: hash set_types_title: string coaching_materials: array coaching_exercise_regions: array description: string source_title: string images: array video_url: string image_set: hash |
Coaching exercise details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_exercise_muslce_regions' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| exercise_regions | hash |
{
id: { }title: string } |
Exercise region list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_exercise_materials' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| exercise_materials | hash |
{
id: { }title: string } |
Exercise materials list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_exercise_types' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| exercise_types | hash |
{
id: { }title: string } |
Exercise type list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_meal_types' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| meal_types | hash |
{
id: { }title: string } |
Exercise type list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_calorie_groups' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| calorie_group_numbers | array | Calorie group numbers list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_categories' constant | ||
| key | string | Security key | ||
| params[parent_id] | integer | true | Parent category ID | |
| params[type_idx] | integer | true | Type category: 1 - Articles ; 2 - Exercises ; 3 - Recipes ; 4 - Videos | 1, 2, 3, 4 |
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_categories | hash |
{
id: { }order_idx: integer }is_show_on_portal: boolean is_show_on_online_lesson: boolean sorting: string parent: Hash title: string is_show_on_lifestyle: boolean image: string category_type: hash |
Coaching categories list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_nutrition_menus' constant | ||
| key | string | Security key | ||
| params[calorie_group] | integer | Calorie group number (see 'get_calorie_group_numbers') | ||
| params[meal_idx] | integer | Meal index (see 'get_meal_types') | ||
| params[food_id] | integer | Nutrition food id (see 'get_nutrition_foods') | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| nutrition_menus | hash |
{
id: { }meal: hash }prot: double nutrition_food: hash quan: double title: integer carb: double kcal: double day_idx: integer source_title: string fatt: double unit: string |
coaching nutrition menus list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_recipe_types' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| recipe_types | hash |
{
id: { }title: string } |
Coaching recipe types list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_recipe_tags' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_recipe_tags | hash |
{
id: { }order_idx: integer }title: string image: string color: string |
Coaching recipe tags list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_recipes' constant | ||
| key | string | Security key | ||
| params[category_id] | integer | Coaching category ID id (see 'get_coaching_categories') | ||
| params[visibility] | integer | Visibility type : 1 - Draft ; 2 - Published ; | 1, 2 | |
| params[recipe_type_id] | integer | Recipe type ID (see 'get_recipe_types') | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_recipes | hash |
{
id: { }visibility: string }title: string recipe_type: hash image: string coaching_category: hash |
Coaching recipe list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_recipe' constant | ||
| key | string | Security key | ||
| params[recipe_id] | integer | true | Coaching recipe database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_recipe | hash |
{
id: { }prot: double }prepration_time: string title: string nutrition_macros: text recipe_type: hash remarks: text prerparation_method: text ingredients: text carb: text kcal: double description: text settings: hash { number_of_persons: integerdata: { }is_always: boolean }visibility: string is_show_logo: boolean visibile_until: date visibile_from: date image: string fatt: double |
Coaching recipe details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_internal_sport_activities' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| sport_activities | hash |
{
id: { }is_not_sport_activity: boolean }title: string kcal_per_hour: double image: string coefficient_threshold: double |
Internal API sport activities |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_workout_groups' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| workout_groups | hash |
{
id: { }title: string } |
Coaching workout groups list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_workout_subgroups' constant | ||
| key | string | Security key | ||
| params[main_group_id] | integer | Workout group ID id (see 'get_coaching_workout_groups') | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| workout_subgroups | hash |
{
id: { }title: string }main_group: hash |
Coaching workout subgroups list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_workouts' constant | ||
| key | string | Security key | ||
| params[main_group_id] | integer | Workout group ID id (see 'get_coaching_workout_groups') | ||
| params[group_id] | integer | Coaching workout sub group ID id (see 'get_coaching_workout_groups') | ||
| params[source] | integer | Source IDx: 1 - CTRL+ ; 2 - Club; | 1, 2 | |
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_workouts | hash |
{
id: { }sub_group: hash }title: string main_group: hash image: string |
Coaching workouts list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_workout' constant | ||
| params[recipe_id] | integer | true | Coaching workout database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_workout | hash |
{
id: { }is_active: boolean }targets: hash { is_use_schemes: booleandata: { }id: integer }title: string title: string description: string main_group: hash source_title: string image: string exercises: hash { is_use_existing_workouts: booleandata: { }full_title: string }sets: hash { title: stringorder_idx: { }value_2: hash }value_1: hash type_title: string unit: hash full_info: string images: string is_show_title_in_image: boolean duration: string |
Coaching workout details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_targets' constant | ||
| key | string | Security key | ||
| params[subtype] | integer | Source IDx: 0 - '' ; 1 - Serie; 2 - Circuit; | 0, 1, 2 | |
| params[source] | integer | Source IDx: 1 - CTRL+ ; 2 - Club; | 1, 2 | |
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_targets | hash |
{
id: { }is_active: boolean }subtype: string is_use_schemes: boolean title: string source_title: string |
Coaching targets list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_coaching_target' constant | ||
| params[target_id] | integer | true | Coaching target database ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| coaching_target | hash |
{
id: { }is_active: boolean }subtype: string is_use_schemes: boolean title: string schemes: hash { source_title: stringindex: { }pause: integer }series: integer strength_percent: integer time: integer repetitions: integer tempo: integer week: integer |
Coaching target details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_client_body_composition' constant | ||
| key | string | Security key | ||
| params[from] | string | Date from 'YYYY-mm-dd'. Default is the date of the last body measurement if no date is specified | ||
| params[until] | string | Date until YYYY-mm-dd'. Default is the current date if no date is specified | ||
| 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 | |
|---|---|---|---|
| users | hash |
{
index: { }sex: string }mob_phone: string email: string sales: string photo: string interjection: string measurements: array [ phone: string{ ]weighing_date: datetime }metabolic_age: double body_fat_percent: double visceral_fat_kg: double muscle_mass_kg: double length: integer fat_moisture_free_mass: double weight_kg: double bmi: double body_water_percent: double water_kg: double lean_body_mass: double fat_kg: double member_number: string lastname: string name: string personal_coach: string |
User body measurements |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_valid_clients_benfit' constant | ||
| key | string | Security key | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return | ||
| params[memberships] | string | Filter users by status in club | valid, not_valid | |
| params[last_update] | time | Updated after requested datetime | ||
| params[club_id] | integer | Club id from get_clubs command |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| users | hash |
{
id: { }sex: string }mob_phone: string email: string next_reservation: datetime inscriptions: hash { sales: stringindex: { }inscrtype_type: integer }inscrtype_id: integer inscr_visitdone: integer inscr_maxvisit: integer inscr_startdate: date inscrtype_name: string inscr_last_visit: date inscr_id: integer inscr_stop_date: date inscr_enddate: date photo: string interjection: string phone: string member_number: string lastname: string name: string personal_coach: string |
Users data hash |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_ledger_types' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| objects | hash |
{
id: { }title: string } |
Ledgers types list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_exercise_types' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| objects | hash |
{
id: { }title: string } |
Ledgers modules list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_ledger_groups' constant | ||
| key | string | Security key | ||
| params[country_id] | integer | Country ID | ||
| params[account_type] | integer | Account type, 1 = Activa, 2 = Passiva, 3 = Resultaat | 1, 2, 3 | |
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| ledger_groups | hash |
{
id: { }account_type_title: hash }title: string country_id: integer |
Ledger group list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_ledgers' constant | ||
| key | string | Security key | ||
| params[outlet_id] | integer | Outlet ID | ||
| params[ledger_group_id] | integer | Ledger group ID | ||
| params[type_id] | integer | Ledger type idx (see 'get_ledger_types') | ||
| params[module_id] | integer | Ledger module ID (see 'get_ledger_modules') | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| ledgers | hash |
{
id: { }cost_center: hash }subgroup: hash outlet: hash number: string title: string type: hash diary: hash linked_module: hash group: hash cost_center_type: hash |
Ledgers list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_ledger' constant | ||
| key | string | Security key | ||
| params[ledger_id] | integer | Ledger ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| ledger | hash |
{
id: { }assets_options: hash }{ cost_center: hashindex: { }depreciation_start_date_type: hash }number_years: integer residual_percent: double depreciation_sales_ledger: hash depreciation_cost_ledger: hash group_name: string depreciation_ledger: hash depreciation_percent: double subgroup: hash tax_report_code: string outlet: hash activated: boolean rgs_code: double level: integer explanation: string number: string title: string type: hash diary: hash linked_module: hash group: hash vat_applicable: boolean cost_center_type: hash is_client_specific_account: boolean |
Ledger details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_tax_types' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| objects | hash |
{
id: { }title: string } |
Tax types list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_tax_eu_services' constant | ||
| key | string | Security key |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| objects | hash |
{
id: { }title: string } |
Tax eu services list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_taxes' constant | ||
| key | string | Security key | ||
| params[type_id] | integer | Tax type (see 'get_tax_types') | ||
| params[eu_service] | integer | Tax eu service (see 'get_tax_eu_services') | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| ledgers | hash | Ledgers list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_tax' constant | ||
| key | string | Security key | ||
| params[tax_id] | integer | Tax ID |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| tax | hash |
{
id: { }tarif_group: integer }rgs_code: string eu_service: string title: string rgs_description: string type: string report_parameters: hash { percent: doubleindex: { }box_vat_column_number: integer }box_vay_credit_note_column_number: integer box_vat_credit_note_section: hash box_turnover_section: hash box_turnover_column_number: integer box_vat_section: hash box_credit_note_column_number: integer box_credit_note_section: hash ledger: hash btw_code: string duty: integer |
Ledger details |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_bookkeeping_number_diaries' constant | ||
| key | string | Security key | ||
| params[outlet_id] | integer | Outlet ID | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| objects | hash |
{
id: { }bookkeeping_number_cost_center: hash }bookkeeping_number_type_cost: hash outlet: hash number: string description: string group: string |
Bookkeeping number diaries list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_bookkeeping_cost_centers' constant | ||
| key | string | Security key | ||
| params[outlet_id] | integer | Outlet ID | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| objects | hash |
{
id: { }outlet: hash }number: string description: string |
Bookkeeping number cost centers list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_bookkeeping_cost_types' constant | ||
| key | string | Security key | ||
| params[outlet_id] | integer | Outlet ID | ||
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| objects | hash |
{
id: { }outlet: hash }number: string description: string |
Bookkeeping number cost types list |
| Naam | Type | verplicht | Omschrijving | Geldige waardes |
|---|---|---|---|---|
| method | string | 'get_transactions' constant | ||
| key | string | Security key | ||
| params[user_id] | integer | User ID | ||
| params[from] | string | Date from 'YYYY-mm-dd'. Default is the beginning of the current date if no date is specified | ||
| params[until] | string | Date until YYYY-mm-dd'. Default is the end of the current month if no date is specified | ||
| params[imported] | integer | Is imported | ||
| params[transaction_type] | string | Transaction type | plus, minus | |
| params[autorecognized] | string | Is it autorecognized; not recognized - 0, recognized - 1 | 0, 1 | |
| params[bank_batches] | string | To show bank batches; not show - 0, show - 1. Show all if no parameter is specified | 0, 1 | |
| params[page] | integer | Page number | ||
| params[limit] | integer | Limit of items to return |
| Naam | Type | Omschrijving | |
|---|---|---|---|
| objects | hash |
{
id: { }counter_account: string }transaction_type: string outlet: hash imported: boolean iban: string posted: date account_logo_path: string payment_method: hash autorecognized: boolean amount: double |
List of the bank transactions |