SimplyBook.me - User contributions [en]

My SimplyBook.me subscription and how to renew/uk

2026-02-02T17:24:14Z

Tania:

<languages/>
{{#seo: |title=Моя підписка на SimplyBook.me та як її поновити |description=Ознайомтеся з деталями вашої підписки та процесом її поновлення. Дотримуйтесь інструкцій, щоб зберегти свій обліковий запис SimplyBook.me. |titlemode=додати |keywords=fAQ, поширені запитання, програмне забезпечення для бронювання, запитання щодо системи бронювання, онлайн-бронювання, програмне забезпечення для календаря, система бронювання, календар бронювання, програмне забезпечення для планування, онлайн-планування зустрічей, онлайн-планування, налаштування, допомога з налаштуванням, підтримка, довідкова інформація }}

__FORCETOC__
== Де перевірити деталі підписки ==
 
Деталі підписки можна переглянути в декількох місцях
 
:1. Панель управління, розділ «Ваш поточний тариф»
[[File:Subscription info on dashboard redesigned.png|1200px| center|link=https://help.simplybook.me/images/5/5c/Subscription_info_on_dashboard_redesigned.png]]
 
:2. Плани та ціни//Підписки над таблицею «Підписки»
[[File:Plans and prices page subscription info redesigned2.png|1200px|center|link=https://help.simplybook.me/images/8/81/Plans_and_prices_page_subscription_info_redesigned2.png]]
 
:3. На сторінці «Інформація про обліковий запис», праворуч.
[[File:Plan info on my account page redesigned.png|1200px|center|link=https://help.simplybook.me/images/1/18/Plan_info_on_my_account_page_redesigned.png]]
 
== Як поновити підписку ==
 
У розділі «Плани та ціни» // «Підписки» виберіть потрібний пакет і натисніть «Купити/Поновити» під ним. 
[[File:Buy new subscription path redesigned2.png|1200px| center|link=https://help.simplybook.me/images/3/34/Buy_new_subscription_path_redesigned2.png]]
 
Залежно від вашого регіону/валюти, для оплати підписки доступні кілька платіжних шлюзів: 
[[File:Payment methods for susbscription redesigned2.png|1200px| center|link=https://help.simplybook.me/images/b/b9/Payment_methods_for_susbscription_redesigned2.png]] 

*'''Кредитна картка''' через системи SafeCharge або Stripe 

*'''Банківський переказ''' на рахунок: 

:Бенефіціар: SimplyBook.me ltd
:Адреса: 28 Nafpliou, Medical Court, Flat 401, 3025 Limassol, Cyprus

:IBAN EURO: IS800537387113314509189970
:IBAN GBP: IS920537382003884509189970
:IBAN USD: IS280537381011334509189970
:SWIFT: GLITISRE

:ПРИМІТКА: Мінімальна вартість перекладу — 50 доларів США/50 євро/40 фунтів стерлінгів

'''Зверніть увагу!''' Плата за підписку на ваш обліковий запис SimplyBook.me через SafeCharge, Stripe (або PayPal, якщо у вас виникли проблеми з системою Safecharge) встановлюється як періодична і автоматично поновлюється відповідно до обраного періоду підписки. 
Ви можете скасувати періодичний платіж у будь-який час у розділі «Плани та ціни» -> «Історія платежів» -> «Профілі періодичних платежів».
 
Коли ви обираєте оплату банківською карткою (через системи SafeCharge, Stripe або PayPal), ваш спосіб оплати зберігається в розділі «Плани та ціни» -> «Історія платежів» -> «Способи оплати» 
і ви зможете використовувати ці збережені способи для майбутніх покупок підписок та/або додаткових елементів, щоб не потрібно було запам'ятовувати облікові дані кожного разу, коли потрібно додати щось до вашої системи.
[[File:Saved payment method redesigned2.png|1200px|center|link=https://help.simplybook.me/images/c/ca/Saved_payment_method_redesigned2.png]]
 
Ви завжди можете вимкнути методи, які були раніше збережені в розділі «Плани та ціни» -> «Підписки» -> прокрутіть сторінку вниз -> «Редагувати методи оплати».
[[File:Edit payment methods path redesigned2.png|1200px|center|link=https://help.simplybook.me/images/4/4c/Edit_payment_methods_path_redesigned2.png]]
[[File:Payment methods list redesigned.png|1200px|center|link=https://help.simplybook.me/images/3/3d/Payment_methods_list_redesigned.png]]
 

== Як змінити спосіб оплати ==
 
Може статися так, що вам потрібно буде змінити дані своєї кредитної картки або перейти на інший спосіб оплати. 
Ви можете просто здійснити новий платіж за бажаний план, натиснувши «Купити»/«Поновити»/«Оновити» під відповідним варіантом на вкладці «Підписки».
[[File:Buy new subscription path redesigned2.png|1200px| center|link=https://help.simplybook.me/images/3/34/Buy_new_subscription_path_redesigned2.png]]
 
Виберіть бажаний спосіб оплати, вкажіть свої реквізити та підтвердіть оплату. Новий спосіб оплати буде автоматично збережено після підтвердження оплати.

Translations:My SimplyBook.me subscription and how to renew/8/uk

2026-02-02T17:24:14Z

Tania:

:Бенефіціар: SimplyBook.me ltd
:Адреса: 28 Nafpliou, Medical Court, Flat 401, 3025 Limassol, Cyprus

My SimplyBook.me subscription and how to renew/fr

2026-02-02T17:23:58Z

Tania:

<languages/>
{{#seo: |title=Mon abonnement SimplyBook.me et comment le renouveler |description=Comprenez les détails de votre abonnement et le processus de renouvellement. Suivez le guide pour conserver votre compte SimplyBook.me. |titlemode=ajouter |keywords=fAQ, questions fréquemment posées, logiciel de réservation, questions sur le système de rendez-vous, rendez-vous en ligne, logiciel de calendrier, système de réservation, calendrier de réservation, logiciel de planification, planification de rendez-vous en ligne, planification en ligne, configuration, aide à la configuration, assistance, contenu d'aide }}

__FORCETOC__
== Où vérifier les détails de l'abonnement ==
 
Vous pouvez consulter les détails de votre abonnement à plusieurs endroits
 
:1. Tableau de bord, section « Votre tarif actuel »
[[File:Subscription info on dashboard redesigned.png|1200px| center|link=https://help.simplybook.me/images/5/5c/Subscription_info_on_dashboard_redesigned.png]]
 
:2. Plans et tarifs//Abonnements au-dessus du tableau des abonnements
[[File:Plans and prices page subscription info redesigned2.png|1200px|center|link=https://help.simplybook.me/images/8/81/Plans_and_prices_page_subscription_info_redesigned2.png]]
 
:3. Sur la page « Informations sur le compte », à droite.
[[File:Plan info on my account page redesigned.png|1200px|center|link=https://help.simplybook.me/images/1/18/Plan_info_on_my_account_page_redesigned.png]]
 
== Comment renouveler votre abonnement ==
 
Dans la section Plans et tarifs // Abonnements, choisissez le forfait qui vous convient et cliquez sur « Acheter/Renouveler » en dessous. 
[[File:Buy new subscription path redesigned2.png|1200px| center|link=https://help.simplybook.me/images/3/34/Buy_new_subscription_path_redesigned2.png]]
 
Plusieurs passerelles de paiement sont disponibles pour régler votre abonnement en fonction de votre région/devise : 
[[File:Payment methods for susbscription redesigned2.png|1200px| center|link=https://help.simplybook.me/images/b/b9/Payment_methods_for_susbscription_redesigned2.png]] 

*'''Carte de crédit''' via les systèmes SafeCharge ou Stripe 

*'''Virement bancaire''' sur le compte : 

:Bénéficiaire : SimplyBook.me ltd
:Adresse : 28 Nafpliou, Medical Court, Flat 401, 3025 Limassol, Cyprus

:IBAN EURO : IS800537387113314509189970
:IBAN GBP : IS920537382003884509189970
:IBAN USD : IS280537381011334509189970
:SWIFT : GLITISRE

:REMARQUE : le montant minimum pour une traduction est de 50 $/50 €/40 £

'''Remarque importante !''' Les paiements d'abonnement effectués pour votre compte SimplyBook.me via SafeCharge, Stripe (ou PayPal si vous rencontrez des difficultés avec le système Safecharge) sont configurés comme récurrents et seront automatiquement renouvelés en fonction de la période d'abonnement sélectionnée. 
Vous pouvez annuler un paiement récurrent à tout moment dans Plans et tarifs -> Historique des paiements -> Profils de paiement récurrent.
 
Lorsque vous choisissez de payer avec votre carte bancaire (via les systèmes SafeCharge, Stripe ou PayPal), votre mode de paiement est enregistré dans Plans et tarifs -> Historique des paiements -> Modes de paiement 
et vous pourrez utiliser ces modes de paiement enregistrés pour vos futurs achats d'abonnements et/ou d'articles supplémentaires, ce qui vous évitera d'avoir à vous souvenir de vos identifiants à chaque fois que vous souhaitez ajouter quelque chose à votre système.
[[File:Saved payment method redesigned2.png|1200px|center|link=https://help.simplybook.me/images/c/ca/Saved_payment_method_redesigned2.png]]
 
Vous pouvez toujours désactiver les méthodes précédemment enregistrées dans Plans et tarifs -> Abonnements -> faites défiler la page vers le bas -> Modifier les méthodes de paiement.
[[File:Edit payment methods path redesigned2.png|1200px|center|link=https://help.simplybook.me/images/4/4c/Edit_payment_methods_path_redesigned2.png]]
[[File:Payment methods list redesigned.png|1200px|center|link=https://help.simplybook.me/images/3/3d/Payment_methods_list_redesigned.png]]
 

== Comment modifier le mode de paiement ==
 
Il peut arriver que vous deviez modifier les informations de votre carte de crédit ou changer de mode de paiement. 
Vous pouvez simplement effectuer un nouveau paiement pour le forfait souhaité en cliquant sur « Acheter »/« Renouveler »/« Mettre à niveau » sous l'option correspondante dans l'onglet « Abonnements ».
[[File:Buy new subscription path redesigned2.png|1200px| center|link=https://help.simplybook.me/images/3/34/Buy_new_subscription_path_redesigned2.png]]
 
Choisissez le mode de paiement souhaité, fournissez vos coordonnées et confirmez le paiement. Le nouveau mode de paiement sera automatiquement enregistré une fois votre paiement confirmé.

Translations:My SimplyBook.me subscription and how to renew/8/fr

2026-02-02T17:23:58Z

Tania:

:Bénéficiaire : SimplyBook.me ltd
:Adresse : 28 Nafpliou, Medical Court, Flat 401, 3025 Limassol, Cyprus

My SimplyBook.me subscription and how to renew

2026-02-02T17:21:11Z

Tania:

<languages/>
<translate>

{{#seo:
|title=My SimplyBook.me subscription and how to renew | SimplyBook.me
|description=Understand your subscription details and renewal process. Follow the guide to maintain your SimplyBook.me account.
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>
<translate>


__FORCETOC__
==Where to check subscription details==
 
There are several places where you can see your subscription details
 
:1. Dashboard, Your current tariff section
[[File:Subscription info on dashboard redesigned.png|1200px| center|link=https://help.simplybook.me/images/5/5c/Subscription_info_on_dashboard_redesigned.png]]
 
</translate>
<translate>

:2. Plans&Prices//Subscriptions above Subscriptions table
[[File:Plans and prices page subscription info redesigned2.png|1200px|center|link=https://help.simplybook.me/images/8/81/Plans_and_prices_page_subscription_info_redesigned2.png]]
 
</translate>
<translate>

:3. On Account info page, on the right side.
[[File:Plan info on my account page redesigned.png|1200px|center|link=https://help.simplybook.me/images/1/18/Plan_info_on_my_account_page_redesigned.png]]
 
</translate>
<translate>

==How to renew subscription==
 
In Plans&Prices // Subscriptions section choose the package you need and press "Buy/Renew" under it. 
[[File:Buy new subscription path redesigned2.png|1200px| center|link=https://help.simplybook.me/images/3/34/Buy_new_subscription_path_redesigned2.png]]
 
There are several payment gateways to pay for your subscription depending on your region/currency: 
[[File:Payment methods for susbscription redesigned2.png|1200px| center|link=https://help.simplybook.me/images/b/b9/Payment_methods_for_susbscription_redesigned2.png]] 
</translate>
<translate>


*'''Credit Card''' via SafeCharge or Stripe systems 


*'''Wire transfer''' to account: 


:Beneficiary: SimplyBook.me ltd
:Address: 28 Nafpliou, Medical Court, Flat 401, 3025 Limassol, Cyprus


:IBAN EURO: IS800537387113314509189970
:IBAN GBP: IS920537382003884509189970
:IBAN USD: IS280537381011334509189970
:SWIFT: GLITISRE


:REMARK: Minimum transfer is $50/50Eur/40GBP
</translate>
<translate>


'''Please note!''' Subscription payments made for your SimplyBook.me account via SafeCharge, Stripe (or PayPal if you have difficulties with Safecharge system) are set as recurring and will automatically renew based on the selected subscription period. 
You can cancel recurring payment at any time in Plans & Prices -> Payments history -> Recurring payment profiles.
 
When you select to pay with your bank card (via SafeCharge, Stripe systems or PayPal) your payment method gets saved in Plans & Prices -> Payments history -> Payment methods 
and you will be able to use these saved methods for the future purchases of subscriptions and/or additional items so that you will not need to remember the credentials each time you need to add something to your system.
[[File:Saved payment method redesigned2.png|1200px|center|link=https://help.simplybook.me/images/c/ca/Saved_payment_method_redesigned2.png]]
 
</translate>
<translate>

You can always disable the methods that were previously saved in Plans & Prices -> Subscriptions -> scroll the page down -> Edit payment methods.
[[File:Edit payment methods path redesigned2.png|1200px|center|link=https://help.simplybook.me/images/4/4c/Edit_payment_methods_path_redesigned2.png]]
[[File:Payment methods list redesigned.png|1200px|center|link=https://help.simplybook.me/images/3/3d/Payment_methods_list_redesigned.png]]
 
</translate>
<translate>


==How to change payment method==
 
It may happen that you need to change either your credit card details or switch between payment options. 
You can simply make a new payment for the desired plan by clicking on "Buy"/"Renew"/"Upgrade" under the corresponding option in the "Subscriptions" tab.
[[File:Buy new subscription path redesigned2.png|1200px| center|link=https://help.simplybook.me/images/3/34/Buy_new_subscription_path_redesigned2.png]]
 
</translate>
<translate>

Choose the preferred payment method, provide you details and confirm payment. New payment method will be automatically saved when your payment is confirmed.
 
</translate>

My SimplyBook.me subscription and how to renew

2026-02-02T17:18:07Z

Tania:

My SimplyBook.me subscription and how to renew

2026-01-20T14:46:44Z

Tania:

<languages/>
<translate>

{{#seo:
|title=My SimplyBook.me subscription and how to renew | SimplyBook.me
|description=Understand your subscription details and renewal process. Follow the guide to maintain your SimplyBook.me account.
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>
<translate>


__FORCETOC__
==Where to check subscription details==
 
There are several places where you can see your subscription details
 
:1. Dashboard, Your current tariff section
[[File:Subscription info on dashboard redesigned.png|1200px| center|link=https://help.simplybook.me/images/5/5c/Subscription_info_on_dashboard_redesigned.png]]
 
</translate>
<translate>

:2. Plans&Prices//Subscriptions above Subscriptions table
[[File:Plans and prices page subscription info redesigned2.png|1200px|center|link=https://help.simplybook.me/images/8/81/Plans_and_prices_page_subscription_info_redesigned2.png]]
 
</translate>
<translate>

:3. On Account info page, on the right side.
[[File:Plan info on my account page redesigned.png|1200px|center|link=https://help.simplybook.me/images/1/18/Plan_info_on_my_account_page_redesigned.png]]
 
</translate>
<translate>

==How to renew subscription==
 
In Plans&Prices // Subscriptions section choose the package you need and press "Buy/Renew" under it. 
[[File:Buy new subscription path redesigned2.png|1200px| center|link=https://help.simplybook.me/images/3/34/Buy_new_subscription_path_redesigned2.png]]
 
There are several payment gateways to pay for your subscription depending on your region/currency: 
[[File:Payment methods for susbscription redesigned2.png|1200px| center|link=https://help.simplybook.me/images/b/b9/Payment_methods_for_susbscription_redesigned2.png]] 
</translate>
<translate>


*'''Credit Card''' via SafeCharge or Stripe systems 


*'''Wire transfer''' to account: 


:Beneficiary: SimplyBook.me ltd
:Address: 21 Karaiskaki str., Oasis Center, 3032 Limassol, Cyprus


:IBAN EURO: IS800537387113314509189970
:IBAN GBP: IS920537382003884509189970
:IBAN USD: IS280537381011334509189970
:SWIFT: GLITISRE


:REMARK: Minimum transfer is $50/50Eur/40GBP
</translate>
<translate>


'''Please note!''' Subscription payments made for your SimplyBook.me account via SafeCharge, Stripe (or PayPal if you have difficulties with Safecharge system) are set as recurring and will automatically renew based on the selected subscription period. 
You can cancel recurring payment at any time in Plans & Prices -> Payments history -> Recurring payment profiles.
 
When you select to pay with your bank card (via SafeCharge, Stripe systems or PayPal) your payment method gets saved in Plans & Prices -> Payments history -> Payment methods 
and you will be able to use these saved methods for the future purchases of subscriptions and/or additional items so that you will not need to remember the credentials each time you need to add something to your system.
[[File:Saved payment method redesigned2.png|1200px|center|link=https://help.simplybook.me/images/c/ca/Saved_payment_method_redesigned2.png]]
 
</translate>
<translate>

You can always disable the methods that were previously saved in Plans & Prices -> Subscriptions -> scroll the page down -> Edit payment methods.
[[File:Edit payment methods path redesigned2.png|1200px|center|link=https://help.simplybook.me/images/4/4c/Edit_payment_methods_path_redesigned2.png]]
[[File:Payment methods list redesigned.png|1200px|center|link=https://help.simplybook.me/images/3/3d/Payment_methods_list_redesigned.png]]
 
</translate>
<translate>


==How to change payment method==
 
It may happen that you need to change either your credit card details or switch between payment options. 
You can simply make a new payment for the desired plan by clicking on "Buy"/"Renew"/"Upgrade" under the corresponding option in the "Subscriptions" tab.
[[File:Buy new subscription path redesigned2.png|1200px| center|link=https://help.simplybook.me/images/3/34/Buy_new_subscription_path_redesigned2.png]]
 
</translate>
<translate>

Choose the preferred payment method, provide you details and confirm payment. New payment method will be automatically saved when your payment is confirmed.
 
</translate>

Link removal and custom domain

2025-08-26T12:59:35Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Link removal and custom domain - SimplyBook.me
|description=Remove SimplyBook.me branding and set up a custom domain for your booking page. Follow our guide to get started!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>
<translate>


__TOC__
 
Link Removal (removal of ( c ) [https://simplybook.me/ SimplyBook.me] copyright ) is available for Premium users (former Gold and Platinum). The [https://simplybook.me/ SimplyBook.me] copyright message is removed from the footer of booking page, widgets and from emails footer. This makes it less apparent for clients that you are using the [https://simplybook.me/ SimplyBook.me] system.
 
</translate>
<translate>

===What White Label is not:===
:1. It is not custom domain, your booking page will have [https://simplybook.me/ SimplyBook.me] in url. If you want to change simplybook.me in url of your booking page, you can enable [[Special:MyLanguage/Custom Domain custom feature| Custom domain]] feature in your Custom Features page per one-time fee. Then in your Domain controller, you need to find where you set the DNS records. You should set the A record for your website as in instructions displayed in this feature settings. After A-records are set enter domain name you wish to use in this custom feature settings.
:2. Emails are sent from NO-REPLY@simplybook.me, if you need to send emails from your address, you can use [[Special:MyLanguage/SMTP custom feature| SMTP custom feature]] if you use Gmail or have your own SMTP server.
:3. SMS are sent from [https://simplybook.me/ SimplyBook.me] number (if the system does not accept your default number in Settings//Email and sms settings), if you need to send sms from your number, you can use [[Special:MyLanguage/SMS Gateway custom feature| SMS Gateway]] custom feature for additional price.
</translate>
<translate>

:4. Admin page will have [https://simplybook.me/ SimplyBook.me] branding.
:5. Favicon and /v2/ part in the booking site URL cannot be changed.
 
</translate>
<translate>
===What if I want to remove SimplyBook.me terms and conditions checkbox from the booking site?=== 


:'''Please note''', that you need to confirm that you've added information about SimplyBook.me Ltd. as a supplier to your Terms&Conditions.
On '''Premium''' plan SimplyBook.me terms and conditions checkbox will be removed automatically.

If your subscription plan is different from Premium, please follow the steps provided below to remove the [https://simplybook.me/ SimplyBook.me] Terms and Conditions checkbox.

To remove the checkbox you need to have enabled and correctly set all the options mentioned: 
Either: 
1. [[Special:MyLanguage/SMTP custom feature| SMTP]] + [[Special:MyLanguage/Custom Domain custom feature| Custom domain]] + [[Special:MyLanguage/Terms and Conditions custom feature| Terms and Conditions]] + [[Special:MyLanguage/Design|theme]] different from blank*. 
Or: 
2. [[Special:MyLanguage/SMTP custom feature| SMTP]] + [[Special:MyLanguage/Custom Features#Terms and Conditions| Terms and Conditions]] + blank* [[Special:MyLanguage/Design|theme]] + [[Special:MyLanguage/Widgets for your own website| Widget]] on your website. 
*Blank theme is available for paid subscriptions only.
 
After that you will be able to select "Yes" option in Custom features//Terms&Conditions//on the right side of the page//"I confirm that I've added information about SimplyBook.me Ltd. as a supplier to my T&C". after you save settings there the SimplyBook.me terms and conditions checkbox will be removed from the booking site.
[[File:Terma and conditions consent redesigned.png|1200px | center|link=https://help.simplybook.me/index.php/File:Terma_and_conditions_consent_redesigned.png]]
 
</translate>

Link removal and custom domain

2025-08-26T12:58:34Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Link removal and custom domain - SimplyBook.me
|description=Remove SimplyBook.me branding and set up a custom domain for your booking page. Follow our guide to get started!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>
<translate>


__TOC__
 
Link Removal (removal of ( c ) [https://simplybook.me/ SimplyBook.me] copyright ) is available for Premium users (former Gold and Platinum). The [https://simplybook.me/ SimplyBook.me] copyright message is removed from the footer of booking page, widgets and from emails footer. This makes it less apparent for clients that you are using the [https://simplybook.me/ SimplyBook.me] system.
 
</translate>
<translate>

===What White Label is not:===
:1. It is not custom domain, your booking page will have [https://simplybook.me/ SimplyBook.me] in url. If you want to change simplybook.me in url of your booking page, you can enable [[Special:MyLanguage/Custom Domain custom feature| Custom domain]] feature in your Custom Features page per one-time fee. Then in your Domain controller, you need to find where you set the DNS records. You should set the A record for your website as in instructions displayed in this feature settings. After A-records are set enter domain name you wish to use in this custom feature settings.
:2. Emails are sent from NO-REPLY@simplybook.me, if you need to send emails from your address, you can use [[Special:MyLanguage/SMTP custom feature| SMTP custom feature]] if you use Gmail or have your own SMTP server.
:3. SMS are sent from [https://simplybook.me/ SimplyBook.me] number (if the system does not accept your default number in Settings//Email and sms settings), if you need to send sms from your number, you can use [[Special:MyLanguage/SMS Gateway custom feature| SMS Gateway]] custom feature for additional price.
</translate>
<translate>

:4. Admin page will have [https://simplybook.me/ SimplyBook.me] branding.
:5. Favicon and /v2/ part in the booking site URL cannot be changed.
 
</translate>
<translate>
===What if I want to remove SimplyBook.me terms and conditions checkbox from the booking site?=== 


:'''Please note''', that you need to confirm that you've added information about SimplyBook.me Ltd. as a supplier to your Terms&Conditions.
For Premium plan users SimplyBook.me terms and conditions checkbox will be removed automatically. If you have subscription plan different from Premium, please follow the steps provided below to remove the [https://simplybook.me/ SimplyBook.me] Terms and Conditions checkbox.

To remove the checkbox you need to have enabled and correctly set all the options mentioned: 
Either: 
1. [[Special:MyLanguage/SMTP custom feature| SMTP]] + [[Special:MyLanguage/Custom Domain custom feature| Custom domain]] + [[Special:MyLanguage/Terms and Conditions custom feature| Terms and Conditions]] + [[Special:MyLanguage/Design|theme]] different from blank*. 
Or: 
2. [[Special:MyLanguage/SMTP custom feature| SMTP]] + [[Special:MyLanguage/Custom Features#Terms and Conditions| Terms and Conditions]] + blank* [[Special:MyLanguage/Design|theme]] + [[Special:MyLanguage/Widgets for your own website| Widget]] on your website. 
*Blank theme is available for paid subscriptions only.
 
After that you will be able to select "Yes" option in Custom features//Terms&Conditions//on the right side of the page//"I confirm that I've added information about SimplyBook.me Ltd. as a supplier to my T&C". after you save settings there the SimplyBook.me terms and conditions checkbox will be removed from the booking site.
[[File:Terma and conditions consent redesigned.png|1200px | center|link=https://help.simplybook.me/index.php/File:Terma_and_conditions_consent_redesigned.png]]
 
</translate>

Link removal and custom domain

2025-08-26T12:49:15Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Link removal and custom domain - SimplyBook.me
|description=Remove SimplyBook.me branding and set up a custom domain for your booking page. Follow our guide to get started!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>
<translate>


__TOC__
 
Link Removal (removal of ( c ) [https://simplybook.me/ SimplyBook.me] copyright) is available for Premium users (former Gold and Platinum). The [https://simplybook.me/ SimplyBook.me] copyright message is removed from the footer of booking page, widgets and from emails footer. This makes it less apparent for clients that you are using the [https://simplybook.me/ SimplyBook.me] system.
 
</translate>
<translate>

===What White Label is not:===
:1. It is not custom domain, your booking page will have [https://simplybook.me/ SimplyBook.me] in url. If you want to change simplybook.me in url of your booking page, you can enable [[Special:MyLanguage/Custom Domain custom feature| Custom domain]] feature in your Custom Features page per one-time fee. Then in your Domain controller, you need to find where you set the DNS records. You should set the A record for your website as in instructions displayed in this feature settings. After A-records are set enter domain name you wish to use in this custom feature settings.
:2. Emails are sent from NO-REPLY@simplybook.me, if you need to send emails from your address, you can use [[Special:MyLanguage/SMTP custom feature| SMTP custom feature]] if you use Gmail or have your own SMTP server.
:3. SMS are sent from [https://simplybook.me/ SimplyBook.me] number (if the system does not accept your default number in Settings//Email and sms settings), if you need to send sms from your number, you can use [[Special:MyLanguage/SMS Gateway custom feature| SMS Gateway]] custom feature for additional price.
</translate>
<translate>

:4. Admin page will have [https://simplybook.me/ SimplyBook.me] branding.
:5. Favicon and /v2/ part in the booking site URL cannot be changed.
 
</translate>
<translate>
===What if I want to remove SimplyBook.me terms and conditions checkbox from the booking site?=== 


:'''Please note''', that you need to confirm that you've added information about SimplyBook.me Ltd. as a supplier to your Terms&Conditions.
To remove the checkbox you need to have enabled and correctly set all the options mentioned: 
Either: 
1. [[Special:MyLanguage/SMTP custom feature| SMTP]] + [[Special:MyLanguage/Custom Domain custom feature| Custom domain]] + [[Special:MyLanguage/Terms and Conditions custom feature| Terms and Conditions]] + [[Special:MyLanguage/Design|theme]] different from blank*. 
Or: 
2. [[Special:MyLanguage/SMTP custom feature| SMTP]] + [[Special:MyLanguage/Custom Features#Terms and Conditions| Terms and Conditions]] + blank* [[Special:MyLanguage/Design|theme]] + [[Special:MyLanguage/Widgets for your own website| Widget]] on your website. 
*Blank theme is available for paid subscriptions only.
 
After that you will be able to select "Yes" option in Custom features//Terms&Conditions//on the right side of the page//"I confirm that I've added information about SimplyBook.me Ltd. as a supplier to my T&C". after you save settings there the SimplyBook.me terms and conditions checkbox will be removed from the booking site.
[[File:Terma and conditions consent redesigned.png|1200px | center|link=https://help.simplybook.me/index.php/File:Terma_and_conditions_consent_redesigned.png]]
 
</translate>

Adjusting notifications

2025-07-22T16:00:57Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Adjusting notifications - SimplyBook.me
|description=Update notification settings to keep clients informed. Customize messages for a better client experience. Learn more here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content, notifications, notifications settings, emails, booking notifications
}}
</translate>
<translate>


 
<youtube>https://youtu.be/IZ8h3OmXTjQ</youtube>


 
=How to enable/disable bookings notifications and adjust your templates=
 
</translate>
<translate>


Go to Settings -> Email and SMS settings and check/uncheck the corresponding boxes to send/not send notifications. You can change the texts of notifications to better suit your needs by clicking edit template, making changes and saving system settings.
[[File:Email and sms settings path redesigned upd.png|1200px|border| center|link=https://help.simplybook.me/images/a/a4/Email_and_sms_settings_path_redesigned_upd.png]]
 
[[File:Notifications statuses upd.png|1200px| center|link=https://help.simplybook.me/images/e/e2/Notifications_statuses_upd.png]]

 
</translate>
<translate>

==What'sApp Notifications==
If you and your clients are actively using WhatsApp messenger you can get bookings-related notifications there.
;How to use
1. Enable the desired types for WhatsApp Notifications in Settings -> Email and SMS settings
[[File:Whatapp notofications switchers.png|1200px|center|link=https://help.simplybook.me/images/1/14/Whatapp_notofications_switchers.png]]
 
2. Purchase WhatsApp Credits in Plans & Prices -> Subscriptions or Additional items depending on whether you would like the credits to automatically renew with your subscription or you prefer one-time purchase. Each message will take -1 credit from the total number of credits purchased. 
(You will also be able to view the messages that were sent from the system as well as the number of credits used in Reports -> SMS (txt messages) -> WhatsApp notifications)
[[File:Add whatapp credits to subscription.png|1200px|center|link=https://help.simplybook.me/images/c/c8/Add_whatapp_credits_to_subscription.png]]
 
'''Please note!'''

* To comply with WhatsApp policies, messages use pre-approved templates and cannot be customized. These templates cover essential information clearly and professionally.
* Any client interaction in whats app ( client cancellation/booking reschedule, etc ) will cost credits 
</translate>
<translate>

==Admin mobile app==
If you are using admin mobile application you can receive booking related notifications such as booking confirmations, reminders, booking change and cancellation notifications. 
To enable/disable these notifications please navigate to Settings tab -> Manage notifications in the admin mobile application.
 
</translate>
<translate>


=How to disable Feedbacks=
You can view all your reviews in the Reports -> Reviews tab in left-side menu, delete or reply to them. If you wish to remove the option to leave a review and do not send feedback request in Settings -> Email and SMS settings -> Settings for e-mail and SMS notifications -> set Number of days until feedback request is sent to client to Disable. 
[[File:Feedback disable path redesigned.png|1200px | center|link=https://help.simplybook.me/images/1/12/Feedback_disable_path_redesigned.png]]
 
</translate>
<translate>


=[[Custom Features|Custom features]] related notifications=
The following custom features have either own notification types or can influence the messages sent by the system:
--------
==[[Accept payments custom feature|Accept payments]]==
Allows to send:
* Invoices to clients(email template)
* Notifications about unsuccessful payments to client(Email template)
* Notifications about unsuccessful payments to company(Email template)
All these templates can be edited in Custom features -> [[Accept payments custom feature|Accept payments]] -> Settings -> Email template settings.
[[File:Accept payments notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/f/fb/Accept_payments_notifications_path_redesigned.png]]
 
:''[[Accept payments custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Multiple Bookings custom feature|Multiple bookings]]==
Has own templates for:
* Booking confirmation notification to client(Email and SMS templates)
* Booking reminder notification to client(Email and SMS templates)
Both types are automatically applied when this custom feature is enabled and the clients makes a batch of appointments at once using Add another service button at checkout.
The templates texts can be adjusted in Custom features -> [[Multiple Bookings custom feature|Multiple bookings]] -> on the right side of the page.
[[File:Multiple bookings notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/f/fc/Multiple_bookings_notifications_path_redesigned.png]]
 
:''[[Multiple Bookings custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Group Bookings custom feature|Group bookings]]==
Has special templates for the following types:
* Booking confirmation notification to client(Email and SMS templates)
* Booking reminder notification to client(Email and SMS templates)
* Booking confirmation notification to provider(Email and SMS templates)
* Booking reminder notification to provider(Email and SMS templates)
They will be automatically applied when this custom feature is enabled and the client books an appointment selecting several participants on the service step of the booking process.
All the templates can be adjusted in Custom features -> [[Group Bookings custom feature|Group bookings]] -> on the right side of the page.
[[File:Group bookings notifications path.png|1200px|border|center|link=https://help.simplybook.me/images/6/66/Group_bookings_notifications_path.png]]
 
:''[[Group Bookings custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Book Soon Notification System custom feature|Book Soon notification system]]==
Allows to send reminders to come again to the clients who have booked before. 
The templates can be set in Custom features -> [[Book Soon Notification System custom feature|Book Soon notification system]] -> Settings -> Add new to create a new template(Email and SMS).
You can create numerous specific templates for certain service(s)/provider(s) and they will be sent when the indicated time has passed from the client appointment.
[[File:Book soon template redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/3/36/Book_soon_template_redesigned.png]]
 
:''[[Book Soon Notification System custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Coupons and Gift Cards custom feature|Coupons & Gift cards]]==
Can send specific notifications for the following cases when you are using this custom feature:
* the client purchases a gift card on the booking website(Email and SMS templates)
This notification template can be enabled/disable and edited in Custom features -> [[Coupons and Gift Cards custom feature|Coupons & Gift cards]] -> on the right side of the page.
[[File:Coupons & gift cards notifications redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/7/79/Coupons_%26_gift_cards_notifications_redesigned.png]]
 
As well if you manually issue gift card or coupon to your client(s) the template that will be used in this case can be access in Manage -> Coupons&Gift Cards -> Issue the gift card / Send coupon message for the desired gift-card/coupon -> Send Email/Send SMS.
 
:''[[Coupons and Gift Cards custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Client mobile app]]==
In case this feature is enabled and the client has allowed notifications, the mobile application will send booking-related push notifications. 
There is no place to edit the template, but you can view the notifications report in Reports -> Push notifications report. 
[[File:Push notifications report path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/2/24/Push_notifications_report_path_redesigned.png]]
 
'''Please note!''' You need to have enough push notifications credits to be able to send such notifications to clients
 
:''[[Client mobile app|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Client Login custom feature|Client login]]==
If you require the clients to sign in/sign up to be able to book the appointments or make purchases on your booking website and have Client login custom feature enabled, 
there are three notification types that can be sent to your clients(they cannot be disabled):
* new client registration(Email)
* restore password(Email)
* reset password or create client from admin interface(Email)
You can edit the templates in Custom features -> [[Client Login custom feature|Client login]] -> on the right side of the page.
[[File:Client login notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/d/d0/Client_login_notifications_path_redesigned.png]]
 
:''[[Client Login custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Membership custom feature|Membership]]==
When you sell memberships on the booking website you may also need to notify your clients about the different points. 
This custom feature allows to send:
* membership activation notification(Email and SMS templates)
* recurring payment notification(Email and SMS templates)
* recurring payment error(Email and SMS templates)
* recurring payment success(Email and SMS templates)
* membership period end(Email and SMS templates)
* membership expires today(Email and SMS templates)
* membership expired notification(Email and SMS templates)
You can edit the templates, as well as enable/disable certain notification types in Custom features -> [[Membership custom feature|Membership]] -> on the right side of the page.
[[File:Memberships notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/6/6e/Memberships_notifications_path_redesigned.png]]
 
:''[[Membership custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Flexible Notifications custom feature|Flexible notifications]]==
This custom feature allows to customize the booking related notification per certain service/provider or both. 
The following types can be used:
* booking confirmation to client(Email and SMS templates)
* booking confirmation to provider(Email and SMS templates)
* reminder to client(Email and SMS templates)
* reminder to provider(Email and SMS templates)
* cancellation notification to client(Email and SMS templates)
* cancellation notification for provider(Email and SMS templates)
* booking change notification to client(Email and SMS templates)
* booking change notification to provider(Email and SMS templates)
* recurring event confirmation to client(Email and SMS templates)
* recurring event confirmation to provider(Email and SMS templates)
* batch cancellation notification to client(Email and SMS templates)
* batch cancellation notification to provider(Email and SMS templates)
* [[Multiple Bookings custom feature|multiple bookings]] batch booking confirmation to client(Email and SMS templates)
* [[Multiple Bookings custom feature|multiple bookings]] event reminder to client(Email and SMS templates)
* [[Group Bookings custom feature|group bookings]] batch booking confirmation to client(Email and SMS templates)
* [[Group Bookings custom feature|group bookings]] batch booking confirmation to provider(Email and SMS templates)
* [[Group Bookings custom feature|group bookings]] reminder to client(Email and SMS templates)
* [[Group Bookings custom feature|group bookings]] reminder to provider(Email and SMS templates)
You can create all the desired templates in Custom features -> [[Flexible Notifications custom feature|Flexible notifications]] -> Manage.
[[File:Flexible notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/5/56/Flexible_notifications_path_redesigned.png]]
 
In case you need to enable/disable some of these notification types please navigate to Settings -> Email and SMS settings -> and use the table at the top of the page. 
'''Please note!''' These are general booking notifications settings so if you turn some of them off it will also influence similar types related to other features(i.e. if you disable booking confirmations to providers there then common confirmations, as well as group, recurring batches confirmation notifications will become off)
 
:''[[Flexible Notifications custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Packages custom feature|Packages]]==
When you sell the packages of services/classes/products/service add-ons or issue the packages from admin side it is also possible to automatically send the clients the package activation notification(Email and/or SMS). 
To edit the template text or enable/disable the notifications please navigate to Custom features -> [[Packages custom feature|Packages]] -> right side of the page.
[[File:Packages notification path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/f/fd/Packages_notification_path_redesigned.png]]
 
:''[[Packages custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Tickets custom feature|Tickets]]==
By default the ticket is automatically sent to client email together with the corresponding service confirmation email. 
But in case you are using online payments and allow to choose pay later option on the booking website and the client select it, 
in this case the ticket will be sent with the separate email.
As well you may wish to re-send the ticket to the client in certain cases(it is possible in Reports -> Tickets report).
Both notification templates case be edited in Custom features -> [[Tickets custom feature|Tickets]] -> on the right side or the page. There are Email types available only.
[[File:Tickets notificatons path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/e/ea/Tickets_notificatons_path_redesigned.png]]
 
:''[[Tickets custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Custom Email custom feature|Custom email]]==
Allows to customize the design of the email notifications to match your branding and taste. 
To create your designs please go to Custom features -> [[Custom Email custom feature|Custom email]] -> Create template. 
[[File:Custom email template path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/4/49/Custom_email_template_path_redesigned.png]]
 
With the help of this custom feature you can influence the look of the following notification types:
* common booking related notifications from Settings -> Email and SMS Settings;
* invoices emails from [[Accept payments custom feature|accept payments]] custom feature;
* [[Group Bookings custom feature|group bookings]] custom feature notifications;
* [[Multiple Bookings custom feature|multiple bookings]] custom feature notifications;
* [[Client Login custom feature|client login]] custom feature notifications;
* [[Membership custom feature|membership]] custom feature notifications;
* [[Packages custom feature|packages]] custom feature notifications;
* [[Tickets custom feature|tickets]] custom feature notifications;
* [[Coupons and Gift Cards custom feature|coupons & gift cards]] custom feature notifications
* [[Medical test custom feature|medical test]] custom feature notifications;
* [[Book Soon Notification System custom feature|book soon notification system]] custom feature notifications.
This feature allows to test each notification type with the pre-created design.
[[File:Custom email notification types list redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/c/c2/Custom_email_notification_types_list_redesigned.png]]
The <nowiki>{{content}}</nowiki> tag that contains the booking/purchase information can be edited in the corresponding feature settings.
 
:''[[Custom Email custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[SMTP custom feature|SMTP]]==
This feature allows you to use your own SMTP server for sending the emails. 
It has only one template for testing this feature after you have entered the settings. 
You can edit and use the test email template in Custom features -> SMTP -> on the right side of the page.
[[File:Smtp email path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/e/e4/Smtp_email_path_redesigned.png]]
 
:''[[SMTP custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Daily Report custom feature|Daily report]]==
When you enable and set this custom feature it will automatically send the email report about new, upcoming and cancelled appointments to your company email address. 
There is not template to edit as such, but you can adjust the items included in Custom features -> [[Daily Report custom feature|Daily report]] -> on the right side of the page.
[[File:Daily report settings path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/e/e2/Daily_report_settings_path_redesigned.png]]
 
:''[[Daily Report custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[HIPAA custom feature|HIPAA]]==
This is security-related custom feature and allows to send email notifications when somebody logs in to your system. 
It does not contain any email template to be edited and can be enabled/disabled by adding/removing the email address in Custom features -> [[HIPAA custom feature|HIPAA]] -> right side of the page -> Notify email.
[[File:Hipaa notifications settings path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/6/66/Hipaa_notifications_settings_path_redesigned.png]]
 
:''[[HIPAA custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Contact Widget custom feature|Contact widget]]==
As this custom feature allows to add a contact form to your booking website or create the contact button widget, there is also the email/SMS notification to company that is sent when somebody leaves a message on the booking site or widget so that you will be able to respond right away.
There is no template to edit but you can disable such notifications in Settings -> Email and SMS settings -> Contact widget notifications.
[[File:Contact widget notifications enable path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/b/b5/Contact_widget_notifications_enable_path_redesigned.png]]
 
:''[[Contact Widget custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Medical test custom feature|Medical test]]==
When you are using this custom feature you definitely need to send the test results to patients' emails. 
In Custom features -> Medical test -> on the right side of the page you can enable/disable or edit the following templates:
* positive results(Email and SMS templates);
* negative results(Email and SMS templates);
* inconclusive results(Email and SMS templates).
[[File:Medical test notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/4/49/Medical_test_notifications_path_redesigned.png]]
In case you need to adjust the test result template please use Custom result template option above the templates.
 
:''[[Medical test custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>

=What are variables= 


Variables are elements that can be inserted in email and sms templates (Settings -> Email and SMS settings). These variables will denote the chosen item after the booking is made. For example you have 2 providers: Mary and John. In email template you insert text "You have booked a service with [provider]". If the client chose on the booking page provider Mary, they would receive the following text "You have booked a service with Mary", if they chose John, they would receive the text "You have booked a service with John." 
You can always find the variables that can be used with the certain notification type near the template either on the right side of the page or in the popup that can be access by click on "Variables" button.
[[File:Variables overview redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/d/d3/Variables_overview_redesigned.png]]
 
</translate>
<translate>

=iCals and how to use them= 


In Settings -> Email and SMS settings you can check the box Attach iCal to e-mails and then emails will contain file of .isc format. After clicking that file, it will open in one of your calendars (Google calendar, iCalendar,etc)


[[File:Ics files options redesigned.png|1200px | center|link=https://help.simplybook.me/images/2/23/Ics_files_options_redesigned.png]]
 
:'''Please note''', that iCal files do not have set timezone so the time in that file will be displayed according to the IP address/device settings.
 
</translate>
<translate>

=Clients/Providers do not receive notifications= 


;Possible reasons
:1. Corresponding boxes in Settings -> Email and SMS settings are not checked.


:2. Client/provider entered wrong email or phone.


:3. Email went to junk (Spam) folder or to Social tab. Please check Whitelisting instructions [[Email whitelisting instructions| here]].


:4. [[Custom Features#SMTP| SMTP]] custom feature is not set correctly.


:5. If sms are not coming, check your sms balance in Plans&Prices -> Subscriptions at the bottom of the page.
 
</translate>
<translate>

=Clients/Providers receive wrong notifications= 


:1. Please check if you have [[Custom Features#Multiple Bookings| '''Multiple Bookings''']] or [[Custom Features#Group Bookings| '''Group Bookings''']] Custom Feature enabled. These Custom Features have their own templates.


:'''Multiple bookings template''' (Custom Features -> Multiple bookings -> on the right side of the page)


[[File:Multiple bookings notifications path redesigned.png|1200px|border | center|link=https://help.simplybook.me/images/f/fc/Multiple_bookings_notifications_path_redesigned.png]]
 
:'''Group bookings template''' (Custom Features -> Group bookings -> on the right side of the page)


[[File:Group bookings notifications path.png|1200px|border| center|link=https://help.simplybook.me/images/6/66/Group_bookings_notifications_path.png]]
 
:2. Check if you have Time Zone settings on in Settings -> Main configuration, in this case client may have selected wrong time zone and received notification in wrong time zone too.


[[File:Timezone settings redesigned.png|1200px | center|link=https://help.simplybook.me/images/3/35/Timezone_settings_redesigned.png]]
 
</translate>
<translate>


=Email whitelisting instructions=
So here are a few things that you can do to make sure you get those all important emails from the team here at SimplyBook.me.


You can expect system notifications such as when your subscription is up for renewal, notices about bookings, and helpful information on various things such as how to get the most out of your [https://simplybook.me/ SimplyBook.me] service.


As great as technology is, it isn’t perfect, and sometimes email systems and internet service providers mistake legitimate email for spam. To ensure that you don’t miss important communication from us, please take the following steps:


Please whitelist any emails that come from the '''@simplybook.me''' domain.


'''Why?''' Because that tells your email service or program that you actually want emails from this domain, so that they can then make sure you get them.


'''How?''' Well, this differs between email services and programs but below you can see information about some of the main ones. If you aren’t using one of these, please refer to the help section for yourservice for information.

</translate>
<translate>

==Using Gmail or Gsuite== 


Filter messages from '''@simplybook.me''' and tell the system to never send it to spam:


:1. Go to Settings (click the gear icon at the top to the right)


[[File:Click settings.png| center]]


:2. Select the Filters and Blocked Addresses tab


[[File:Select filters and blocked addresses.png| center]]


:3. Towards the bottom of the tab, click the Create a new filter link

</translate>
<translate>


[[File:Gmail create a new filter.png| center]]


:4. In the From field write '''@simplybook.me'''
:5. Click Create filter with this search to the bottom right of the window


[[File:Gmail create filter with this search.png| center]]


:6. Tick the box next to Never send it to Spam
:7. Click the blue button that says Create filter


[[File:Gmail never send it to spam.png| center]]


Great! Now you won’t miss anything from us!


'''And to ensure that our emails don’t get lost in that Updates or Promotions tab:'''

</translate>
<translate>


:1. Find an email from SimplyBook.me in your inbox


:2. Click and drag it to the Primary tab in your inbox


[[File:Gmail move to primary tab.png| center]]
 
:3. You’ll be asked whether you want to do this for future emails, so tell them yes


[[File:Gmail do this with future emails from SimplyBook.me.png| center]]
 
</translate>
<translate>
==Using Yahoo! mail== 


:1. When you open an email message, hover your mouse on the Sender's name.


:2. Click the the three dots in the Sender's info window that appears and click Add to contacts.


[[File:Add to contacts yahoo.png| center]]
 
:3. When Add Contact form comes up, click Save.


[[File:Add contact yahoo form.PNG| center]]
 
</translate>
<translate>
==Using Mac Mail== 


:1. From the top menu select Mail -> Preferences


[[File:Step 1 - open Mail preferences.jpg| center]]
 
:2. Then select the Rules icon, click Add Rule and type a name for the rule in the description field. Use the following settings:


[[File:Step 2 - open Rules configuration.jpg| center]]
 
:3. “If any of the following conditions are met: From Contains”. In the text field besides Contains type '''@simplybook.me'''


[[File:Step 3 - add a rule for SimplyBook.me mails.jpg| center]]


:4. Select Move Message and Inbox from the drop down menus and then click OK to save the rule.
 
</translate>
<translate>
==Using Outlook== 


:1. Right-click on the message in your inbox.


:2. Select Junk E-mail from the menu.


:3. Click Never Block Sender or Never Block Sender's Domain (@example.com).


[[File:Outlook not junk.jpg| center]]
 
Great, you’re all set! We look forward to being in touch and seeing your business blossom!

</translate>

Adjusting notifications

2025-07-22T12:26:16Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Adjusting notifications - SimplyBook.me
|description=Update notification settings to keep clients informed. Customize messages for a better client experience. Learn more here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content, notifications, notifications settings, emails, booking notifications
}}
</translate>
<translate>


 
<youtube>https://youtu.be/IZ8h3OmXTjQ</youtube>


 
=How to enable/disable bookings notifications and adjust your templates=
 
</translate>
<translate>


Go to Settings -> Email and SMS settings and check/uncheck the corresponding boxes to send/not send notifications. You can change the texts of notifications to better suit your needs by clicking edit template, making changes and saving system settings.
[[File:Email and sms settings path redesigned upd.png|1200px|border| center|link=https://help.simplybook.me/images/a/a4/Email_and_sms_settings_path_redesigned_upd.png]]
 
[[File:Notifications statuses upd.png|1200px| center|link=https://help.simplybook.me/images/e/e2/Notifications_statuses_upd.png]]

 
</translate>
<translate>

==What'sApp Notifications==
If you and your clients are actively using WhatsApp messenger you can get bookings-related notifications there.
;How to use
1. Enable the desired types for WhatsApp Notifications in Settings -> Email and SMS settings
[[File:Whatapp notofications switchers.png|1200px|center|link=https://help.simplybook.me/images/1/14/Whatapp_notofications_switchers.png]]
 
2. Purchase WhatsApp Credits in Plans & Prices -> Subscriptions or Additional items depending on whether you would like the credits to automatically renew with your subscription or you prefer one-time purchase. Each message will take -1 credit from the total number of credits purchased. 
(You will also be able to view the messages that were sent from the system as well as the number of credits used in Reports -> SMS (txt messages) -> WhatsApp notifications)
[[File:Add whatapp credits to subscription.png|1200px|center|link=https://help.simplybook.me/images/c/c8/Add_whatapp_credits_to_subscription.png]]
 
'''Please note!''' To comply with WhatsApp policies, messages use pre-approved templates and cannot be customized. These templates cover essential information clearly and professionally.
 
</translate>
<translate>

==Admin mobile app==
If you are using admin mobile application you can receive booking related notifications such as booking confirmations, reminders, booking change and cancellation notifications. 
To enable/disable these notifications please navigate to Settings tab -> Manage notifications in the admin mobile application.
 
</translate>
<translate>


=How to disable Feedbacks=
You can view all your reviews in the Reports -> Reviews tab in left-side menu, delete or reply to them. If you wish to remove the option to leave a review and do not send feedback request in Settings -> Email and SMS settings -> Settings for e-mail and SMS notifications -> set Number of days until feedback request is sent to client to Disable. 
[[File:Feedback disable path redesigned.png|1200px | center|link=https://help.simplybook.me/images/1/12/Feedback_disable_path_redesigned.png]]
 
</translate>
<translate>


=[[Custom Features|Custom features]] related notifications=
The following custom features have either own notification types or can influence the messages sent by the system:
--------
==[[Accept payments custom feature|Accept payments]]==
Allows to send:
* Invoices to clients(email template)
* Notifications about unsuccessful payments to client(Email template)
* Notifications about unsuccessful payments to company(Email template)
All these templates can be edited in Custom features -> [[Accept payments custom feature|Accept payments]] -> Settings -> Email template settings.
[[File:Accept payments notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/f/fb/Accept_payments_notifications_path_redesigned.png]]
 
:''[[Accept payments custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Multiple Bookings custom feature|Multiple bookings]]==
Has own templates for:
* Booking confirmation notification to client(Email and SMS templates)
* Booking reminder notification to client(Email and SMS templates)
Both types are automatically applied when this custom feature is enabled and the clients makes a batch of appointments at once using Add another service button at checkout.
The templates texts can be adjusted in Custom features -> [[Multiple Bookings custom feature|Multiple bookings]] -> on the right side of the page.
[[File:Multiple bookings notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/f/fc/Multiple_bookings_notifications_path_redesigned.png]]
 
:''[[Multiple Bookings custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Group Bookings custom feature|Group bookings]]==
Has special templates for the following types:
* Booking confirmation notification to client(Email and SMS templates)
* Booking reminder notification to client(Email and SMS templates)
* Booking confirmation notification to provider(Email and SMS templates)
* Booking reminder notification to provider(Email and SMS templates)
They will be automatically applied when this custom feature is enabled and the client books an appointment selecting several participants on the service step of the booking process.
All the templates can be adjusted in Custom features -> [[Group Bookings custom feature|Group bookings]] -> on the right side of the page.
[[File:Group bookings notifications path.png|1200px|border|center|link=https://help.simplybook.me/images/6/66/Group_bookings_notifications_path.png]]
 
:''[[Group Bookings custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Book Soon Notification System custom feature|Book Soon notification system]]==
Allows to send reminders to come again to the clients who have booked before. 
The templates can be set in Custom features -> [[Book Soon Notification System custom feature|Book Soon notification system]] -> Settings -> Add new to create a new template(Email and SMS).
You can create numerous specific templates for certain service(s)/provider(s) and they will be sent when the indicated time has passed from the client appointment.
[[File:Book soon template redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/3/36/Book_soon_template_redesigned.png]]
 
:''[[Book Soon Notification System custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Coupons and Gift Cards custom feature|Coupons & Gift cards]]==
Can send specific notifications for the following cases when you are using this custom feature:
* the client purchases a gift card on the booking website(Email and SMS templates)
This notification template can be enabled/disable and edited in Custom features -> [[Coupons and Gift Cards custom feature|Coupons & Gift cards]] -> on the right side of the page.
[[File:Coupons & gift cards notifications redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/7/79/Coupons_%26_gift_cards_notifications_redesigned.png]]
 
As well if you manually issue gift card or coupon to your client(s) the template that will be used in this case can be access in Manage -> Coupons&Gift Cards -> Issue the gift card / Send coupon message for the desired gift-card/coupon -> Send Email/Send SMS.
 
:''[[Coupons and Gift Cards custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Client mobile app]]==
In case this feature is enabled and the client has allowed notifications, the mobile application will send booking-related push notifications. 
There is no place to edit the template, but you can view the notifications report in Reports -> Push notifications report. 
[[File:Push notifications report path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/2/24/Push_notifications_report_path_redesigned.png]]
 
'''Please note!''' You need to have enough push notifications credits to be able to send such notifications to clients
 
:''[[Client mobile app|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Client Login custom feature|Client login]]==
If you require the clients to sign in/sign up to be able to book the appointments or make purchases on your booking website and have Client login custom feature enabled, 
there are three notification types that can be sent to your clients(they cannot be disabled):
* new client registration(Email)
* restore password(Email)
* reset password or create client from admin interface(Email)
You can edit the templates in Custom features -> [[Client Login custom feature|Client login]] -> on the right side of the page.
[[File:Client login notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/d/d0/Client_login_notifications_path_redesigned.png]]
 
:''[[Client Login custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Membership custom feature|Membership]]==
When you sell memberships on the booking website you may also need to notify your clients about the different points. 
This custom feature allows to send:
* membership activation notification(Email and SMS templates)
* recurring payment notification(Email and SMS templates)
* recurring payment error(Email and SMS templates)
* recurring payment success(Email and SMS templates)
* membership period end(Email and SMS templates)
* membership expires today(Email and SMS templates)
* membership expired notification(Email and SMS templates)
You can edit the templates, as well as enable/disable certain notification types in Custom features -> [[Membership custom feature|Membership]] -> on the right side of the page.
[[File:Memberships notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/6/6e/Memberships_notifications_path_redesigned.png]]
 
:''[[Membership custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Flexible Notifications custom feature|Flexible notifications]]==
This custom feature allows to customize the booking related notification per certain service/provider or both. 
The following types can be used:
* booking confirmation to client(Email and SMS templates)
* booking confirmation to provider(Email and SMS templates)
* reminder to client(Email and SMS templates)
* reminder to provider(Email and SMS templates)
* cancellation notification to client(Email and SMS templates)
* cancellation notification for provider(Email and SMS templates)
* booking change notification to client(Email and SMS templates)
* booking change notification to provider(Email and SMS templates)
* recurring event confirmation to client(Email and SMS templates)
* recurring event confirmation to provider(Email and SMS templates)
* batch cancellation notification to client(Email and SMS templates)
* batch cancellation notification to provider(Email and SMS templates)
* [[Multiple Bookings custom feature|multiple bookings]] batch booking confirmation to client(Email and SMS templates)
* [[Multiple Bookings custom feature|multiple bookings]] event reminder to client(Email and SMS templates)
* [[Group Bookings custom feature|group bookings]] batch booking confirmation to client(Email and SMS templates)
* [[Group Bookings custom feature|group bookings]] batch booking confirmation to provider(Email and SMS templates)
* [[Group Bookings custom feature|group bookings]] reminder to client(Email and SMS templates)
* [[Group Bookings custom feature|group bookings]] reminder to provider(Email and SMS templates)
You can create all the desired templates in Custom features -> [[Flexible Notifications custom feature|Flexible notifications]] -> Manage.
[[File:Flexible notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/5/56/Flexible_notifications_path_redesigned.png]]
 
In case you need to enable/disable some of these notification types please navigate to Settings -> Email and SMS settings -> and use the table at the top of the page. 
'''Please note!''' These are general booking notifications settings so if you turn some of them off it will also influence similar types related to other features(i.e. if you disable booking confirmations to providers there then common confirmations, as well as group, recurring batches confirmation notifications will become off)
 
:''[[Flexible Notifications custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Packages custom feature|Packages]]==
When you sell the packages of services/classes/products/service add-ons or issue the packages from admin side it is also possible to automatically send the clients the package activation notification(Email and/or SMS). 
To edit the template text or enable/disable the notifications please navigate to Custom features -> [[Packages custom feature|Packages]] -> right side of the page.
[[File:Packages notification path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/f/fd/Packages_notification_path_redesigned.png]]
 
:''[[Packages custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Tickets custom feature|Tickets]]==
By default the ticket is automatically sent to client email together with the corresponding service confirmation email. 
But in case you are using online payments and allow to choose pay later option on the booking website and the client select it, 
in this case the ticket will be sent with the separate email.
As well you may wish to re-send the ticket to the client in certain cases(it is possible in Reports -> Tickets report).
Both notification templates case be edited in Custom features -> [[Tickets custom feature|Tickets]] -> on the right side or the page. There are Email types available only.
[[File:Tickets notificatons path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/e/ea/Tickets_notificatons_path_redesigned.png]]
 
:''[[Tickets custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Custom Email custom feature|Custom email]]==
Allows to customize the design of the email notifications to match your branding and taste. 
To create your designs please go to Custom features -> [[Custom Email custom feature|Custom email]] -> Create template. 
[[File:Custom email template path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/4/49/Custom_email_template_path_redesigned.png]]
 
With the help of this custom feature you can influence the look of the following notification types:
* common booking related notifications from Settings -> Email and SMS Settings;
* invoices emails from [[Accept payments custom feature|accept payments]] custom feature;
* [[Group Bookings custom feature|group bookings]] custom feature notifications;
* [[Multiple Bookings custom feature|multiple bookings]] custom feature notifications;
* [[Client Login custom feature|client login]] custom feature notifications;
* [[Membership custom feature|membership]] custom feature notifications;
* [[Packages custom feature|packages]] custom feature notifications;
* [[Tickets custom feature|tickets]] custom feature notifications;
* [[Coupons and Gift Cards custom feature|coupons & gift cards]] custom feature notifications
* [[Medical test custom feature|medical test]] custom feature notifications;
* [[Book Soon Notification System custom feature|book soon notification system]] custom feature notifications.
This feature allows to test each notification type with the pre-created design.
[[File:Custom email notification types list redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/c/c2/Custom_email_notification_types_list_redesigned.png]]
The <nowiki>{{content}}</nowiki> tag that contains the booking/purchase information can be edited in the corresponding feature settings.
 
:''[[Custom Email custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[SMTP custom feature|SMTP]]==
This feature allows you to use your own SMTP server for sending the emails. 
It has only one template for testing this feature after you have entered the settings. 
You can edit and use the test email template in Custom features -> SMTP -> on the right side of the page.
[[File:Smtp email path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/e/e4/Smtp_email_path_redesigned.png]]
 
:''[[SMTP custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Daily Report custom feature|Daily report]]==
When you enable and set this custom feature it will automatically send the email report about new, upcoming and cancelled appointments to your company email address. 
There is not template to edit as such, but you can adjust the items included in Custom features -> [[Daily Report custom feature|Daily report]] -> on the right side of the page.
[[File:Daily report settings path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/e/e2/Daily_report_settings_path_redesigned.png]]
 
:''[[Daily Report custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[HIPAA custom feature|HIPAA]]==
This is security-related custom feature and allows to send email notifications when somebody logs in to your system. 
It does not contain any email template to be edited and can be enabled/disabled by adding/removing the email address in Custom features -> [[HIPAA custom feature|HIPAA]] -> right side of the page -> Notify email.
[[File:Hipaa notifications settings path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/6/66/Hipaa_notifications_settings_path_redesigned.png]]
 
:''[[HIPAA custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Contact Widget custom feature|Contact widget]]==
As this custom feature allows to add a contact form to your booking website or create the contact button widget, there is also the email/SMS notification to company that is sent when somebody leaves a message on the booking site or widget so that you will be able to respond right away.
There is no template to edit but you can disable such notifications in Settings -> Email and SMS settings -> Contact widget notifications.
[[File:Contact widget notifications enable path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/b/b5/Contact_widget_notifications_enable_path_redesigned.png]]
 
:''[[Contact Widget custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>


==[[Medical test custom feature|Medical test]]==
When you are using this custom feature you definitely need to send the test results to patients' emails. 
In Custom features -> Medical test -> on the right side of the page you can enable/disable or edit the following templates:
* positive results(Email and SMS templates);
* negative results(Email and SMS templates);
* inconclusive results(Email and SMS templates).
[[File:Medical test notifications path redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/4/49/Medical_test_notifications_path_redesigned.png]]
In case you need to adjust the test result template please use Custom result template option above the templates.
 
:''[[Medical test custom feature|Read more]] about his custom feature use.''
--------
</translate>
<translate>

=What are variables= 


Variables are elements that can be inserted in email and sms templates (Settings -> Email and SMS settings). These variables will denote the chosen item after the booking is made. For example you have 2 providers: Mary and John. In email template you insert text "You have booked a service with [provider]". If the client chose on the booking page provider Mary, they would receive the following text "You have booked a service with Mary", if they chose John, they would receive the text "You have booked a service with John." 
You can always find the variables that can be used with the certain notification type near the template either on the right side of the page or in the popup that can be access by click on "Variables" button.
[[File:Variables overview redesigned.png|1200px|border|center|link=https://help.simplybook.me/images/d/d3/Variables_overview_redesigned.png]]
 
</translate>
<translate>

=iCals and how to use them= 


In Settings -> Email and SMS settings you can check the box Attach iCal to e-mails and then emails will contain file of .isc format. After clicking that file, it will open in one of your calendars (Google calendar, iCalendar,etc)


[[File:Ics files options redesigned.png|1200px | center|link=https://help.simplybook.me/images/2/23/Ics_files_options_redesigned.png]]
 
:'''Please note''', that iCal files do not have set timezone so the time in that file will be displayed according to the IP address/device settings.
 
</translate>
<translate>

=Clients/Providers do not receive notifications= 


;Possible reasons
:1. Corresponding boxes in Settings -> Email and SMS settings are not checked.


:2. Client/provider entered wrong email or phone.


:3. Email went to junk (Spam) folder or to Social tab. Please check Whitelisting instructions [[Email whitelisting instructions| here]].


:4. [[Custom Features#SMTP| SMTP]] custom feature is not set correctly.


:5. If sms are not coming, check your sms balance in Plans&Prices -> Subscriptions at the bottom of the page.
 
</translate>
<translate>

=Clients/Providers receive wrong notifications= 


:1. Please check if you have [[Custom Features#Multiple Bookings| '''Multiple Bookings''']] or [[Custom Features#Group Bookings| '''Group Bookings''']] Custom Feature enabled. These Custom Features have their own templates.


:'''Multiple bookings template''' (Custom Features -> Multiple bookings -> on the right side of the page)


[[File:Multiple bookings notifications path redesigned.png|1200px|border | center|link=https://help.simplybook.me/images/f/fc/Multiple_bookings_notifications_path_redesigned.png]]
 
:'''Group bookings template''' (Custom Features -> Group bookings -> on the right side of the page)


[[File:Group bookings notifications path.png|1200px|border| center|link=https://help.simplybook.me/images/6/66/Group_bookings_notifications_path.png]]
 
:2. Check if you have Time Zone settings on in Settings -> Main configuration, in this case client may have selected wrong time zone and received notification in wrong time zone too.


[[File:Timezone settings redesigned.png|1200px | center|link=https://help.simplybook.me/images/3/35/Timezone_settings_redesigned.png]]
 
</translate>
<translate>


=Email whitelisting instructions=
So here are a few things that you can do to make sure you get those all important emails from the team here at SimplyBook.me.


You can expect system notifications such as when your subscription is up for renewal, notices about bookings, and helpful information on various things such as how to get the most out of your [https://simplybook.me/ SimplyBook.me] service.


As great as technology is, it isn’t perfect, and sometimes email systems and internet service providers mistake legitimate email for spam. To ensure that you don’t miss important communication from us, please take the following steps:


Please whitelist any emails that come from the '''@simplybook.me''' domain.


'''Why?''' Because that tells your email service or program that you actually want emails from this domain, so that they can then make sure you get them.


'''How?''' Well, this differs between email services and programs but below you can see information about some of the main ones. If you aren’t using one of these, please refer to the help section for yourservice for information.

</translate>
<translate>

==Using Gmail or Gsuite== 


Filter messages from '''@simplybook.me''' and tell the system to never send it to spam:


:1. Go to Settings (click the gear icon at the top to the right)


[[File:Click settings.png| center]]


:2. Select the Filters and Blocked Addresses tab


[[File:Select filters and blocked addresses.png| center]]


:3. Towards the bottom of the tab, click the Create a new filter link

</translate>
<translate>


[[File:Gmail create a new filter.png| center]]


:4. In the From field write '''@simplybook.me'''
:5. Click Create filter with this search to the bottom right of the window


[[File:Gmail create filter with this search.png| center]]


:6. Tick the box next to Never send it to Spam
:7. Click the blue button that says Create filter


[[File:Gmail never send it to spam.png| center]]


Great! Now you won’t miss anything from us!


'''And to ensure that our emails don’t get lost in that Updates or Promotions tab:'''

</translate>
<translate>


:1. Find an email from SimplyBook.me in your inbox


:2. Click and drag it to the Primary tab in your inbox


[[File:Gmail move to primary tab.png| center]]
 
:3. You’ll be asked whether you want to do this for future emails, so tell them yes


[[File:Gmail do this with future emails from SimplyBook.me.png| center]]
 
</translate>
<translate>
==Using Yahoo! mail== 


:1. When you open an email message, hover your mouse on the Sender's name.


:2. Click the the three dots in the Sender's info window that appears and click Add to contacts.


[[File:Add to contacts yahoo.png| center]]
 
:3. When Add Contact form comes up, click Save.


[[File:Add contact yahoo form.PNG| center]]
 
</translate>
<translate>
==Using Mac Mail== 


:1. From the top menu select Mail -> Preferences


[[File:Step 1 - open Mail preferences.jpg| center]]
 
:2. Then select the Rules icon, click Add Rule and type a name for the rule in the description field. Use the following settings:


[[File:Step 2 - open Rules configuration.jpg| center]]
 
:3. “If any of the following conditions are met: From Contains”. In the text field besides Contains type '''@simplybook.me'''


[[File:Step 3 - add a rule for SimplyBook.me mails.jpg| center]]


:4. Select Move Message and Inbox from the drop down menus and then click OK to save the rule.
 
</translate>
<translate>
==Using Outlook== 


:1. Right-click on the message in your inbox.


:2. Select Junk E-mail from the menu.


:3. Click Never Block Sender or Never Block Sender's Domain (@example.com).


[[File:Outlook not junk.jpg| center]]
 
Great, you’re all set! We look forward to being in touch and seeing your business blossom!

</translate>

Custom CSS custom feature

2025-07-22T12:13:26Z

Tania:

<languages/>
{{#seo:
|title=Custom Features - SimplyBook.me
<translate>

|description=Personalize your booking page with custom CSS. Adjust design elements to match your brand. Start customizing today!
</translate>
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, CSS, adjusting design, adjusting colors, adjusting font, adjusting look, CSS coding
}}
<translate>


 
[[File:Custom css new icon.png ‎|left]]


Make your own booking interface with this CSS Custom Feature. It allows to change the styles of different elements, hide them, change fonts, colors, font-sizes, etc. If you know CSS coding, please use tools of browser to find identifiers of elements and write rules in the settings of Custom Feature, if you have no deep knowledge of CSS, please contact support and they will try to find the best solution for you.
 


Please note! A great number or complex CSS requests may be considered as set up assistance and you may be asked to purchase Set up assistance option for further CSS code set up. It is a paid offer which you can find under plans&prices -> additional items -> hourly assistance. To schedule a call for Set-up Assistance evaluation, please click on the following link: https://bigaccounts.simplybook.it/v2/#book/service/3/count/1



 
Free custom feature!
 
;How to use
:1. Enable this option on your Custom Features page.
[[File:Custom css enable path redesigned.png|1200px| center|link=https://help.simplybook.me/images/9/93/Custom_css_enable_path_redesigned.png]]
 
:2. Click on "Settings" for this feature.
[[File:Custom css settings path redesigned.png|1200px | center|link=https://help.simplybook.me/images/3/35/Custom_css_settings_path_redesigned.png]]
 
:3. Add the code(s) to adjust the styles to "Booking pages CSS" tab if you wish to edit the booking page 
:or "Widget CSS" if you are editing widget on your website.
[[File:Custom css tabs redesigned.png|1200px| center|link=https://help.simplybook.me/images/1/1c/Custom_css_tabs_redesigned.png]]
 
'''[[Special:MyLanguage/Remove Elements from booking page#Removing with Custom CSS| See most common requests how to remove elements with CSS here (phone, email fields, social tabs, our time, etc)]]'''
 
</translate>

Company public service methods

2025-05-16T15:15:50Z

Tania:

{{#seo:
|title=Company public service methods - SimplyBook.me
|description=Explore public-facing service methods to improve client access. Manage service visibility with ease. Learn more now!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}

==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.

The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.

Example

<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Hourly photoshoot",
"duration": "60",
"hide_duration": "0",
"description": "If you want to try yourself as a model but haven't decided on an image. 5-7 retouched and print-ready photos + the raw footage on a disc ",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>

Example of request with error response:

<pre>
Request
{
"jsonrpc": "2.0",
"method": "someNotExistingMethod",
"params":[],
"id":1
}

Response
{
"jsonrpc": "2.0",
"id":1,
"error": {
"code": -32601,
"message": "Method not found"
}
}
</pre>

All calls of public service methods should have two additional HTTP headers:

* <code>X-Company-Login</code>
* <code>X-Token</code> an authentication token. See [[Company public service methods#Authentication|authentication]] section.

===Endpoint===

Use URL <code>https://user-api.simplybook.me/</code> for all public service API calls.

===Authentication===

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getToken|getToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom Features#API|API Custom Feature]] 'Settings'.

== Methods ==

=== book ===

<code>book($eventId, $unitId, $date, $time, $clientData, $additional, $count, $batchId, $recurringData)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String - in Y-m-d format
* '''$time''' String - in H:i:s format
* '''$clientData''' Object - eg. {name: 'Name', email: 'test@gmail.com', phone: '+38099999999'}
* '''$additional''' array|Object - additional params and fields.
* '''$count''' Integer - bookings count, min. 1 (using for group bookings batch). (optional)
* '''$batchId''' Integer - add booking to multiple bookings batch. (optional)
* '''$recurringData''' Array - make booking recurrent. (optional)

Returns Object.

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[Company public service methods#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>'client_time_offset'</code> value in <code>$clientData</code> object as difference
between client's time zone and company's time zone in minutes. For example if company located in city with time
zone GMT+2 and customer located in city with GMT+3 then <code>$clientTimeOffset</code> will be 60 minutes. You
can get information about company's time zone using <code>[[Company public service methods#getCompanyInfo|getCompanyInfo]]</code> API method. To
create batch booking you can specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one
parameter can be specified). You should specify an <code>$additionalFields</code> parameter if service requires
some intake forms (see [[Custom Features#Intake Forms|Intake Forms Custom feature]]). To create a booking with promo code you
should pass it as additional field. For example: <code>{"name": "promocode", "value": "some code", "type": "text"}</code>See [[Company public service methods#book response|example]] of <code>book</code> API method response.

See also:

* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

----

=== calculateEndTime ===

<code>calculateEndTime($startDateTime, $eventId, $unitId)</code>

Parameters:

* '''$startDateTime''' String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
* '''$eventId''' Integer
* '''$unitId''' Integer

Returns String|Boolean.

Returns end datetime if booking is available, else return false

----

=== cancelBooking ===

<code>cancelBooking($id, $sign)</code>

Parameters:

* '''$id''' Integer
* '''$sign''' String

Returns Boolean.

Cancels a booking. <code>$sign</code> parameter must be a string created with formula: <code>md5($bookingId . $bookingHash . $secretKey)
</code>. You can get <code>$bookingHash</code> value as result of <code>[[Company public service methods#book|book]]</code> API method call. Method
return an error with code -32080 (Appointment couldn't be found) if record with specified id not exists. Methods returns
an error with code -32085 (Signature error) if <code>$sign</code> parameter is wrong.

----

=== confirmBooking ===

<code>confirmBooking($id, $sign)</code>

Parameters:

* '''$id''' Integer
* '''$sign''' String

Returns Boolean.

Confirm booking. Signature is required.$sign = md5($bookingId . $bookingHash . $secretKey);
Call this method from server side only

----

=== confirmBookingBatch ===

<code>confirmBookingBatch($batchId, $batchType, $sign)</code>

Parameters:

* '''$batchId''' Integer
* '''$batchType''' String
* '''$sign''' String

Returns Boolean.

Confirms booking batch. Signature is required.$sign = md5($batchId . $batchHash . $secret)
Call this method from server side only

----

=== confirmBookingBatchPayment ===

<code>confirmBookingBatchPayment($batchId, $batchType, $paymentProcessor, $sign)</code>

Parameters:

* '''$batchId''' Integer
* '''$batchType''' String
* '''$paymentProcessor'''
* '''$sign''' String

Returns Boolean.

Confirms booking batch payment. Signature is required.$sign = md5($batchId . $batchHash . $secret)
Call this method from server side only

----

=== confirmBookingCart ===

<code>confirmBookingCart($cartId, $paymentProcessor, $sign)</code>

Parameters:

* '''$cartId''' Integer - cart id
* '''$paymentProcessor''' String - payment processor name
* '''$sign''' String - signature. (md5($cartId . $cartHash . $secretKey))

Returns Boolean.

Confirm booking cart. Use it to confirm payment. Signature is required.

----

=== confirmBookingPayment !Deprecated!===

<code>confirmBookingPayment($id, $paymentProcessor, $sign)</code>

Parameters:

* '''$id''' Integer
* '''$paymentProcessor''' String
* '''$sign''' String

Returns Boolean.

Confirm booking payment. Signature is required.$sign = md5($bookingId . $bookingHash . $secretKey);
Call this method from server side only

----

=== createBatch ===

<code>createBatch()</code>

No arguments.
Returns Integer.

Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[Company public service methods#book|book]]</code>
API method.

----

=== filterAvailableUnits ===

<code>filterAvailableUnits($eventId, $dateTime, $unitIds, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$unitIds'''
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with locations Custom feature.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>

----

=== getAdditionalFields ===

<code>getAdditionalFields($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Return intake forms for certain event if [[Custom Features#Intake Forms|Intake Forms Custom feature]] is
activated. Returns empty array otherwise. Call <code>[[Company public service methods#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.

----

=== getAnyUnitData ===

<code>getAnyUnitData()</code>

No arguments.
Returns Object|null.

Returns information about [[Custom Features#Any Employee Selector|Any Employee Selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}

----

=== getAvailableTimeIntervals ===

<code>getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: <code>{['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}</code>

----

=== getAvailableUnits ===

<code>getAvailableUnits($eventId, $dateTime, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: <code>[1, 2, 3]</code>

----

=== getBooking ===

<code>getBooking($id, $sign)</code>

Parameters:

* '''$id''' Integer
* '''$sign''' String

Returns Object.

Returns an object with details information about booking. <code>$sign</code> parameter must be a string created
with formula: <code>md5($bookingId . $bookingHash . $secretKey)</code>. You can get <code>$bookingHash</code>
value as result of <code>[[Company public service methods#book|book]]</code> API method call. Method return an error with code -32080
(Appointment couldn't be found) if record with specified id not exists. Methods returns an error with code -32085
(Signature error) if <code>$sign</code> parameter is wrong.

----

=== getBookingCart ===

<code>getBookingCart($bookingIds)</code>

Parameters:

* '''$bookingIds''' Array

Returns Object.

Returns cart information by bookings ids.

* <code>cart_id</code> and <code>cart_hash</code> is used to create secure signature to confirm cart payment.
* <code>amount</code> - is total amount to payment
* <code>currency</code> - cart currency
* <code>cart</code> - contains cart items. You can use them to provide information for payment system. Each item is object with following fields:
* <code>id</code> - booking id
* <code>event_id</code> - service id
* <code>name</code> - event name + start date time (use it to provide cart information for payment system)
* <code>price</code> - booking price
* <code>qty</code> - qty of bookings

----

=== getBookingDetails ===

<code>getBookingDetails($id, $sign)</code>

Parameters:

* '''$id''' Integer
* '''$sign''' String

Returns Object.

Returns an object with details information about booking. <code>$sign</code> parameter must be a string created
with formula: <code>md5($bookingId . $bookingHash . $secretKey)</code>. You can get <code>$bookingHash</code>
value as result of <code>[[Company public service methods#book|book]]</code> API method call. Method return an error with code -32080
(Appointment couldn't be found) if record with specified id not exists. Methods returns an error with code -32085
(Signature error) if <code>$sign</code> parameter is wrong.

----

=== getCategoriesList ===

<code>getCategoriesList($isPublic)</code>

Parameters:

* '''$isPublic''' boolean

Returns Array.

Returns company categories list if [[Custom Features#Service Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if Custom Feature is not activated. Use <code>[[Company public service methods#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.

----

=== getCompanyInfo ===

<code>getCompanyInfo()</code>

No arguments.
Returns Object.

Returns an object with detailed information about company. See [[Company public service methods#getCompanyInfo response|example of response]].

----

=== getCompanyParam ===

<code>getCompanyParam($key)</code>

Parameters:

* '''$key''' String

Returns mixed.

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[Company public service methods#Company params|list of available keys]].

----

=== getCompanyParams ===

<code>getCompanyParams($keys)</code>

Parameters:

* '''$keys''' Array

Returns Array.

Returns company's config values for specified keys as key-value map. For non-existent and not-allowed param keys
it will return '''false''' as result. A different set of keys available for public API and for company
administration API. See [[Company public service methods#Company params|list of available keys]].

----

=== getCompanyTimezoneOffset ===

<code>getCompanyTimezoneOffset()</code>

No arguments.
Returns array.

Returns company timezone offset and company timezone

----

=== getCountryPhoneCodes ===

<code>getCountryPhoneCodes()</code>

No arguments.
Returns Array.

Returns country phone code list

----

=== getEventList ===

<code>getEventList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' boolean
* '''$asArray''' boolean

Returns Array.

Returns company's events list. If <code>$asArray</code> is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
event's details object.

----

=== getFirstWorkingDay ===

<code>getFirstWorkingDay($unitId)</code>

Parameters:

* '''$unitId''' Integer

Returns String.

Returns first working date for unit

----

=== getLocationsList ===

<code>getLocationsList($isPublic, $asArray)</code>

Parameters:

* '''$isPublic''' Boolean Optional. Default value is '''false'''.
* '''$asArray''' boolean Optional. Default value is '''false'''.

Returns Array.

Returns available locations for company if Custom Feature [[Custom Features#Multiple Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[Company public service methods#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.

This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.

----

=== getPaymentProcessorConfig ===

<code>getPaymentProcessorConfig($paymentProcessor)</code>

Parameters:

* '''$paymentProcessor''' String

Returns Array.

Returns payment processor config

----



----

=== getPluginStatuses ===

<code>getPluginStatuses($pluginNames)</code>

Parameters:

* '''$pluginNames''' Array

Returns Array.

Return Custom Feature status true if status active, else false. See [[Company public service methods#Custom Features.27 identifiers|list of available Custom Feature's names]].

----

=== getPromocodeInfo ===

<code>getPromocodeInfo($code)</code>

Parameters:

* '''$code''' String

Returns Array|null.

Returns an object with detailed information about promotion by promotion code. Returns null if no promotions with
specified code were not found.

----


----

=== getRecurringDatetimes ===

<code>getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String
* '''$time''' String
* '''$recurringData''' Array

Returns Array.

Get list of dates for recurring booking

----

=== getReservedTime ===

<code>getReservedTime($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$count''' Integer

Returns Object.

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom Features#Calendar Sync|Calendar Sync Custom Feature]] is enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[Company public service methods#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.

Example:
<pre>
{
"2016-02-05": [
{
"dd": [], // time slots from Google calendar
"events": [ // reserved time slots
{ "from": "16:00", "to": "16:30" },
{ "from": "16:30", "to": "17:00" },
... ],
"type": "reserved_time",
},
{
"events": [
{ "from": "09:00", "to": "09:30" },
{ "from": "09:30", "to": "10:00" },
... ],
"type": "not_worked_time"
}],
...
}
</pre>

----

=== getReservedTimeIntervals ===

<code>getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Integer|Array
* '''$count''' Integer

Returns Object.

Returns not available time
Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

----

=== getStartTimeMatrix ===

<code>getStartTimeMatrix($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available start time, taking into account breaktimes, start and end working time
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>

If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom Features#Multiple Locations|Multiple Locations]] Custom Feature description for
more details.

----

=== getTimeframe ===

<code>getTimeframe()</code>

No arguments.
Returns Integer.

Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need to change interval (timeframe)|here]].

----

=== getTimelineType ===

<code>getTimelineType()</code>

No arguments.
Returns String.

Returns company calendar layout type

----

=== getUnitList ===

<code>getUnitList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' boolean
* '''$asArray''' boolean

Returns Array.

Returns list of service performers. If <code>$asArray</code> is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
of event's details object.

----

=== getUserLicenseText ===

<code>getUserLicenseText()</code>

No arguments.
Returns String.

Returns user license text if user license Custom Feature is turned on,
otherwise throws exception

----

=== getWorkCalendar ===

<code>getWorkCalendar($year, $month, $unitId)</code>

Parameters:

* '''$year''' Integer
* '''$month''' Integer
* '''$unitId''' Integer

Returns Object.

Returns company work schedule as array
Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

----

=== getWorkDaysInfo ===

<code>getWorkDaysInfo($from, $to, $unitId, $eventId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$unitId''' Integer (optional)
* '''$eventId''' Integer (optional)
* '''$count''' Integer (optional)

Returns Object.

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from
service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:

<pre>
{'2014-05-14' : [
{'from': '09:00:00', 'to': '13:00:00'},
{'from': '14:00:00', 'to': '19:00:00'}
] }
</pre>

Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.

----

=== hasUpcommingPromotions ===

<code>hasUpcommingPromotions()</code>

No arguments.
Returns Boolean.

Returns availability of active promotions

----

=== isPaymentRequired ===

<code>isPaymentRequired($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Boolean.

Returns true if [[Custom Features#Accept Payments|Accept Payments]] Custom Feature activated and event with specified id has
configured price. If no parameters specified then method returns true if payments Custom Feature activated and at least
one event has configured price. Otherwise returns false.

----

=== isPluginActivated ===

<code>isPluginActivated($pluginName)</code>

Parameters:

* '''$pluginName''' String

Returns Boolean.

Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom Features]] page for full Custom Features description. See [[Company public service methods#Custom Features.27 identifiers|list of available Custom Features' names]].

----

=== validatePayment ===

<code>validatePayment($paymentInfo, $cartId)</code>

Parameters:

* '''$paymentInfo''' mixed
* '''$cartId''' Integer

Returns Boolean.

Validate application payment.

----

=== validatePromoCode ===

<code>validatePromoCode($code, $startDateTime, $eventId, $count, $clientData)</code>

Parameters:

* '''$code''' String
* '''$startDateTime''' String
* '''$eventId''' Integer
* '''$count''' Integer
* '''$clientData''' array|Object

Returns Boolean.

Validate promotion code.Returns true in case promocode is valid otherwise throws exception with error.

----

==Constants==

=== Error codes ===

See [[Errors handling]] for details.

* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32015 Passed event id is not reccuren
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Intake forms values are wrong
* -32080 Appointemnt couldn't be found
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found

----

===Company params===

Use these values to get configuration params for company with <code>[[Company public service methods#getCompanyParam|getCompanyParam]]</code> API method.

=====General params=====

* allow_event_breaktime_break
*: <code>true</code> if service can extend over breaktime
* allow_event_day_break
*: <code>true</code> if service can extend over closing hours
* changable_prefix_by_client
* company_timezone
* date_format
* fixed_country_prefix
* max_group_bookings
*: [[Custom Features#Group Bookings|Group Bookings Custom Feature]] configuration. Integer.
* max_time_till_event
* min_time_till_event
* monday_is_first_day
*: <code>true</code> if monday specified as first day of the week in company's settings
* require_fields
*: Client's data fields required for booking. String. Possible values:
** phone - phone number is required
** email - email address is required
** email_phone - phone number and email address are required
* send_notifications_in_client_timezone
* show_booking_page_in_client_timezone
* time_format
* timeframe
*: Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes. You can find more details about timeframe [[Need to change interval (timeframe)|here]]
* user_public_timeline_type
*: String. Can be one of the following values:
** flexible
** modern
** flexible_week
** modern_week
** classes
** classic
*: Please note that <code>classic</code> timeline type is deprecated and not supported anymore.

=====Accept Payments Custom Feature params=====

Read more about [[Custom Features#Accept Payments|Accept Payments Custom Feature configuration]].

* allow_delay_payment
*: Allow delay payment option. Boolean.
* hide_sale_tax
*: Hide sales tax option. Boolean.
* payment_timeout
*: Payment timeout option. String ("5 minutes", "1 hour", ...)
* sale_tax
*: Sales tax option. Integer. You should divide by 100 to get percent value.

=====Cancellation Policy Custom Feature params=====

Read more about [[Custom Features#Cancellation Policy|Cancellation Policy Custom Feature configuration]].

* cancelation_policy_text
*: Full policy text. String.
* cancelation_policy_label
*: Short label for confirmation control. String.
* cancelation_policy_period
*: Time period value. String ("5 minutes", "1 hour", ...)

----

====Custom Features' identifiers====

Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[Company public service methods#isPluginActivated|isPluginActivated]]</code> and <code>[[Company public service methods#getPluginStatuses|getPluginStatuses]]</code> API methods.

* advanced_notification
*:Book Soon notification system
* any_unit
*:Any Employee selector
* api
*:API
* approve_booking
*:Approve booking
* back_to_site
*:Take me back home
* contact_widget
*:Contact widget
* counter
*:Visitor Counter
* custom_css
*:Custom CSS
* data_security
*:Clean history
* description
*:HTML description field for events
* event_category
*:Service categories
* event_field
*:Intake forms
* facebookImage
*:Facebook client info
* financial_dashboard
*:Insights
* google_analytics
*:Google Adwords and analytics
* google_calendar_export
*:Calendar sync
* group_booking
*:Group bookings
* hipaa
*:HIPAA
* limit_bookings
*:Limit bookings
* location
*:Multiple locations
* mobile_app_backend
*:Mobile application
* multiple_booking
*:Multiple bookings
* news
*:News
* paid_events
*:Accept payments

* recap
*:Daily report
* secure
*:SSL
* status
*:Status
* unit_colors
*:Providers color coding
* user_license
*:Terms and conditions
* cancelation_policy
*:Cancellation Policy

See [[Custom Features]] page for description for each .

----

== Examples ==

====book response====

[[Company public service methods#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.

{
"require_confirm":false,
"bookings":[
{
"id":"434",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-30 13:00:00",
"end_date_time":"2015-12-30 13:30:00",
"is_confirmed":"1",
"code":"h8vc14ca",
"hash":"785cb8cce316e64765b94c05a635f4be"
},
{
"id":"435",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-31 13:00:00",
"end_date_time":"2015-12-31 13:30:00",
"is_confirmed":"1",
"code":"h8vc2pge",
"hash":"8b92d634541bfd93c0830967e56f4653"
},
{
"id":"436",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-04 13:00:00",
"end_date_time":"2016-01-04 13:30:00",
"is_confirmed":"1",
"code":"h8vc3urb",
"hash":"cd22a0bf183f7350e595988dd2486e5b"
},
{
"id":"437",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-05 13:00:00",
"end_date_time":"2016-01-05 13:30:00",
"is_confirmed":"1",
"code":"h8vc44d9",
"hash":"53f98ff4e4a0323aa907156c59c99362"
}
],
"batch_type":"batch_recurrent_booking",
"recurrent_batch_id":"1",
"batch_hash":"357178bce290381bb7235080941ec143"
}

----

====getCompanyInfo response====

An example of data returned by [[Company public service methods#getCompanyInfo|getCompanyInfo]] API method.

{
"login": "pierrecoetzee",
"name": "Pierre",
"description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"address1": "",
"address2": "Storey's Gate, ",
"city": "London",
"country_id": "GB",
"lat": "51.500435",
"lng": "-0.129811",
"email": "pierre.coe@gmail.com",
"phone": "",
"web": null,
"skip_address": null,
"logo": null,
"address": "GB, London, Storey's Gate, ",
"description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"timezone": "Europe London",
"show_in_client_timezone": false,
"timeframe": "60",
"timeline_type": "modern_week",
"allow_event_day_break": "0",
"allow_event_breaktime_break": "0"
}

<code>timeline_type</code> field can be one the following values:

* flexible
* modern
* flexible_week
* modern_week
* classic
* classes

Please note that <code>classic</code> timeline type is deprecated and not supported anymore.

<code>description</code> field contains raw data of company's description which can include HTML tags. <code>description_text</code> field contains only text information without HTML tags.

For information about <code>timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[Company public service methods#Company params|Company params section]].
----


----

====getLocationsList response====

{
"1": {
"id": "1",
"title": "location 1",
"description": null,
"picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
"address1": null,
"address2": "Saint Margaret Street",
"city": "London",
"zip": null,
"country_id": "GB",
"lat": "51.50013000000000000000",
"lng": "-0.12630500000000000000",
"phone": "",
"position": "1",
"is_default": "1",
"file_id": "4",
"picture_sub_path": "\/image_files",
"picture_path": "\/uploads\/mycompany\/image_files\/small\/e1e9409fe9682c78b2f8f294dc151af0.jpg",
"units": ["1", "3", "4", "5"]
},
...
}

<code>position</code> property of location object used for order list. <code>units</code> array contains list of performers ids associated with location.

SBPay.me

2025-05-15T15:27:36Z

Tania: Marked this version for translation

<languages/>
<translate>

{{#seo:
|title=SBPay.me - SimplyBook.me
|description=Use SBPay.me for secure online payments. Streamline transactions and ensure payment reliability. Learn more here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>

[https://sbpay.me SBPay.me] allows you to choose from a broad range of payment processors to handle payments from your clients. Via the [https://sbpay.me SBPay.me] platform, you can then manage your payments and clients, prolong or cancel subscriptions, refund and access extensive reporting.
</translate>

<translate>

*<div class="article">[[SBPay.me integration| SBPay.me integration with SimplyBook.me]]</div>
*<div class="article">[[QuickBooks integration]]</div>
*<div class="article">[[Xero integration]]</div>
*<div class="article">[[FreshBooks integration]]</div>
*<div class="article">[[Zapier integration wit SBPay.me|Zapier integration]]</div>
*<div class="article">[[SBPay.me User Roles]]</div>
</translate>

SBPay.me

2025-05-15T15:27:27Z

Tania:

<languages/>
<translate>
{{#seo:
|title=SBPay.me - SimplyBook.me
|description=Use SBPay.me for secure online payments. Streamline transactions and ensure payment reliability. Learn more here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
[https://sbpay.me SBPay.me] allows you to choose from a broad range of payment processors to handle payments from your clients. Via the [https://sbpay.me SBPay.me] platform, you can then manage your payments and clients, prolong or cancel subscriptions, refund and access extensive reporting.
</translate>

<translate>
*<div class="article">[[SBPay.me integration| SBPay.me integration with SimplyBook.me]]</div>
*<div class="article">[[QuickBooks integration]]</div>
*<div class="article">[[Xero integration]]</div>
*<div class="article">[[FreshBooks integration]]</div>
*<div class="article">[[Zapier integration wit SBPay.me|Zapier integration]]</div>
*<div class="article">[[SBPay.me User Roles]]</div>
</translate>

Zapier integration wit SBPay.me

2025-05-15T15:26:18Z

Tania: Marked this version for translation

<languages/>
<translate>

{{#seo:
|title=Zapier integration with SBPay.me - SimplyBook.me
|description=Integrate SBPay.me with Zapier for automated payment processing. Simplify transactions and workflows. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}
</translate>

<translate>

[[File:Zapier-Logo-upd.png|50px|left]] Connect SBPay.me to 2,000+ other web services with the help of [https://zapier.com/apps Zapier] integration. Set up the connections in minutes with no coding to automate your day-to-day tasks and build workflows between important apps. Choose SBPay.me as a trigger app and set the transactions and invoices data to the systems that you frequently use.
 
</translate>

<translate>

==Available triggers:==
* Payment Created;
* Payment Confirmed (paid);
* Payment Refunded;
* Invoice Finalized (prepared for payment);
* Invoice Paid;
* Invoice Voided.
 
</translate>

<translate>

==Available data (payment triggers):==
* transaction id;
* transaction description;
* customer information (id, name, email, phone, address, custom fields);
* transaction lines (item name, description, price, quantity, discounts, taxes);
* currency;
* amount;
* payment system;
* payment method;
* date and time when the document was created;
* date and time when the document was changed last time;
* payment status;
* payment type;
* whether the payment was refunded by payment system;
* whether the payment was confirmed manually by SBPay.me user;
* taxes information;
* tags.
 
</translate>

<translate>

==Available data (invoice triggers):==
* invoice number;
* invoice description;
* customer information (id, name, email, phone, address, custom fields);
* invoice lines (item name, description, price, quantity, discounts, taxes);
* currency;
* amount;
* date and time when the document was created;
* date and time when the document was changed last time;
* invoice due date;
* invoice status;
* invoice type;
* whether there are any has credit notes related to that invoice;
* total amount without taxes;
* total discount amount;
* taxes information;
* tags.
 
</translate>

<translate>

==How to set:==
1. Enable Zapier custom feature in your SBPay.me interface. 
[[File:Zapier sbpay enable path.png|1200px|center|link=https://help.simplybook.me/images/7/75/Zapier_sbpay_enable_path.png]]
 
</translate>

<translate>

2. Navigate to '''Users''' page and click on '''New user'''. 
[[File:Sbpay new user path.png|1200px|center|link=https://help.simplybook.me/images/c/cc/Sbpay_new_user_path.png]]
 
</translate>

<translate>

3. Create one more users with '''Admin''' access level. (use '''New user''' button to save the new user). 
[[File:Create new admin user sbpay.png|1200px|center|link=https://help.simplybook.me/images/0/0a/Create_new_admin_user_sbpay.png]]
 
</translate>

<translate>

4. Log in as this admin user to your SBPay.me account.
 
</translate>

<translate>

5. Log in to your [https://zapier.com/app/login Zapier account] or create a new one.
 
</translate>

<translate>

6. Create new Zap by clicking on '''Create''' and then '''Zaps''' button in Zapier interface. 
[[File:Create new zap path.png|1200px|center|link=https://help.simplybook.me/images/2/27/Create_new_zap_path.png]]
 
</translate>

<translate>

7. Look for SBPay.me in Trigger step or use [https://zapier.com/apps/sbpayme/integrations this link]. 
[[File:Sbpay app in zapier.png|1200px|center|link=https://help.simplybook.me/images/d/dd/Sbpay_app_in_zapier.png]]
 
</translate>

<translate>

8. Select the desirable trigger. 
[[File:Select trigger in Zapier.png|1200px|center|link=https://help.simplybook.me/images/8/86/Select_trigger_in_Zapier.png]]
 
</translate>

<translate>

9. Proceed to connecting SBPay.me account. 
[[File:Connect sbpay account path in zapier.png|1200px|center|link=https://help.simplybook.me/images/8/82/Connect_sbpay_account_path_in_zapier.png]]
 
</translate>

<translate>

10. In the popup window that appears please enter your SBPay.me '''company login'''. 
[[File:Company login to sbpay.png|1200px|center|link=https://help.simplybook.me/images/b/ba/Company_login_to_sbpay.png]]
 
</translate>

<translate>

11. In the SBPay.me interface navigate to '''Settings''' -> '''API keys''' and click on "View keys". 
[[File:Api keys path sbpay.png|1200px|center|link=https://help.simplybook.me/images/7/7f/Api_keys_path_sbpay.png]]
 
</translate>

<translate>

12. Confirm the action by entering your password and you will get access to the keys.
 
</translate>

<translate>

13. Copy '''Authentication Token''' and paste it to the corresponding field on Zapier side. 
[[File:Copy sbpay api keys.png|1200px|center|link=https://help.simplybook.me/images/0/06/Copy_sbpay_api_keys.png]]
[[File:Auth token to sbpay.png|1200px|center|link=https://help.simplybook.me/images/0/0e/Auth_token_to_sbpay.png]]
 
</translate>

<translate>

14. Click Continue to test this step.
 
</translate>

<translate>

15. Proceed to adding the Action step and search for the app you wish to connect SBPay.me to. 
For example:
[[File:Zapier action example.png|1200px|center|link=https://help.simplybook.me/images/4/4a/Zapier_action_example.png]]
[[File:Zapier variables use example.png|1200px|center|link=https://help.simplybook.me/images/2/24/Zapier_variables_use_example.png]]
 
</translate>

<translate>

16. Connect this application account and setup the template using the available data mentioned above.
 
</translate>

<translate>

17. You can test this step operation as well if necessary or skip it.
 
</translate>

<translate>

18. Finish the setup, add Zap name and turn it on.
 
</translate>

<translate>

==Synchronize old records==
You can synchronize old records for the selected event and date range to trigger the action in Zapier. 
Please follow the next steps: 
1. Navigate to '''Custom features''' -> '''Zapier''' in your SBPay.me interface.
 
</translate>

<translate>

2. In '''Sync records for event''' please select the events type that you would like to sync and the date range in the next fields. 
[[File:Zapier sbpay sync old events select type.png|1200px|center|link=https://help.simplybook.me/images/d/d9/Zapier_sbpay_sync_old_events_select_type.png]]
 
</translate>

<translate>

3. Click '''Synchronize records'''. 
[[File:Zapeir sbpay sync old records option.png|1200px|center|link=https://help.simplybook.me/images/9/99/Zapeir_sbpay_sync_old_records_option.png]]
 
</translate>

Zapier integration wit SBPay.me

2025-05-15T15:26:08Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Zapier integration with SBPay.me - SimplyBook.me
|description=Integrate SBPay.me with Zapier for automated payment processing. Simplify transactions and workflows. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}
</translate>

<translate>
[[File:Zapier-Logo-upd.png|50px|left]] Connect SBPay.me to 2,000+ other web services with the help of [https://zapier.com/apps Zapier] integration. Set up the connections in minutes with no coding to automate your day-to-day tasks and build workflows between important apps. Choose SBPay.me as a trigger app and set the transactions and invoices data to the systems that you frequently use.
 
</translate>

<translate>
==Available triggers:==
* Payment Created;
* Payment Confirmed (paid);
* Payment Refunded;
* Invoice Finalized (prepared for payment);
* Invoice Paid;
* Invoice Voided.
 
</translate>

<translate>
==Available data (payment triggers):==
* transaction id;
* transaction description;
* customer information (id, name, email, phone, address, custom fields);
* transaction lines (item name, description, price, quantity, discounts, taxes);
* currency;
* amount;
* payment system;
* payment method;
* date and time when the document was created;
* date and time when the document was changed last time;
* payment status;
* payment type;
* whether the payment was refunded by payment system;
* whether the payment was confirmed manually by SBPay.me user;
* taxes information;
* tags.
 
</translate>

<translate>
==Available data (invoice triggers):==
* invoice number;
* invoice description;
* customer information (id, name, email, phone, address, custom fields);
* invoice lines (item name, description, price, quantity, discounts, taxes);
* currency;
* amount;
* date and time when the document was created;
* date and time when the document was changed last time;
* invoice due date;
* invoice status;
* invoice type;
* whether there are any has credit notes related to that invoice;
* total amount without taxes;
* total discount amount;
* taxes information;
* tags.
 
</translate>

<translate>
==How to set:==
1. Enable Zapier custom feature in your SBPay.me interface. 
[[File:Zapier sbpay enable path.png|1200px|center|link=https://help.simplybook.me/images/7/75/Zapier_sbpay_enable_path.png]]
 
</translate>

<translate>
2. Navigate to '''Users''' page and click on '''New user'''. 
[[File:Sbpay new user path.png|1200px|center|link=https://help.simplybook.me/images/c/cc/Sbpay_new_user_path.png]]
 
</translate>

<translate>
3. Create one more users with '''Admin''' access level. (use '''New user''' button to save the new user). 
[[File:Create new admin user sbpay.png|1200px|center|link=https://help.simplybook.me/images/0/0a/Create_new_admin_user_sbpay.png]]
 
</translate>

<translate>
4. Log in as this admin user to your SBPay.me account.
 
</translate>

<translate>
5. Log in to your [https://zapier.com/app/login Zapier account] or create a new one.
 
</translate>

<translate>
6. Create new Zap by clicking on '''Create''' and then '''Zaps''' button in Zapier interface. 
[[File:Create new zap path.png|1200px|center|link=https://help.simplybook.me/images/2/27/Create_new_zap_path.png]]
 
</translate>

<translate>
7. Look for SBPay.me in Trigger step or use [https://zapier.com/apps/sbpayme/integrations this link]. 
[[File:Sbpay app in zapier.png|1200px|center|link=https://help.simplybook.me/images/d/dd/Sbpay_app_in_zapier.png]]
 
</translate>

<translate>
8. Select the desirable trigger. 
[[File:Select trigger in Zapier.png|1200px|center|link=https://help.simplybook.me/images/8/86/Select_trigger_in_Zapier.png]]
 
</translate>

<translate>
9. Proceed to connecting SBPay.me account. 
[[File:Connect sbpay account path in zapier.png|1200px|center|link=https://help.simplybook.me/images/8/82/Connect_sbpay_account_path_in_zapier.png]]
 
</translate>

<translate>
10. In the popup window that appears please enter your SBPay.me '''company login'''. 
[[File:Company login to sbpay.png|1200px|center|link=https://help.simplybook.me/images/b/ba/Company_login_to_sbpay.png]]
 
</translate>

<translate>
11. In the SBPay.me interface navigate to '''Settings''' -> '''API keys''' and click on "View keys". 
[[File:Api keys path sbpay.png|1200px|center|link=https://help.simplybook.me/images/7/7f/Api_keys_path_sbpay.png]]
 
</translate>

<translate>
12. Confirm the action by entering your password and you will get access to the keys.
 
</translate>

<translate>
13. Copy '''Authentication Token''' and paste it to the corresponding field on Zapier side. 
[[File:Copy sbpay api keys.png|1200px|center|link=https://help.simplybook.me/images/0/06/Copy_sbpay_api_keys.png]]
[[File:Auth token to sbpay.png|1200px|center|link=https://help.simplybook.me/images/0/0e/Auth_token_to_sbpay.png]]
 
</translate>

<translate>
14. Click Continue to test this step.
 
</translate>

<translate>
15. Proceed to adding the Action step and search for the app you wish to connect SBPay.me to. 
For example:
[[File:Zapier action example.png|1200px|center|link=https://help.simplybook.me/images/4/4a/Zapier_action_example.png]]
[[File:Zapier variables use example.png|1200px|center|link=https://help.simplybook.me/images/2/24/Zapier_variables_use_example.png]]
 
</translate>

<translate>
16. Connect this application account and setup the template using the available data mentioned above.
 
</translate>

<translate>
17. You can test this step operation as well if necessary or skip it.
 
</translate>

<translate>
18. Finish the setup, add Zap name and turn it on.
 
</translate>

<translate>
==Synchronize old records==
You can synchronize old records for the selected event and date range to trigger the action in Zapier. 
Please follow the next steps: 
1. Navigate to '''Custom features''' -> '''Zapier''' in your SBPay.me interface.
 
</translate>

<translate>
2. In '''Sync records for event''' please select the events type that you would like to sync and the date range in the next fields. 
[[File:Zapier sbpay sync old events select type.png|1200px|center|link=https://help.simplybook.me/images/d/d9/Zapier_sbpay_sync_old_events_select_type.png]]
 
</translate>

<translate>
3. Click '''Synchronize records'''. 
[[File:Zapeir sbpay sync old records option.png|1200px|center|link=https://help.simplybook.me/images/9/99/Zapeir_sbpay_sync_old_records_option.png]]
 
</translate>

Zapier integration wit SBPay.me

2025-05-15T15:25:41Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Zapier integration with SBPay.me - SimplyBook.me
|description=Integrate SBPay.me with Zapier for automated payment processing. Simplify transactions and workflows. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}
</translate>

<translate>
[[File:Zapier-Logo-upd.png|50px|left]] Connect SBPay.me to 2,000+ other web services with the help of [https://zapier.com/apps Zapier] integration. Set up the connections in minutes with no coding to automate your day-to-day tasks and build workflows between important apps. Choose SBPay.me as a trigger app and set the transactions and invoices data to the systems that you frequently use.
 
</translate>

<translate>
==Available triggers:==
* Payment Created;
* Payment Confirmed (paid);
* Payment Refunded;
* Invoice Finalized (prepared for payment);
* Invoice Paid;
* Invoice Voided.
 
</translate>

<translate>
==Available data (payment triggers):==
* transaction id;
* transaction description;
* customer information (id, name, email, phone, address, custom fields);
* transaction lines (item name, description, price, quantity, discounts, taxes);
* currency;
* amount;
* payment system;
* payment method;
* date and time when the document was created;
* date and time when the document was changed last time;
* payment status;
* payment type;
* whether the payment was refunded by payment system;
* whether the payment was confirmed manually by SBPay.me user;
* taxes information;
* tags.
 
</translate>

<translate>
==Available data (invoice triggers):==
* invoice number;
* invoice description;
* customer information (id, name, email, phone, address, custom fields);
* invoice lines (item name, description, price, quantity, discounts, taxes);
* currency;
* amount;
* date and time when the document was created;
* date and time when the document was changed last time;
* invoice due date;
* invoice status;
* invoice type;
* whether there are any has credit notes related to that invoice;
* total amount without taxes;
* total discount amount;
* taxes information;
* tags.
 
</translate>

<translate>
==How to set:==
1. Enable Zapier custom feature in your SBPay.me interface. 
[[File:Zapier sbpay enable path.png|1200px|center|link=https://help.simplybook.me/images/7/75/Zapier_sbpay_enable_path.png]]
 
</translate>

<translate>
2. Navigate to '''Users''' page and click on '''New user'''. 
[[File:Sbpay new user path.png|1200px|center|link=https://help.simplybook.me/images/c/cc/Sbpay_new_user_path.png]]
 <be>
</translate>

<translate>
3. Create one more users with '''Admin''' access level. (use '''New user''' button to save the new user). 
[[File:Create new admin user sbpay.png|1200px|center|link=https://help.simplybook.me/images/0/0a/Create_new_admin_user_sbpay.png]]
 
</translate>

<translate>
4. Log in as this admin user to your SBPay.me account.
 
</translate>

<translate>
5. Log in to your [https://zapier.com/app/login Zapier account] or create a new one.
 
</translate>

<translate>
6. Create new Zap by clicking on '''Create''' and then '''Zaps''' button in Zapier interface. 
[[File:Create new zap path.png|1200px|center|link=https://help.simplybook.me/images/2/27/Create_new_zap_path.png]]
 
</translate>

<translate>
7. Look for SBPay.me in Trigger step or use [https://zapier.com/apps/sbpayme/integrations this link]. 
[[File:Sbpay app in zapier.png|1200px|center|link=https://help.simplybook.me/images/d/dd/Sbpay_app_in_zapier.png]]
 
</translate>

<translate>
8. Select the desirable trigger. 
[[File:Select trigger in Zapier.png|1200px|center|link=https://help.simplybook.me/images/8/86/Select_trigger_in_Zapier.png]]
 
</translate>

<translate>
9. Proceed to connecting SBPay.me account. 
[[File:Connect sbpay account path in zapier.png|1200px|center|link=https://help.simplybook.me/images/8/82/Connect_sbpay_account_path_in_zapier.png]]
 
</translate>

<translate>
10. In the popup window that appears please enter your SBPay.me '''company login'''. 
[[File:Company login to sbpay.png|1200px|center|link=https://help.simplybook.me/images/b/ba/Company_login_to_sbpay.png]]
 
</translate>

<translate>
11. In the SBPay.me interface navigate to '''Settings''' -> '''API keys''' and click on "View keys". 
[[File:Api keys path sbpay.png|1200px|center|link=https://help.simplybook.me/images/7/7f/Api_keys_path_sbpay.png]]
 
</translate>

<translate>
12. Confirm the action by entering your password and you will get access to the keys.
 
</translate>

<translate>
13. Copy '''Authentication Token''' and paste it to the corresponding field on Zapier side. 
[[File:Copy sbpay api keys.png|1200px|center|link=https://help.simplybook.me/images/0/06/Copy_sbpay_api_keys.png]]
[[File:Auth token to sbpay.png|1200px|center|link=https://help.simplybook.me/images/0/0e/Auth_token_to_sbpay.png]]
 
</translate>

<translate>
14. Click Continue to test this step.
 
</translate>

<translate>
15. Proceed to adding the Action step and search for the app you wish to connect SBPay.me to. 
For example:
[[File:Zapier action example.png|1200px|center|link=https://help.simplybook.me/images/4/4a/Zapier_action_example.png]]
[[File:Zapier variables use example.png|1200px|center|link=https://help.simplybook.me/images/2/24/Zapier_variables_use_example.png]]
 
</translate>

<translate>
16. Connect this application account and setup the template using the available data mentioned above.
 
</translate>

<translate>
17. You can test this step operation as well if necessary or skip it.
 
</translate>

<translate>
18. Finish the setup, add Zap name and turn it on.
 
</translate>

<translate>
==Synchronize old records==
You can synchronize old records for the selected event and date range to trigger the action in Zapier. 
Please follow the next steps: 
1. Navigate to '''Custom features''' -> '''Zapier''' in your SBPay.me interface.
 
</translate>

<translate>
2. In '''Sync records for event''' please select the events type that you would like to sync and the date range in the next fields. 
[[File:Zapier sbpay sync old events select type.png|1200px|center|link=https://help.simplybook.me/images/d/d9/Zapier_sbpay_sync_old_events_select_type.png]]
 
</translate>

<translate>
3. Click '''Synchronize records'''. 
[[File:Zapeir sbpay sync old records option.png|1200px|center|link=https://help.simplybook.me/images/9/99/Zapeir_sbpay_sync_old_records_option.png]]
 
</translate>

FreshBooks integration

2025-05-15T15:23:13Z

Tania: Marked this version for translation

<languages/>
<translate>


{{#seo:
|title=Frequently Asked Questions about Revenue Management Software & Billing | SBPay.me
|description=Integrate FreshBooks to manage invoicing and payments easily. Sync financial data for seamless tracking. Get started now!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, accounting integration, freshbooks, freshbooks integration, invoicing integration, freshbooks sbpay,
}}

</translate>

[[File:Freshbooks-logo.png|left]]
<translate>

The [https://sbpay.me/en/ SBPay.me] and [https://www.freshbooks.com FreshBooks] integration streamlines your invoicing process by automatically generating invoices or other income payments in FreshBooks for every completed order. It will help you optimize your financial workflows and ensure accurate recording of your orders.
</translate>

<translate>

Video tutorial [[File:Youtube-Logo.png|link=https://www.youtube.com/watch?v=Cr-OPRJFviw]]
</translate>

<translate>

'''Please note!'''
* The invoices created through FreshBooks integration will show only the total amount, omitting details about taxes and discounts. On the other hand, SBpay.me invoices will include comprehensive information, such as item prices, any applicable taxes or discounts, and the total amount.
* It's not possible to automatically create a Refund Receipt entry in FreshBooks when a refund is processed on the SBPay.me side.
</translate>

<translate>

;How to set and use


1. Navigate to the Custom Features page within your SBPay.me interface and click on the Enable button next to Freshbooks.
[[File:Freshbooks enable path.png|1200px|center|link=https://help.simplybook.me/images/d/d4/Freshbooks_enable_path.png]]
</translate>

<translate>

2. Once enabled, click on the Connect button to proceed with setup.
[[File:Freshbooks connect path.png|1200px|center|link=https://help.simplybook.me/images/7/70/Freshbooks_connect_path.png]]
</translate>

<translate>

3. You'll be prompted to log in to your FreshBooks account to establish the connection. If you're already logged in to FreshBooks in the same browser, the connection will be automatic once you click on the Allow button. 
If needed, you will find SBPay.me in the FreshBooks Apps -> Connected Apps section.
</translate>

<translate>

4. Once the systems are linked, you'll gain access to the integration settings within the SBPay.me interface.
</translate>

<translate>

5. Select the operation type. There are two options: Invoice and Payments: Other Income. 
If you choose Invoice, each paid order will generate both an invoice and the associated payment in FreshBooks. Alternatively, selecting "Payments: Other Income" will only create an "Other Income" entry on the FreshBooks side once the order is paid.
[[File:Freshbooks operation type.png|1200px|center|link=https://help.simplybook.me/images/d/dc/Freshbooks_operation_type.png]]
</translate>

<translate>

6. By default, the system is set to skip zero amount transactions so that they are not being sent to FreshBooks. For example, the transactions where a discount was applied and the resulting total is 0. You can maintain this setting if you don't require these records in FreshBooks. However, if it's crucial for your bookkeeping, you can disable this feature to include such transactions.
[[File:Freshbooks skip zero amount.png|1200px|center|link=https://help.simplybook.me/images/b/be/Freshbooks_skip_zero_amount.png]]
</translate>

<translate>

7. You can also include the Invoice Notes and the Invoice Terms and Conditions in the invoice document.
[[File:Freshbooks invoice notes and terms.png|1200px|center|link=https://help.simplybook.me/images/a/ac/Freshbooks_invoice_notes_and_terms.png]]
</translate>

<translate>

8. In the Email section you can disable or leave the Send Invoice option On. If enabled, you can specify the Invoice Email Subject as well as the Invoice Email Body. It is possible to add the supported variables to the email body which will be replaced with the actual information when being sent to the clients. If the email subject or body is not specified, the default FreshBooks template will be used.
[[File:Freshbooks invoice template.png|1200px|center|link=https://help.simplybook.me/images/3/30/Freshbooks_invoice_template.png]]
</translate>

<translate>

9. In the Client section you can adjust client information such as Last Name and Client Internal Note upon the creation of a new client entry in FreshBooks.
</translate>

<translate>

:- You have the option to activate the Client Last Name from [[Client_Fields_Custom_Feature|SimplyBook.me Client Fields]]. This feature is useful if you have the corresponding custom feature enabled in the SimplyBook.me's account and set it for obtaining the last name of your clients. 
:Ensure that you input the precise field name matching the one used in SimplyBook.me's Client Fields Custom Feature for the last name.
</translate>

<translate>

:- Client Internal Note option allows the addition of a personalized prefix to a client's internal note in FreshBooks. It's important to note that modifying the prefix won't affect existing FreshBooks clients. Only the new clients will be created in FreshBooks with the updated note. A client note is essential for the integration to work correctly. By default, the internal note includes '''SBPay.me, {CURRENCY}.''' 
:You have the flexibility to change the '''SBPay.me''' prefix or exclude it. If omitted, only the currency will be appended to the client's note.
[[File:Freshbooks client data settings.png|1200px|center|link=https://help.simplybook.me/images/f/f9/Freshbooks_client_data_settings.png]]
</translate>

FreshBooks integration

2025-05-15T15:22:58Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Frequently Asked Questions about Revenue Management Software & Billing | SBPay.me
|description=Integrate FreshBooks to manage invoicing and payments easily. Sync financial data for seamless tracking. Get started now!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, accounting integration, freshbooks, freshbooks integration, invoicing integration, freshbooks sbpay,
}}

</translate>

[[File:Freshbooks-logo.png|left]]
<translate>
The [https://sbpay.me/en/ SBPay.me] and [https://www.freshbooks.com FreshBooks] integration streamlines your invoicing process by automatically generating invoices or other income payments in FreshBooks for every completed order. It will help you optimize your financial workflows and ensure accurate recording of your orders.
</translate>

<translate>
Video tutorial [[File:Youtube-Logo.png|link=https://www.youtube.com/watch?v=Cr-OPRJFviw]]
</translate>

<translate>
'''Please note!'''
* The invoices created through FreshBooks integration will show only the total amount, omitting details about taxes and discounts. On the other hand, SBpay.me invoices will include comprehensive information, such as item prices, any applicable taxes or discounts, and the total amount.
* It's not possible to automatically create a Refund Receipt entry in FreshBooks when a refund is processed on the SBPay.me side.
</translate>

<translate>
;How to set and use

1. Navigate to the Custom Features page within your SBPay.me interface and click on the Enable button next to Freshbooks.
[[File:Freshbooks enable path.png|1200px|center|link=https://help.simplybook.me/images/d/d4/Freshbooks_enable_path.png]]
</translate>

<translate>
2. Once enabled, click on the Connect button to proceed with setup.
[[File:Freshbooks connect path.png|1200px|center|link=https://help.simplybook.me/images/7/70/Freshbooks_connect_path.png]]
</translate>

<translate>
3. You'll be prompted to log in to your FreshBooks account to establish the connection. If you're already logged in to FreshBooks in the same browser, the connection will be automatic once you click on the Allow button. 
If needed, you will find SBPay.me in the FreshBooks Apps -> Connected Apps section.
</translate>

<translate>
4. Once the systems are linked, you'll gain access to the integration settings within the SBPay.me interface.
</translate>

<translate>
5. Select the operation type. There are two options: Invoice and Payments: Other Income. 
If you choose Invoice, each paid order will generate both an invoice and the associated payment in FreshBooks. Alternatively, selecting "Payments: Other Income" will only create an "Other Income" entry on the FreshBooks side once the order is paid.
[[File:Freshbooks operation type.png|1200px|center|link=https://help.simplybook.me/images/d/dc/Freshbooks_operation_type.png]]
</translate>

<translate>
6. By default, the system is set to skip zero amount transactions so that they are not being sent to FreshBooks. For example, the transactions where a discount was applied and the resulting total is 0. You can maintain this setting if you don't require these records in FreshBooks. However, if it's crucial for your bookkeeping, you can disable this feature to include such transactions.
[[File:Freshbooks skip zero amount.png|1200px|center|link=https://help.simplybook.me/images/b/be/Freshbooks_skip_zero_amount.png]]
</translate>

<translate>
7. You can also include the Invoice Notes and the Invoice Terms and Conditions in the invoice document.
[[File:Freshbooks invoice notes and terms.png|1200px|center|link=https://help.simplybook.me/images/a/ac/Freshbooks_invoice_notes_and_terms.png]]
</translate>

<translate>
8. In the Email section you can disable or leave the Send Invoice option On. If enabled, you can specify the Invoice Email Subject as well as the Invoice Email Body. It is possible to add the supported variables to the email body which will be replaced with the actual information when being sent to the clients. If the email subject or body is not specified, the default FreshBooks template will be used.
[[File:Freshbooks invoice template.png|1200px|center|link=https://help.simplybook.me/images/3/30/Freshbooks_invoice_template.png]]
</translate>

<translate>
9. In the Client section you can adjust client information such as Last Name and Client Internal Note upon the creation of a new client entry in FreshBooks.
</translate>

<translate>
:- You have the option to activate the Client Last Name from [[Client_Fields_Custom_Feature|SimplyBook.me Client Fields]]. This feature is useful if you have the corresponding custom feature enabled in the SimplyBook.me's account and set it for obtaining the last name of your clients. 
:Ensure that you input the precise field name matching the one used in SimplyBook.me's Client Fields Custom Feature for the last name.
</translate>

<translate>
:- Client Internal Note option allows the addition of a personalized prefix to a client's internal note in FreshBooks. It's important to note that modifying the prefix won't affect existing FreshBooks clients. Only the new clients will be created in FreshBooks with the updated note. A client note is essential for the integration to work correctly. By default, the internal note includes '''SBPay.me, {CURRENCY}.''' 
:You have the flexibility to change the '''SBPay.me''' prefix or exclude it. If omitted, only the currency will be appended to the client's note.
[[File:Freshbooks client data settings.png|1200px|center|link=https://help.simplybook.me/images/f/f9/Freshbooks_client_data_settings.png]]
</translate>

Xero integration

2025-05-15T15:21:02Z

Tania: Marked this version for translation

<languages/>
<translate>

{{#seo:
|title=Xero integration SimplyBook.me - Sbpay.me
|description=Combine SimplyBook.me with Xero for streamlined invoicing and financial management. Enable this integration today!
|titlemode=append
|keywords=faq, frequently asked questions, plugins, custom features, additional functionality, online payments, accounting integrations, xero integration, xero sbpay
}}
</translate>

<translate>

[[File:Icon xero.png|left]]
Integrating [https://sbpay.me SBPay.me] with [https://www.xero.com Xero] allows you to facilitate the flow of financial data between your booking system and accounting software. The integration allows you to export invoices from SBPay.me and import them directly to your Xero account. 
</translate>

<translate>

Video tutorial [[File:Youtube-Logo.png|link=https://www.youtube.com/watch?v=ZdWpuWef4UY]]
</translate>

<translate>

'''Please note!'''
* The process is not fully automated. You will need to export the invoices from the SBPay.me Invoices page and import them on the Xero side. 
(we have prepared the specific file format to make it easy)
* If standard Xero import functionality is used, invoices will be imported as Draft. For invoices to be Approved or Paid, [https://conversiontoolbox.xero.com/ Xero Conversion Toolbox] should be used.
* Tax amount is not exported since Xero imports final amounts as tax exclusive. Taxes are calculated and added to the final amounts within the Xero platform itself.
* Xero Custom Feature will work only if the '''Invoices''' custom feature is enabled in the SBPay.me
</translate>

<translate>

;How to set and use?


1. Navigate to the Custom Features page within your SBPay.me interface and click on the Enable button next to Xero.
[[File:Xero enable path.png|1200px|center|link=https://help.simplybook.me/images/1/16/Xero_enable_path.png]]
</translate>

<translate>

2. Choose if the invoice should be imported with multiple lines. This option determines how the information from your invoices is structured when transferred from SBPay.me to Xero. 
If enabled, each row in the export file will correspond to a specific invoice line item. This means that detailed information about each item within an order is organized in separate rows of the resulting .csv file. 
If disabled, all invoice line items within an order are combined into a single line. This results in a concise summary of the invoice with the total amount displayed in one row of the .csv file. 
[[File:Xero invoice with multiple lines.png|1200px|center|link=https://help.simplybook.me/images/2/2b/Xero_invoice_with_multiple_lines.png]]
</translate>

<translate>

3. Insert Xero Invoice Branding Theme Name. In Xero, a branding theme name is the name of the invoice template that determines the layout and design of your invoices.
[[File:Xero branding theme name.png|1200px|center|link=https://help.simplybook.me/images/6/6d/Xero_branding_theme_name.png]]
</translate>

<translate>

4. Add Payment Data. If enabled, additional payment data, including the amount paid, Xero account code, invoice paid date, and payment exchange rate will be exported to the .csv file. 
</translate>

<translate>

By including this payment data during the export process, you ensure that Xero has all the necessary information to accurately record payments against the corresponding invoices.
[[File:Xero add payment data.png|1200px|center|link=https://help.simplybook.me/images/f/fc/Xero_add_payment_data.png]]
</translate>

<translate>

5. Select Xero Account Base Currency. In Xero, the account base currency is the primary currency in which your financial records are kept. It serves as the standard currency for your accounting and reporting purposes. Specify it if you accept payments in multiple currencies or if the SBPay.me invoices currency is different from the Xero account base currency.
[[File:Xero base currency.png|1200px|center|link=https://help.simplybook.me/images/6/6f/Xero_base_currency.png]]
</translate>

<translate>

6. For paid invoices, specify the relevant Deposit Account Code as it appears in the chart of accounts in Xero. This ensures that transactions are automatically categorized into the appropriate account within Xero. Alternatively, you can leave it blank to manually specify the account code during the invoices import.
[[File:Xero deposit account code.png|1200px|center|link=https://help.simplybook.me/images/e/ea/Xero_deposit_account_code.png]]
</translate>

<translate>

7. Select Tax Type. Enter the exact tax rate name from your Xero settings to ensure that each transaction is correctly linked to the corresponding tax rate.
[[File:Xero tax type.png|1200px|center|link=https://help.simplybook.me/images/b/b5/Xero_tax_type.png]]
</translate>

<translate>

8. After enabling and configuring the Xero Custom Feature, you can now go to Invoices in your SBPay account and click on the Xero Export button to generate the .csv file which can be imported on the Xero side.
[[File:Xero export file path.png|1200px|center|link=https://help.simplybook.me/images/6/61/Xero_export_file_path.png]]
 
</translate>

Xero integration

2025-05-15T15:20:43Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Xero integration SimplyBook.me - Sbpay.me
|description=Combine SimplyBook.me with Xero for streamlined invoicing and financial management. Enable this integration today!
|titlemode=append
|keywords=faq, frequently asked questions, plugins, custom features, additional functionality, online payments, accounting integrations, xero integration, xero sbpay
}}
</translate>

<translate>
[[File:Icon xero.png|left]]
Integrating [https://sbpay.me SBPay.me] with [https://www.xero.com Xero] allows you to facilitate the flow of financial data between your booking system and accounting software. The integration allows you to export invoices from SBPay.me and import them directly to your Xero account. 
</translate>

<translate>
Video tutorial [[File:Youtube-Logo.png|link=https://www.youtube.com/watch?v=ZdWpuWef4UY]]
</translate>

<translate>
'''Please note!'''
* The process is not fully automated. You will need to export the invoices from the SBPay.me Invoices page and import them on the Xero side. 
(we have prepared the specific file format to make it easy)
* If standard Xero import functionality is used, invoices will be imported as Draft. For invoices to be Approved or Paid, [https://conversiontoolbox.xero.com/ Xero Conversion Toolbox] should be used.
* Tax amount is not exported since Xero imports final amounts as tax exclusive. Taxes are calculated and added to the final amounts within the Xero platform itself.
* Xero Custom Feature will work only if the '''Invoices''' custom feature is enabled in the SBPay.me
</translate>

<translate>
;How to set and use?

1. Navigate to the Custom Features page within your SBPay.me interface and click on the Enable button next to Xero.
[[File:Xero enable path.png|1200px|center|link=https://help.simplybook.me/images/1/16/Xero_enable_path.png]]
</translate>

<translate>
2. Choose if the invoice should be imported with multiple lines. This option determines how the information from your invoices is structured when transferred from SBPay.me to Xero. 
If enabled, each row in the export file will correspond to a specific invoice line item. This means that detailed information about each item within an order is organized in separate rows of the resulting .csv file. 
If disabled, all invoice line items within an order are combined into a single line. This results in a concise summary of the invoice with the total amount displayed in one row of the .csv file. 
[[File:Xero invoice with multiple lines.png|1200px|center|link=https://help.simplybook.me/images/2/2b/Xero_invoice_with_multiple_lines.png]]
</translate>

<translate>
3. Insert Xero Invoice Branding Theme Name. In Xero, a branding theme name is the name of the invoice template that determines the layout and design of your invoices.
[[File:Xero branding theme name.png|1200px|center|link=https://help.simplybook.me/images/6/6d/Xero_branding_theme_name.png]]
</translate>

<translate>
4. Add Payment Data. If enabled, additional payment data, including the amount paid, Xero account code, invoice paid date, and payment exchange rate will be exported to the .csv file. 
</translate>

<translate>
By including this payment data during the export process, you ensure that Xero has all the necessary information to accurately record payments against the corresponding invoices.
[[File:Xero add payment data.png|1200px|center|link=https://help.simplybook.me/images/f/fc/Xero_add_payment_data.png]]
</translate>

<translate>
5. Select Xero Account Base Currency. In Xero, the account base currency is the primary currency in which your financial records are kept. It serves as the standard currency for your accounting and reporting purposes. Specify it if you accept payments in multiple currencies or if the SBPay.me invoices currency is different from the Xero account base currency.
[[File:Xero base currency.png|1200px|center|link=https://help.simplybook.me/images/6/6f/Xero_base_currency.png]]
</translate>

<translate>
6. For paid invoices, specify the relevant Deposit Account Code as it appears in the chart of accounts in Xero. This ensures that transactions are automatically categorized into the appropriate account within Xero. Alternatively, you can leave it blank to manually specify the account code during the invoices import.
[[File:Xero deposit account code.png|1200px|center|link=https://help.simplybook.me/images/e/ea/Xero_deposit_account_code.png]]
</translate>

<translate>
7. Select Tax Type. Enter the exact tax rate name from your Xero settings to ensure that each transaction is correctly linked to the corresponding tax rate.
[[File:Xero tax type.png|1200px|center|link=https://help.simplybook.me/images/b/b5/Xero_tax_type.png]]
</translate>

<translate>
8. After enabling and configuring the Xero Custom Feature, you can now go to Invoices in your SBPay account and click on the Xero Export button to generate the .csv file which can be imported on the Xero side.
[[File:Xero export file path.png|1200px|center|link=https://help.simplybook.me/images/6/61/Xero_export_file_path.png]]
 
</translate>

Xero integration

2025-05-15T15:20:25Z

Tania:

QuickBooks integration

2025-05-15T15:19:01Z

Tania: Marked this version for translation

<languages/>
<translate>

{{#seo:
|title=QuickBooks integration - SBPay.me
|description=Integrate QuickBooks with SimplyBook.me for seamless accounting and invoicing. Follow the guide to enable this feature!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, accounting integration, quickbooks, quickbooks integration, invoicing integration, quickbooks sbpay,
}}
</translate>

<translate>

[[File:Icon quickbooks.png|left]] This easy-to-set [https://sbpay.me SBPay.me] integration with [https://quickbooks.intuit.com/eu/pricing/ Quickbooks] allows you to automatically create invoices or sales receipts in QuickBooks for each paid order and send them to customers.
 
Video tutorial [[File:Youtube-Logo.png|link=https://www.youtube.com/watch?v=vx1WibTZ9_4]]
</translate>

<translate>

'''Please note!'''
*The invoices which get generated on the QuickBooks side as the result of the integration won't include information about taxes and discounts, they will contain only the total amount. While the SimplyBook invoices contain information about the item price taxes/discounts (if any), and the total amount.
*Multi-currency must be enabled in QuickBooks for transactional documents involving different currencies.
 
</translate>

<translate>
==How to set and use== 


1. Navigate to Custom Features page within your SBPay.me interface and click on the Enable button next to QuickBooks.
[[File:Quickbooks enable path.png|1200px|center|link=https://help.simplybook.me/images/1/13/Quickbooks_enable_path.png]]
</translate>

<translate>

2. Once enabled, click on the Connect button to proceed with setup.
[[File:Quickbooks connect path.png|1200px|center|link=https://help.simplybook.me/images/6/63/Quickbooks_connect_path.png]]
</translate>

<translate>

3. You will be prompted to log in to your Quickbooks account to get connected. Or, if you are already logged in there in your browser, the connection will be set automatically after confirmation. You will also see SBPay.me in the Apps -> My Apps section of QuickBooks.
[[File:Confirm quickbooks connection.png|1200px|center|link=https://help.simplybook.me/images/f/fc/Confirm_quickbooks_connection.png]]
</translate>

<translate>

4. After the systems are connected you will get access to the integration settings in the SBPay.me interface.
</translate>

<translate>

5. Choose the transactional document type: There are two options: Invoice and Sales Receipt.
Invoice triggers the creation of both an invoice and its corresponding payment within QuickBooks for each fulfilled order on the SimplyBook side. Thus, you will see two records (Payment and Invoice) on the QuickBooks account associated with the same transaction.
Sales Receipt results in the generation of a sales receipt (Payment) solely upon successful payment for the order.
[[File:Quickbooks select document type.png|1200px|center|link=https://help.simplybook.me/images/1/1b/Quickbooks_select_document_type.png]]
</translate>

<translate>

6. You can add a Deposit Account Name and select the deposit Account Type.
It should be either Other Current Assets or Bank (Cash on Hand) type.
If deposit account is not specified QuickBooks will use a default account called Undeposited Funds.
[[File:Quickbooks deposit account.png|1200px|center|link=https://help.simplybook.me/images/7/75/Quickbooks_deposit_account.png]]
</translate>

<translate>

7. Skipping zero amount transactions is enabled by default to exclude zero amount orders from being transferred to QuickBooks. For example, the transactions where the discount was applied and the resulting total is 0.
You can keep it as it is if you do not need to see such records in Quickbooks or disable if it is important to have them for your bookkeeping.
[[File:Quickbooks skip zero transactions.png|1200px|center|link=https://help.simplybook.me/images/2/27/Quickbooks_skip_zero_transactions.png]]
</translate>

<translate>

8. You can activate the automatic creation of a Refund Receipt entry in QuickBooks when a refund is made on the SBPay.me side. Please ensure to include the Deposit Account Name if you decide to enable this option as it is mandatory for refunds synchronisation.
[[File:Quickbooks rrefund receipts.png|1200px|center|link=https://help.simplybook.me/images/5/57/Quickbooks_rrefund_receipts.png]]
</translate>

<translate>

9. There is also an option to send a transactional document. If enabled, the client will also receive an invoice from QuickBooks in addition to other active notifications. 
You can also add a note to be reflected in the Quickbooks invoices.
[[File:Quickbooks send transactional email.png|1200px|center|link=https://help.simplybook.me/images/c/c3/Quickbooks_send_transactional_email.png]]
 
</translate>

<translate>

==Taxes==
To activate this option and pass taxes information to Quickbooks please check the "Add tax info to transaction document" in the Custom features -> Sales tax in your SBPay.me interface. And select the corresponding tax location.
[[File:Qb tax enable path.png|1200px|center|link=https://help.simplybook.me/images/1/10/Qb_tax_enable_path.png]]
 
</translate>

<translate>

:''For Global tax location'' 
Also navigate to Settings -> Taxes in SBPay.me interface, select the necessary tax and set the exact tax name as it is defined in QuickBooks.
[[File:Sbpay edit tax path.png|1200px|center|link=https://help.simplybook.me/images/4/43/Sbpay_edit_tax_path.png]]
[[File:Qb tax global path.png|1200px|center|link=https://help.simplybook.me/images/c/cf/Qb_tax_global_path.png]]
 
'''Please note!'''
* Tax is defined for each line separately;
* All lines with taxes should have the same tax type (inclusive or exclusive) throughout the order;
* The orders that contain lines with multiple taxes will not be passed to Quickbooks;
* If the order contains lines with no tax applied it will not be passed to Quickbooks;
* The orders that contain lines with mixed inclusive and exclusive taxes are not passed to Quickbooks;
* If the Quickbooks tax name is not set for some tax in that order it will not be passed to Quickbooks.
 
</translate>

<translate>

:''For USA tax location'' 
For now it is only possible to use Automated Sales Tax (AST) as defined in QuickBooks. If you set the tax name set in SBPay.me Settings -> Taxes, it will be ignored. 
 
'''Please note!'''
* Tax is defined for the whole order. On the SBPay.me side, this means that ALL lines should have the same single tax with the same rate and type set for each order line;
* Tax is always exclusive.


 
</translate>

QuickBooks integration

2025-05-15T15:18:10Z

Tania:

<languages/>
<translate>
{{#seo:
|title=QuickBooks integration - SBPay.me
|description=Integrate QuickBooks with SimplyBook.me for seamless accounting and invoicing. Follow the guide to enable this feature!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, accounting integration, quickbooks, quickbooks integration, invoicing integration, quickbooks sbpay,
}}
</translate>

<translate>
[[File:Icon quickbooks.png|left]] This easy-to-set [https://sbpay.me SBPay.me] integration with [https://quickbooks.intuit.com/eu/pricing/ Quickbooks] allows you to automatically create invoices or sales receipts in QuickBooks for each paid order and send them to customers.
 
Video tutorial [[File:Youtube-Logo.png|link=https://www.youtube.com/watch?v=vx1WibTZ9_4]]
</translate>

<translate>
'''Please note!'''
*The invoices which get generated on the QuickBooks side as the result of the integration won't include information about taxes and discounts, they will contain only the total amount. While the SimplyBook invoices contain information about the item price taxes/discounts (if any), and the total amount.
*Multi-currency must be enabled in QuickBooks for transactional documents involving different currencies.
 
</translate>

<translate>
==How to set and use==

1. Navigate to Custom Features page within your SBPay.me interface and click on the Enable button next to QuickBooks.
[[File:Quickbooks enable path.png|1200px|center|link=https://help.simplybook.me/images/1/13/Quickbooks_enable_path.png]]
</translate>

<translate>
2. Once enabled, click on the Connect button to proceed with setup.
[[File:Quickbooks connect path.png|1200px|center|link=https://help.simplybook.me/images/6/63/Quickbooks_connect_path.png]]
</translate>

<translate>
3. You will be prompted to log in to your Quickbooks account to get connected. Or, if you are already logged in there in your browser, the connection will be set automatically after confirmation. You will also see SBPay.me in the Apps -> My Apps section of QuickBooks.
[[File:Confirm quickbooks connection.png|1200px|center|link=https://help.simplybook.me/images/f/fc/Confirm_quickbooks_connection.png]]
</translate>

<translate>
4. After the systems are connected you will get access to the integration settings in the SBPay.me interface.
</translate>

<translate>
5. Choose the transactional document type: There are two options: Invoice and Sales Receipt.
Invoice triggers the creation of both an invoice and its corresponding payment within QuickBooks for each fulfilled order on the SimplyBook side. Thus, you will see two records (Payment and Invoice) on the QuickBooks account associated with the same transaction.
Sales Receipt results in the generation of a sales receipt (Payment) solely upon successful payment for the order.
[[File:Quickbooks select document type.png|1200px|center|link=https://help.simplybook.me/images/1/1b/Quickbooks_select_document_type.png]]
</translate>

<translate>
6. You can add a Deposit Account Name and select the deposit Account Type.
It should be either Other Current Assets or Bank (Cash on Hand) type.
If deposit account is not specified QuickBooks will use a default account called Undeposited Funds.
[[File:Quickbooks deposit account.png|1200px|center|link=https://help.simplybook.me/images/7/75/Quickbooks_deposit_account.png]]
</translate>

<translate>
7. Skipping zero amount transactions is enabled by default to exclude zero amount orders from being transferred to QuickBooks. For example, the transactions where the discount was applied and the resulting total is 0.
You can keep it as it is if you do not need to see such records in Quickbooks or disable if it is important to have them for your bookkeeping.
[[File:Quickbooks skip zero transactions.png|1200px|center|link=https://help.simplybook.me/images/2/27/Quickbooks_skip_zero_transactions.png]]
</translate>

<translate>
8. You can activate the automatic creation of a Refund Receipt entry in QuickBooks when a refund is made on the SBPay.me side. Please ensure to include the Deposit Account Name if you decide to enable this option as it is mandatory for refunds synchronisation.
[[File:Quickbooks rrefund receipts.png|1200px|center|link=https://help.simplybook.me/images/5/57/Quickbooks_rrefund_receipts.png]]
</translate>

<translate>
9. There is also an option to send a transactional document. If enabled, the client will also receive an invoice from QuickBooks in addition to other active notifications. 
You can also add a note to be reflected in the Quickbooks invoices.
[[File:Quickbooks send transactional email.png|1200px|center|link=https://help.simplybook.me/images/c/c3/Quickbooks_send_transactional_email.png]]
 
</translate>

<translate>
==Taxes==
To activate this option and pass taxes information to Quickbooks please check the "Add tax info to transaction document" in the Custom features -> Sales tax in your SBPay.me interface. And select the corresponding tax location.
[[File:Qb tax enable path.png|1200px|center|link=https://help.simplybook.me/images/1/10/Qb_tax_enable_path.png]]
 
</translate>

<translate>
:''For Global tax location'' 
Also navigate to Settings -> Taxes in SBPay.me interface, select the necessary tax and set the exact tax name as it is defined in QuickBooks.
[[File:Sbpay edit tax path.png|1200px|center|link=https://help.simplybook.me/images/4/43/Sbpay_edit_tax_path.png]]
[[File:Qb tax global path.png|1200px|center|link=https://help.simplybook.me/images/c/cf/Qb_tax_global_path.png]]
 
'''Please note!'''
* Tax is defined for each line separately;
* All lines with taxes should have the same tax type (inclusive or exclusive) throughout the order;
* The orders that contain lines with multiple taxes will not be passed to Quickbooks;
* If the order contains lines with no tax applied it will not be passed to Quickbooks;
* The orders that contain lines with mixed inclusive and exclusive taxes are not passed to Quickbooks;
* If the Quickbooks tax name is not set for some tax in that order it will not be passed to Quickbooks.
 
</translate>

<translate>
:''For USA tax location'' 
For now it is only possible to use Automated Sales Tax (AST) as defined in QuickBooks. If you set the tax name set in SBPay.me Settings -> Taxes, it will be ignored. 
 
'''Please note!'''
* Tax is defined for the whole order. On the SBPay.me side, this means that ALL lines should have the same single tax with the same rate and type set for each order line;
* Tax is always exclusive.

 
</translate>

QuickBooks integration

2025-05-15T15:17:36Z

Tania:

<languages/>
<translate>
{{#seo:
|title=QuickBooks integration - SBPay.me
|description=Integrate QuickBooks with SimplyBook.me for seamless accounting and invoicing. Follow the guide to enable this feature!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, accounting integration, quickbooks, quickbooks integration, invoicing integration, quickbooks sbpay,
}}
</translate>

<translate>
[[File:Icon quickbooks.png|left]] This easy-to-set [https://sbpay.me SBPay.me] integration with [https://quickbooks.intuit.com/eu/pricing/ Quickbooks] allows you to automatically create invoices or sales receipts in QuickBooks for each paid order and send them to customers.
 
Video tutorial [[File:Youtube-Logo.png|link=https://www.youtube.com/watch?v=vx1WibTZ9_4]]
</translate>

<translate>
'''Please note!'''
*The invoices which get generated on the QuickBooks side as the result of the integration won't include information about taxes and discounts, they will contain only the total amount. While the SimplyBook invoices contain information about the item price taxes/discounts (if any), and the total amount.
*Multi-currency must be enabled in QuickBooks for transactional documents involving different currencies.
 <be>
</translate>

<translate>
==How to set and use==

1. Navigate to Custom Features page within your SBPay.me interface and click on the Enable button next to QuickBooks.
[[File:Quickbooks enable path.png|1200px|center|link=https://help.simplybook.me/images/1/13/Quickbooks_enable_path.png]]
</translate>

<translate>
2. Once enabled, click on the Connect button to proceed with setup.
[[File:Quickbooks connect path.png|1200px|center|link=https://help.simplybook.me/images/6/63/Quickbooks_connect_path.png]]
</translate>

<translate>
3. You will be prompted to log in to your Quickbooks account to get connected. Or, if you are already logged in there in your browser, the connection will be set automatically after confirmation. You will also see SBPay.me in the Apps -> My Apps section of QuickBooks.
[[File:Confirm quickbooks connection.png|1200px|center|link=https://help.simplybook.me/images/f/fc/Confirm_quickbooks_connection.png]]
</translate>

<translate>
4. After the systems are connected you will get access to the integration settings in the SBPay.me interface.
</translate>

<translate>
5. Choose the transactional document type: There are two options: Invoice and Sales Receipt.
Invoice triggers the creation of both an invoice and its corresponding payment within QuickBooks for each fulfilled order on the SimplyBook side. Thus, you will see two records (Payment and Invoice) on the QuickBooks account associated with the same transaction.
Sales Receipt results in the generation of a sales receipt (Payment) solely upon successful payment for the order.
[[File:Quickbooks select document type.png|1200px|center|link=https://help.simplybook.me/images/1/1b/Quickbooks_select_document_type.png]]
</translate>

<translate>
6. You can add a Deposit Account Name and select the deposit Account Type.
It should be either Other Current Assets or Bank (Cash on Hand) type.
If deposit account is not specified QuickBooks will use a default account called Undeposited Funds.
[[File:Quickbooks deposit account.png|1200px|center|link=https://help.simplybook.me/images/7/75/Quickbooks_deposit_account.png]]
</translate>

<translate>
7. Skipping zero amount transactions is enabled by default to exclude zero amount orders from being transferred to QuickBooks. For example, the transactions where the discount was applied and the resulting total is 0.
You can keep it as it is if you do not need to see such records in Quickbooks or disable if it is important to have them for your bookkeeping.
[[File:Quickbooks skip zero transactions.png|1200px|center|link=https://help.simplybook.me/images/2/27/Quickbooks_skip_zero_transactions.png]]
</translate>

<translate>
8. You can activate the automatic creation of a Refund Receipt entry in QuickBooks when a refund is made on the SBPay.me side. Please ensure to include the Deposit Account Name if you decide to enable this option as it is mandatory for refunds synchronisation.
[[File:Quickbooks rrefund receipts.png|1200px|center|link=https://help.simplybook.me/images/5/57/Quickbooks_rrefund_receipts.png]]
</translate>

<translate>
9. There is also an option to send a transactional document. If enabled, the client will also receive an invoice from QuickBooks in addition to other active notifications. 
You can also add a note to be reflected in the Quickbooks invoices.
[[File:Quickbooks send transactional email.png|1200px|center|link=https://help.simplybook.me/images/c/c3/Quickbooks_send_transactional_email.png]]
 <be>
</translate>

<translate>
==Taxes==
To activate this option and pass taxes information to Quickbooks please check the "Add tax info to transaction document" in the Custom features -> Sales tax in your SBPay.me interface. And select the corresponding tax location.
[[File:Qb tax enable path.png|1200px|center|link=https://help.simplybook.me/images/1/10/Qb_tax_enable_path.png]]
 <be>
</translate>

<translate>
:''For Global tax location'' 
Also navigate to Settings -> Taxes in SBPay.me interface, select the necessary tax and set the exact tax name as it is defined in QuickBooks.
[[File:Sbpay edit tax path.png|1200px|center|link=https://help.simplybook.me/images/4/43/Sbpay_edit_tax_path.png]]
[[File:Qb tax global path.png|1200px|center|link=https://help.simplybook.me/images/c/cf/Qb_tax_global_path.png]]
 
'''Please note!'''
* Tax is defined for each line separately;
* All lines with taxes should have the same tax type (inclusive or exclusive) throughout the order;
* The orders that contain lines with multiple taxes will not be passed to Quickbooks;
* If the order contains lines with no tax applied it will not be passed to Quickbooks;
* The orders that contain lines with mixed inclusive and exclusive taxes are not passed to Quickbooks;
* If the Quickbooks tax name is not set for some tax in that order it will not be passed to Quickbooks.
 
</translate>

<translate>
:''For USA tax location'' 
For now it is only possible to use Automated Sales Tax (AST) as defined in QuickBooks. If you set the tax name set in SBPay.me Settings -> Taxes, it will be ignored. 
 
'''Please note!'''
* Tax is defined for the whole order. On the SBPay.me side, this means that ALL lines should have the same single tax with the same rate and type set for each order line;
* Tax is always exclusive.

 
</translate>

SBPay.me User Roles

2025-05-15T15:10:40Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Frequently Asked Questions about Revenue Management Software & Billing | SBPay.me
|description=Assign specific user roles for SBPay.me to manage transactions securely. Customize permissions easily. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, access levels, user roles, system access, create user, create access, add accountant access
}}
</translate>

<translate>

Adding users to your [https://sbpay.me SBPay.me] account is a simple process that allows you to grant appropriate access rights to different team members based on their responsibilities and needs within the platform.


'''Please note!''' The functionalities and range of user roles might be modified and extended in future development versions of SBPay.me.
</translate>

<translate>

To add a new user, do the following:


:1. Go to SBPay.me -> Users section > Click on Users.
:2. Click on the New User button.
:3. Create User Profile: input Login, Name, Email address, Phone number, and select the user Role.
:4. Once a profile is created the user will receive the invitation email and will be able to set his/get first password as well as 2-factor authentication.


'''Please note!''' Each user's email address must be unique. It is not possible to create more than one user with the same email address.
</translate>

<translate>


;'''User Roles'''


System User: The profile of the main admin of the account. Possesses all access levels Admin has, and additionally includes the rights to manage and block other system users with the Admin rights.
</translate>

<translate>

Admin: Administrators have the highest access level, enabling them to configure settings, manage user roles, initiate transactions, and oversee the entire financial ecosystem within SBPay. They have access to dashboard statistics, payments, invoices, recurring profiles, customer payment methods, and can create payment requests. Admins also manage company profiles, payment processors, taxes, custom features, and reports. They have the capability to create other system users and view the action logs of all the other users. Additionally, Admins have access to API Keys Authentication token, and Secret Key.
</translate>

<translate>

'''Please note!''' Admin and can not change any details associated with the System User role as well as block the System User profile.
</translate>

<translate>

Accountant: Accountants have access to sales sections, payments, invoices, recurring profiles, customer payment methods, and the ability to create payment requests. They can view their own user profile, manage taxes (including adding new ones), access tax reports, customer reports, and subscription metrics.
</translate>

<translate>

Junior Accountant: Junior Accountants have moderate access to the dashboard and sales section Can create payment requests, view and manage their own user profile. Also, have view only access to the taxes section within SBPay.
</translate>

<translate>

Viewer: Viewers have limited access, allowing them to view sales sections (payments, invoices, recurring profiles, customer payment methods), tax settings, tax reports, customer reports, and subscription metrics. They can only view information from these sections without the ability to make changes.
</translate>

<translate>

Viewer without Personal Info Access: Similar to the Viewer role, this user can access the same settings but is restricted from viewing client details.
</translate>

<translate>


{| style="display:block; width:100%; box-shadow: 2px 2px 15px rgba(45, 51, 72, 0.1); border-radius: 8px; border-collapse: collapse; margin-left:20px;"
|- style=""
! style="font-weight: bold; padding: 30px; text-transform: uppercase; width: 25%;" |
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Admin/System User
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Junior Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer without Personal Info Access
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Dashboard Access
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payments
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Invoices
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Recurring profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Customer payment methods
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Create payment requests
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage user profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage company profile
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF;text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payment processors
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tax management
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Custom features
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Reports
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tag groups
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | User activity logs
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | API keys
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|}
</translate>

SBPay.me User Roles

2025-05-15T15:09:51Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Frequently Asked Questions about Revenue Management Software & Billing | SBPay.me
|description=Assign specific user roles for SBPay.me to manage transactions securely. Customize permissions easily. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, access levels, user roles, system access, create user, create access, add accountant access
}}
</translate>

<translate>

Adding users to your [https://sbpay.me SBPay.me] account is a simple process that allows you to grant appropriate access rights to different team members based on their responsibilities and needs within the platform.


'''Please note!''' The functionalities and range of user roles might be modified and extended in future development versions of SBPay.me.
</translate>

<translate>

To add a new user, do the following:


:1. Go to SBPay.me -> Users section > Click on Users.
:2. Click on the New User button.
:3. Create User Profile: input Login, Name, Email address, Phone number, and select the user Role.
:4. Once a profile is created the user will receive the invitation email and will be able to set his/get first password as well as 2-factor authentication.


'''Please note!''' Each user's email address must be unique. It is not possible to create more than one user with the same email address.
</translate>

<translate>


;'''User Roles'''


System User: The profile of the main admin of the account. Possesses all access levels Admin has, and additionally includes the rights to manage and block other system users with the Admin rights.
</translate>

<translate>

Admin: Administrators have the highest access level, enabling them to configure settings, manage user roles, initiate transactions, and oversee the entire financial ecosystem within SBPay. They have access to dashboard statistics, payments, invoices, recurring profiles, customer payment methods, and can create payment requests. Admins also manage company profiles, payment processors, taxes, custom features, and reports. They have the capability to create other system users and view the action logs of all the other users. Additionally, Admins have access to API Keys Authentication token, and Secret Key.
</translate>

<translate>

'''Please note!''' Admin and can not change any details associated with the System User role as well as block the System User profile.
</translate>
<translate>

Accountant: Accountants have access to sales sections, payments, invoices, recurring profiles, customer payment methods, and the ability to create payment requests. They can view their own user profile, manage taxes (including adding new ones), access tax reports, customer reports, and subscription metrics.
</translate>

<translate>

Junior Accountant: Junior Accountants have moderate access to the dashboard and sales section Can create payment requests, view and manage their own user profile. Also, have view only access to the taxes section within SBPay.
</translate>
<translate>

Viewer: Viewers have limited access, allowing them to view sales sections (payments, invoices, recurring profiles, customer payment methods), tax settings, tax reports, customer reports, and subscription metrics. They can only view information from these sections without the ability to make changes.
</translate>

<translate>

Viewer without Personal Info Access: Similar to the Viewer role, this user can access the same settings but is restricted from viewing client details.
</translate>

<translate>


{| style="display:block; width:100%; box-shadow: 2px 2px 15px rgba(45, 51, 72, 0.1); border-radius: 8px; border-collapse: collapse; margin-left:20px;"
|- style=""
! style="font-weight: bold; padding: 30px; text-transform: uppercase; width: 25%;" |
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Admin/System User
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Junior Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer without Personal Info Access
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Dashboard Access
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payments
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Invoices
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Recurring profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Customer payment methods
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Create payment requests
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage user profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage company profile
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF;text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payment processors
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tax management
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Custom features
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Reports
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tag groups
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | User activity logs
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | API keys
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|}
</translate>

SBPay.me User Roles

2025-05-15T14:30:23Z

Tania: Marked this version for translation

<languages/>
<translate>

{{#seo:
|title=Frequently Asked Questions about Revenue Management Software & Billing | SBPay.me
|description=Assign specific user roles for SBPay.me to manage transactions securely. Customize permissions easily. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, access levels, user roles, system access, create user, create access, add accountant access
}}
</translate>

<translate>

Adding users to your [https://sbpay.me SBPay.me] account is a simple process that allows you to grant appropriate access rights to different team members based on their responsibilities and needs within the platform.


'''Please note!''' The functionalities and range of user roles might be modified and extended in future development versions of SBPay.me.
</translate>

<translate>

To add a new user, do the following:


:1. Go to SBPay.me -> Users section > Click on Users.
:2. Click on the New User button.
:3. Create User Profile: input Login, Name, Email address, Phone number, and select the user Role.
:4. Once a profile is created the user will receive the invitation email and will be able to set his/get first password as well as 2-factor authentication.


'''Please note!''' Each user's email address must be unique. It is not possible to create more than one user with the same email address.
</translate>

<translate>


;'''User Roles'''


System User: The profile of the main admin of the account. Possesses all access levels Admin has, and additionally includes the rights to manage and block other system users with the Admin rights.
</translate>
<translate>

Admin: Administrators have the highest access level, enabling them to configure settings, manage user roles, initiate transactions, and oversee the entire financial ecosystem within SBPay. They have access to dashboard statistics, payments, invoices, recurring profiles, customer payment methods, and can create payment requests. Admins also manage company profiles, payment processors, taxes, custom features, and reports. They have the capability to create other system users and view the action logs of all the other users. Additionally, Admins have access to API Keys Authentication token, and Secret Key.
</translate>
<translate>

'''Please note!''' Admin and can not change any details associated with the System User role as well as block the System User profile.
</translate>
<translate>

Accountant: Accountants have access to sales sections, payments, invoices, recurring profiles, customer payment methods, and the ability to create payment requests. They can view their own user profile, manage taxes (including adding new ones), access tax reports, customer reports, and subscription metrics.
</translate>
<translate>

Junior Accountant: Junior Accountants have moderate access to the dashboard and sales section Can create payment requests, view and manage their own user profile. Also, have view only access to the taxes section within SBPay.
</translate>
<translate>

Viewer: Viewers have limited access, allowing them to view sales sections (payments, invoices, recurring profiles, customer payment methods), tax settings, tax reports, customer reports, and subscription metrics. They can only view information from these sections without the ability to make changes.
</translate>
<translate>

Viewer without Personal Info Access: Similar to the Viewer role, this user can access the same settings but is restricted from viewing client details.
</translate>

<translate>


{| style="display:block; width:100%; box-shadow: 2px 2px 15px rgba(45, 51, 72, 0.1); border-radius: 8px; border-collapse: collapse; margin-left:20px;"
|- style=""
! style="font-weight: bold; padding: 30px; text-transform: uppercase; width: 25%;" |
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Admin/System User
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Junior Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer without Personal Info Access
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Dashboard Access
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payments
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Invoices
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Recurring profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Customer payment methods
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Create payment requests
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage user profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage company profile
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF;text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payment processors
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tax management
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Custom features
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Reports
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tag groups
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | User activity logs
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | API keys
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|}
</translate>

SBPay.me User Roles

2025-05-15T14:29:55Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Frequently Asked Questions about Revenue Management Software & Billing | SBPay.me
|description=Assign specific user roles for SBPay.me to manage transactions securely. Customize permissions easily. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, access levels, user roles, system access, create user, create access, add accountant access
}}
</translate>

<translate>
Adding users to your [https://sbpay.me SBPay.me] account is a simple process that allows you to grant appropriate access rights to different team members based on their responsibilities and needs within the platform.

'''Please note!''' The functionalities and range of user roles might be modified and extended in future development versions of SBPay.me.
</translate>

<translate>
To add a new user, do the following:

:1. Go to SBPay.me -> Users section > Click on Users.
:2. Click on the New User button.
:3. Create User Profile: input Login, Name, Email address, Phone number, and select the user Role.
:4. Once a profile is created the user will receive the invitation email and will be able to set his/get first password as well as 2-factor authentication.

'''Please note!''' Each user's email address must be unique. It is not possible to create more than one user with the same email address.
</translate>

<translate>

;'''User Roles'''

System User: The profile of the main admin of the account. Possesses all access levels Admin has, and additionally includes the rights to manage and block other system users with the Admin rights.
</translate>
<translate>
Admin: Administrators have the highest access level, enabling them to configure settings, manage user roles, initiate transactions, and oversee the entire financial ecosystem within SBPay. They have access to dashboard statistics, payments, invoices, recurring profiles, customer payment methods, and can create payment requests. Admins also manage company profiles, payment processors, taxes, custom features, and reports. They have the capability to create other system users and view the action logs of all the other users. Additionally, Admins have access to API Keys Authentication token, and Secret Key.
</translate>
<translate>
'''Please note!''' Admin and can not change any details associated with the System User role as well as block the System User profile.
</translate>
<translate>
Accountant: Accountants have access to sales sections, payments, invoices, recurring profiles, customer payment methods, and the ability to create payment requests. They can view their own user profile, manage taxes (including adding new ones), access tax reports, customer reports, and subscription metrics.
</translate>
<translate>
Junior Accountant: Junior Accountants have moderate access to the dashboard and sales section Can create payment requests, view and manage their own user profile. Also, have view only access to the taxes section within SBPay.
</translate>
<translate>
Viewer: Viewers have limited access, allowing them to view sales sections (payments, invoices, recurring profiles, customer payment methods), tax settings, tax reports, customer reports, and subscription metrics. They can only view information from these sections without the ability to make changes.
</translate>
<translate>
Viewer without Personal Info Access: Similar to the Viewer role, this user can access the same settings but is restricted from viewing client details.
</translate>

<translate>

{| style="display:block; width:100%; box-shadow: 2px 2px 15px rgba(45, 51, 72, 0.1); border-radius: 8px; border-collapse: collapse; margin-left:20px;"
|- style=""
! style="font-weight: bold; padding: 30px; text-transform: uppercase; width: 25%;" |
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Admin/System User
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Junior Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer without Personal Info Access
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Dashboard Access
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payments
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Invoices
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Recurring profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Customer payment methods
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Create payment requests
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage user profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage company profile
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF;text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payment processors
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tax management
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Custom features
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Reports
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tag groups
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | User activity logs
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | API keys
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|}
</translate>

SBPay.me User Roles

2025-05-15T14:29:14Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Frequently Asked Questions about Revenue Management Software & Billing | SBPay.me
|description=Assign specific user roles for SBPay.me to manage transactions securely. Customize permissions easily. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, access levels, user roles, system access, create user, create access, add accountant access
}}
</translate>

<translate>
Adding users to your [https://sbpay.me SBPay.me] account is a simple process that allows you to grant appropriate access rights to different team members based on their responsibilities and needs within the platform.

'''Please note!''' The functionalities and range of user roles might be modified and extended in future development versions of SBPay.me.
</translate>

<translate>
To add a new user, do the following:

:1. Go to SBPay.me -> Users section > Click on Users.
:2. Click on the New User button.
:3. Create User Profile: input Login, Name, Email address, Phone number, and select the user Role.
:4. Once a profile is created the user will receive the invitation email and will be able to set his/get first password as well as 2-factor authentication.

'''Please note!''' Each user's email address must be unique. It is not possible to create more than one user with the same email address.
</translate>

<translate>

;'''User Roles'''

System User: The profile of the main admin of the account. Possesses all access levels Admin has, and additionally includes the rights to manage and block other system users with the Admin rights.
</translate>
<translate>
Admin: Administrators have the highest access level, enabling them to configure settings, manage user roles, initiate transactions, and oversee the entire financial ecosystem within SBPay. They have access to dashboard statistics, payments, invoices, recurring profiles, customer payment methods, and can create payment requests. Admins also manage company profiles, payment processors, taxes, custom features, and reports. They have the capability to create other system users and view the action logs of all the other users. Additionally, Admins have access to API Keys Authentication token, and Secret Key.
</translate>
<translate>
'''Please note!''' Admin and can not change any details associated with the System User role as well as block the System User profile.
</translate>
<translate>
Accountant: Accountants have access to sales sections, payments, invoices, recurring profiles, customer payment methods, and the ability to create payment requests. They can view their own user profile, manage taxes (including adding new ones), access tax reports, customer reports, and subscription metrics.
</translate>
<translate>
Junior Accountant: Junior Accountants have moderate access to the dashboard and sales section Can create payment requests, view and manage their own user profile. Also, have view only access to the taxes section within SBPay.
</translate>
<translate>
Viewer: Viewers have limited access, allowing them to view sales sections (payments, invoices, recurring profiles, customer payment methods), tax settings, tax reports, customer reports, and subscription metrics. They can only view information from these sections without the ability to make changes.
</translate>
<translate>
Viewer without Personal Info Access: Similar to the Viewer role, this user can access the same settings but is restricted from viewing client details.
</translate>
<translate>

{| style="display:block; width:100%; box-shadow: 2px 2px 15px rgba(45, 51, 72, 0.1); border-radius: 8px; border-collapse: collapse; margin-left:20px;"
|- style=""
! style="font-weight: bold; padding: 30px; text-transform: uppercase; width: 25%;" |
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Admin/System User
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Junior Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer without Personal Info Access
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Dashboard Access
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payments
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Invoices
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Recurring profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Customer payment methods
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Create payment requests
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage user profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage company profile
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF;text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payment processors
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tax management
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Custom features
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Reports
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tag groups
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | User activity logs
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | API keys
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|}
</translate>

SBPay.me User Roles

2025-05-15T14:28:38Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Frequently Asked Questions about Revenue Management Software & Billing | SBPay.me
|description=Assign specific user roles for SBPay.me to manage transactions securely. Customize permissions easily. Learn how here!
|titlemode=append
|keywords=faq, frequently asked questions, setup, setup help, support, help content, access levels, user roles, system access, create user, create access, add accountant access
}}
</translate>

<translate>
Adding users to your [https://sbpay.me SBPay.me] account is a simple process that allows you to grant appropriate access rights to different team members based on their responsibilities and needs within the platform.

'''Please note!''' The functionalities and range of user roles might be modified and extended in future development versions of SBPay.me.
</translate>

<translate>
To add a new user, do the following:

:1. Go to SBPay.me -> Users section > Click on Users.
:2. Click on the New User button.
:3. Create User Profile: input Login, Name, Email address, Phone number, and select the user Role.
:4. Once a profile is created the user will receive the invitation email and will be able to set his/get first password as well as 2-factor authentication.

'''Please note!''' Each user's email address must be unique. It is not possible to create more than one user with the same email address.
</translate>

<translate>
;'''User Roles'''

System User: The profile of the main admin of the account. Possesses all access levels Admin has, and additionally includes the rights to manage and block other system users with the Admin rights.
</translate>
<translate>
Admin: Administrators have the highest access level, enabling them to configure settings, manage user roles, initiate transactions, and oversee the entire financial ecosystem within SBPay. They have access to dashboard statistics, payments, invoices, recurring profiles, customer payment methods, and can create payment requests. Admins also manage company profiles, payment processors, taxes, custom features, and reports. They have the capability to create other system users and view the action logs of all the other users. Additionally, Admins have access to API Keys Authentication token, and Secret Key.
</translate>
<translate>
'''Please note!''' Admin and can not change any details associated with the System User role as well as block the System User profile.
</translate>
<translate>
Accountant: Accountants have access to sales sections, payments, invoices, recurring profiles, customer payment methods, and the ability to create payment requests. They can view their own user profile, manage taxes (including adding new ones), access tax reports, customer reports, and subscription metrics.
</translate>
<translate>
Junior Accountant: Junior Accountants have moderate access to the dashboard and sales section Can create payment requests, view and manage their own user profile. Also, have view only access to the taxes section within SBPay.
</translate>
<translate>
Viewer: Viewers have limited access, allowing them to view sales sections (payments, invoices, recurring profiles, customer payment methods), tax settings, tax reports, customer reports, and subscription metrics. They can only view information from these sections without the ability to make changes.
</translate>
<translate>
Viewer without Personal Info Access: Similar to the Viewer role, this user can access the same settings but is restricted from viewing client details.
</translate>
<translate>

{| style="display:block; width:100%; box-shadow: 2px 2px 15px rgba(45, 51, 72, 0.1); border-radius: 8px; border-collapse: collapse; margin-left:20px;"
|- style=""
! style="font-weight: bold; padding: 30px; text-transform: uppercase; width: 25%;" |
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Admin/System User
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Junior Accountant
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer
! style="text-align: center; font-weight: bold; color: #0B3052; width: 15%;" | Viewer without Personal Info Access
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Dashboard Access
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payments
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Invoices
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Recurring profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Customer payment methods
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Limited 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Create payment requests
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage user profiles
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | Own only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Manage company profile
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF;text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Payment processors
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tax management
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Custom features
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Reports
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
| style="border-bottom: 1px solid #e7ecf7; text-align: center;" | View Only 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | Tag groups
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | User activity logs
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|-
| style="border-bottom: 1px solid #e7ecf7; padding: 10px;" | API keys
| style="border-bottom: 1px solid #e7ecf7; color: #06ADEF; text-align: center; height: 30px;" | ✔ 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
| style="border-bottom: 1px solid #e7ecf7; text-align: center; " | 
|}
</translate>

Catalogue

2025-05-15T14:16:56Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Catalogue - SimplyBook.me
|description=Learn about the SimplyBook.me API built on JSON-RPC protocol. Access remote services via HTTPS with JSON-serialized requests!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}
</translate>

<translate>

==General Information== 


SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using JSON. A request is a call to a specific method provided by a remote system. It must contain three certain properties:


* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.


The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.


* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>

Example


<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Hourly photoshoot",
"duration": "60",
"hide_duration": "0",
"description": "If you want to try yourself as a model but haven't decided on an image. 5-7 retouched and print-ready photos + the raw footage on a disc ",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>


All calls of public service methods should have additional HTTP header:


* <code>X-Token</code> an authentication token. See [[Catalogue#Authentication|authentication]] section.
</translate>

<translate>
===Endpoint=== 


Use URL <code>https://user-api.simplybook.me/catalogue</code> for all service API calls listed in [[Catalogue#Methods|methods section]].

===Authentication=== 


Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> or <code>[[Authentication#getToken|getToken]]</code> API methods on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom Features#API|API Custom Feature]] 'Settings'.

== Methods == 

=== getCategories === 


<code>getCategories()</code>


No arguments.
Returns Array.


Get lsit of ALL categories
</translate>

----
<translate>
=== getCities === 


<code>getCities($country)</code>


Parameters:


* '''$country''' String


Returns Array.


Returns city list as Array order by name
</translate>

----
<translate>
=== getCompanyCount === 


<code>getCompanyCount($filter)</code>


Parameters:


* '''$filter''' Object - filter object


Returns array.


Returns total companies count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
</translate>

----
<translate>
=== getCompanyInfo === 


<code>getCompanyInfo($login)</code>


Parameters:


* '''$login''' String


Returns Object.


Returns company information by company login

</translate>
----
<translate>
=== getCompanyList === 


<code>getCompanyList($filter, $from, $limit)</code>


Parameters:


* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit


Returns array.


Returns companies list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
</translate>

----
<translate>
=== getCompanyMarkers === 


<code>getCompanyMarkers($filter, $bounds, $zoom, $clustering)</code>


Parameters:


* '''$filter''' Object - filter object
* '''$bounds'''
* '''$zoom'''
* '''$clustering'''


Returns array.


Returns company markers$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>
=== getCompanyReviews === 


<code>getCompanyReviews($login)</code>


Parameters:


* '''$login''' String


Returns Object.


Returns company reviews list

</translate>
----
<translate>

=== getCountries === 


<code>getCountries()</code>


No arguments.
Returns Array.


Returns country list as Array order by name

</translate>
----
<translate>

=== getFeedbackList === 


<code>getFeedbackList()</code>


No arguments.
Returns Array.


Get lsit of ALL simplybook feedbacks

</translate>
----
<translate>

=== getPromotionCount === 


<code>getPromotionCount($filter)</code>


Parameters:


* '''$filter''' Object - filter object


Returns array.


Returns total active promotions count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getPromotionInfo === 


<code>getPromotionInfo($id, $feedbackFrom, $feedbackCount)</code>


Parameters:


* '''$id''' Integer
* '''$feedbackFrom''' Integer = 0
* '''$feedbackCount''' Integer = 100


Returns Object.


Returns promotion information by id

</translate>
----
<translate>

=== getPromotionList === 


<code>getPromotionList($filter, $from, $limit)</code>


Parameters:


* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit


Returns array.


Returns active promotion list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getPromotionListByIds === 


<code>getPromotionListByIds($ids)</code>


Parameters:


* '''$ids'''


Returns array.


Returns active promotion list

</translate>
----
<translate>

=== getPromotionReviews === 


<code>getPromotionReviews($promotionId)</code>


Parameters:


* '''$promotionId''' Integer


Returns Object.


Returns promotion reviews list

</translate>
----
<translate>

=== getRecentCompanies === 


<code>getRecentCompanies($count)</code>


Parameters:


* '''$count''' Integer


Returns Array.


Returns list of companies ordered by date DESC

</translate>
----
<translate>

=== getRecentFeedbacks === 


<code>getRecentFeedbacks($count)</code>


Parameters:


* '''$count''' Integer


Returns Array.


Returns list of feedbacs ordered by date DESC

</translate>
----
<translate>

=== getRecentPromotions === 


<code>getRecentPromotions($count)</code>


Parameters:


* '''$count''' Integer


Returns Array.


Returns list of promotions ordered by date DESC

</translate>
----
<translate>

=== getRelatedPromotions === 


<code>getRelatedPromotions($id, $count)</code>


Parameters:


* '''$id''' Integer
* '''$count''' Integer = 10


Returns Array.


Returns related promotions by given promotion id

</translate>
----
<translate>

=== getTags === 


<code>getTags($filter)</code>


Parameters:


* '''$filter''' Object - filter object


Returns Array.


Returns tags list$filter filter params. Object that contains following params
<pre>
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getTopCities === 


<code>getTopCities()</code>


No arguments.
Returns Array.


Returns city list as Array order by company count in city

</translate>
----
<translate>

=== getTopCountries === 


<code>getTopCountries()</code>


No arguments.
Returns Array.


Returns country list as Array order by company count in country
</translate>

Company administration service methods

2025-05-15T14:14:46Z

Tania:

<languages/>
<translate>


{{#seo:
|title=Company administration service methods - SimplyBook.me
|description=Learn about service methods for internal company administration. Manage bookings tailored to your operations. Start here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>

==General Information== 


SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

</translate>

<translate>


* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.
</translate>

<translate>

The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.


* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>

Example


<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Hourly photoshoot",
"duration": "60",
"hide_duration": "0",
"description": "If you want to try yourself as a model but haven't decided on an image. 5-7 retouched and print-ready photos + the raw footage on a disc ",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>
</translate>

<translate>

Example of request with error response:


<pre>
Request
{
"jsonrpc": "2.0",
"method": "someNotExistingMethod",
"params":[],
"id":1
}

Response
{
"jsonrpc": "2.0",
"id":1,
"error": {
"code": -32601,
"message": "Method not found"
}
}
</pre>
</translate>

<translate>

All calls of public service methods should have additional HTTP header:


* <code>X-Token</code> an authentication token. See [[Company administration service methods#Authentication|authentication]] section.

===Endpoint=== 


Use URL <code>https://user-api.simplybook.me/admin</code> for all administration service API calls.

===Authentication=== 


Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom Features#API|API Custom Feature]] 'Settings'.

== Methods == 

=== addClient === 


<code>addClient($clientData)</code>


Parameters:


* '''$clientData''' Object


Returns Integer.

</translate>

<translate>


Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id. If client record with specified data exists method will return an id of this record. Otherwise data
will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.Also email, phone number or both of them can be mandatory fields. You should call
<code>getCompanyParam('require_fields')</code> method to check which fields are required.


Method returns an error:


* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong


Example:


{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "FrancesTPerez@teleworm.us",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872
}

</translate>

<translate>

----

=== addDeviceToken === 


<code>addDeviceToken($token, $device)</code>


Parameters:


* '''$token''' String a device token string
* '''$device''' String a device type ('android' or 'apple')


Returns boolean.


Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
changes in already created bookings. Use either <code>'apple'</code> or <code>'android'</code> for <code>device</code>
parameter.


----
</translate>

<translate>

=== book === 


<code>book($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)</code>


Parameters:


* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' string a date string in format 'Y-m-d'
* '''$startTime''' string a time string in format 'H:i:s'
* '''$endDate''' string a date string in format 'Y-m-d'
* '''$endTime''' string a time string in format 'H:i:s'
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.
* '''$count''' Integer bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
* '''$batchId''' Integer add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
* '''$recurringData''' Array - make booking recurrent. (optional)


Returns Object.

</translate>

<translate>


Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[Company administration service methods#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>$clientTimeOffset</code> parameter as difference between company's time zone and
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using <code>[[Company administration service methods#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specified). You should specify an <code>$additionalFields</code> parameter if service requires some intake forms (see [[Custom Features#Intake Forms|Intake Forms Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>

</translate>

<translate>


If [[Custom Features#Multiple Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('location')]]</code>
to check if Custom feature active and <code>[[Company administration service methods#getLocationsList|getLocationsList()]]</code> method to get list of
available locations.


See [[Company administration service methods#book response|example]] of <code>book</code> API method response.


See also:


* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

</translate>

----
<translate>

=== calculateEndTime === 


<code>calculateEndTime($startDateTime, $eventId, $unitId)</code>


Parameters:


* '''$startDateTime''' String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
* '''$eventId''' Integer
* '''$unitId''' Integer


Returns String|Boolean.


Returns end datetime if booking is available, else return false


----
</translate>

<translate>

=== cancelBatch === 


<code>cancelBatch($id, $bookingIds)</code>


Parameters:


* '''$id''' Integer identifier of batch. See <code>[[Company administration service methods#createBatch|createBatch]]</code> API method.
* '''$bookingIds''' Array ids of bookings included to batch.


Returns boolean.


Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in <code>$bookingIds</code> list is used for
information in notifications.


----
</translate>

<translate>

=== cancelBooking === 


<code>cancelBooking($id)</code>


Parameters:


* '''$id''' Integer


Returns Boolean.


Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.


----
</translate>

<translate>

=== createBatch === 


<code>createBatch()</code>


No arguments.
Returns Integer.


Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[Company administration service methods#book|book]]</code>
API method.


----
</translate>

<translate>

=== deleteDeviceToken === 


<code>deleteDeviceToken($token)</code>


Parameters:


* '''$token''' String - device token


Returns boolean.


Unsubscribe from push notifications service.


----
</translate>

<translate>

=== editBook === 


<code>editBook($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)</code>


Parameters:


* '''$shedulerId''' Integer an id of booking to edit. See <code>[[Company administration service methods#book|book]]</code> or <code>[[Company administration service methods#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' String - in Y-m-d format
* '''$startTime''' String - in H:i:s format
* '''$endDate''' String - in Y-m-d format
* '''$endTime''' String - in H:i:s format
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.


Returns Object.


Edit existing booking record. See [[Company administration service methods#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.


----
</translate>

<translate>

=== editClient === 


<code>editClient($clientId, $clientData)</code>


Parameters:


* '''$clientId''' Integer
* '''$clientData''' Object


Returns Integer.


Edits client's record. See <code>[[Company administration service methods#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.


----
</translate>

<translate>

=== filterAvailableUnits === 


<code>filterAvailableUnits($eventId, $dateTime, $unitIds, $count)</code>


Parameters:


* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$unitIds'''
* '''$count''' Integer


Returns Array.


Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom Feature.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>


----
</translate>

<translate>

=== getAdditionalFields === 


<code>getAdditionalFields($eventId)</code>


Parameters:


* '''$eventId''' Integer


Returns Array.


Return intake forms for certain event if [[Custom Features#Intake Forms|Intake Forms Custom Feature]] is
activated. Returns empty array otherwise. Call <code>[[Company administration service methods#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.


----
</translate>

<translate>

=== getAnyUnitData === 


<code>getAnyUnitData()</code>


No arguments.
Returns Object|null.


Returns information about [[Custom Features#Any Employee Selector|Any Employee selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}


----
</translate>

<translate>

=== getAvailableTimeIntervals === 


<code>getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>


Parameters:


* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer


Returns Object.


Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: <code>{['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}</code>


----
</translate>

<translate>

=== getAvailableUnits === 


<code>getAvailableUnits($eventId, $dateTime, $count)</code>


Parameters:


* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$count''' Integer


Returns Array.


Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: <code>[1, 2, 3]</code>


----

</translate>

<translate>

=== getBookingCancellationsInfo === 


<code>getBookingCancellationsInfo($dateStart, $dateEnd)</code>


Parameters:


* '''$dateStart''' String a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
* '''$dateEnd''' String a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.


Returns Array.


Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. <code>"type"</code> field can be either
"create", "cancel" or "nopayment_cancel". If <code>"user_id"</code> not specified then bookings where created or
cancelled by admin or employee. Data with type <code>"nopayment_cancel"</code> represents bookings cancelled
automatically by system.Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]


----

</translate>

<translate>

=== getBookingComment === 


<code>getBookingComment($id)</code>


Parameters:


* '''$id''' Integer


Returns String.


Returns booking comment


----
</translate>

<translate>

=== getBookingDetails === 


<code>getBookingDetails($id)</code>


Parameters:


* '''$id''' integer booking id


Returns Array.


Returns detailed bookings object by booking id. See [[Company administration service methods#getBookingDetails response|response example]].


----
</translate>

<translate>

=== getBookingLimitUnavailableTimeInterval === 


<code>getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)</code>


Parameters:


* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$eventId''' integer


Returns Array.


Returns time intervals not available for bookings because of configuration of [[Custom Features#Limit Bookings|Limit bookings]]
Custom Feature for period of time. Returns empty array if Custom Feature not available.


----
</translate>

<translate>

=== getBookingRevenue === 


<code>getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)</code>


Parameters:


* '''$dateStart''' string a date string in format 'Y-m-d'.
* '''$dateEnd''' string a date string in format 'Y-m-d'
* '''$unitGroupId''' integer
* '''$serviceId''' integer


Returns Array.


Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either
by unit or by service. Set <code>$dateStart</code> and <code>$dateEnd</code> to null to get data for current week.Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}


----
</translate>

<translate>

=== getBookingStats === 


<code>getBookingStats($groupBy)</code>


Parameters:


* '''$groupBy''' String either 'day', 'week' or 'month'


Returns Array.


Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months


----
</translate>

<translate>

=== getBookings === 


<code>getBookings($params)</code>


Parameters:


* '''$params'''


Returns Array.


Returns list of bookings filtered by given params. Filter params represented as object with following fields:* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Custom Features#Approve Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking Custom Feature status.
*: If Custom Feature not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If Custom Feature active:
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)


Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}


----
</translate>

<translate>

=== getBookingsZapier === 


<code>getBookingsZapier()</code>


No arguments.
Returns Array.


Returns list of bookings filtered by given params


----
</translate>

<translate>

=== getCategoriesList === 


<code>getCategoriesList($isPublic)</code>


Parameters:


* '''$isPublic''' Boolean


Returns Array.


Returns company categories list if [[Custom Features#Service Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if Custom Feature is not activated. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.


----

</translate>

<translate>

=== getClient === 


<code>getClient($clientId)</code>


Parameters:


* '''$clientId'''


Returns Array.


Returns client's data object. See <code>[[Company administration service methods#addClient|addClient]]</code> API method for list of available fields
of client data object.


----

</translate>

<translate>

=== getClientComments === 


<code>getClientComments($clientId, $shedulerId)</code>


Parameters:


* '''$clientId''' Integer
* '''$shedulerId''' Integer


Returns Array.


Returns list of all comments for given client


----

</translate>

<translate>

=== getClientList === 


<code>getClientList($searchString, $limit)</code>


Parameters:


* '''$searchString''' String
* '''$limit''' Integer


Returns Array.


Returns list of clients associated with company. You can use either phone number, email address or name as value
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
parameters to get all records. See <code>[[Company administration service methods#addClient|addClient]]</code> API method for list of available fields
of client data object.


----

</translate>

<translate>

=== getCompanyCurrency === 


<code>getCompanyCurrency()</code>


No arguments.
Returns String.


Returns company's currency as three chars code (ISO 4217).


----
</translate>

<translate>

=== getCompanyInfo === 


<code>getCompanyInfo()</code>


No arguments.
Returns Object.


Returns an object with detailed information about company. See [[Company administration service methods#getCompanyInfo response|example of response]].


----

</translate>

<translate>

=== getCompanyParam === 


<code>getCompanyParam($key)</code>


Parameters:


* '''$key''' String


Returns mixed.


Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[Company administration service methods#Company params|list of available keys]].


----

</translate>

<translate>

=== getCompanyParams === 


<code>getCompanyParams($keys)</code>


Parameters:


* '''$keys''' Array


Returns Array.


Returns company config values for keys. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[Company administration service methods#Company params|list of available keys]].For non-existent and not-allowed params it will return false as result


----

</translate>

<translate>

=== getCompanyTimezoneOffset === 


<code>getCompanyTimezoneOffset()</code>


No arguments.
Returns array.


Returns company timezone offset and company timezone


----

</translate>

<translate>

=== getCountryList === 


<code>getCountryList()</code>


No arguments.
Returns Array.


Get list of all countries


----

</translate>

<translate>

=== getCountryPhoneCodes === 


<code>getCountryPhoneCodes()</code>


No arguments.
Returns Array.


Returns country phone code list


----

</translate>

<translate>

=== getCurrentTariffInfo === 


<code>getCurrentTariffInfo()</code>


No arguments.
Returns Array.


Returns all information about current tariff (subscription). For example:{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}


----

</translate>

<translate>

=== getCurrentUserDetails === 


<code>getCurrentUserDetails()</code>


No arguments. Returns Object.


Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on <code>group</code> property value. Most of API methods returns an error if user has low access
rights but not all. There are 4 roles:


* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode


<code>group</code> property can be one of the values:


* <code>shop_user</code> - "Senior Employee" access role
* <code>station_user</code> - "Junior Employee" access role
* <code>admin</code> - "Administrator" access role
* <code>viewer</code> - "Viewer" access role
* <code>reseller_company_admin</code> - reserved


Example:


{
"id": 1,
"login": admin,
"email": "admin@mycoolcompany.com";
"firstname": "Michail",
"lastname": " ",
"phone": "",
"group": "admin",
"is_blocked": 0,
"last_access_time": "2016-06-06 17:55:51",
"unit_group_id": null
}


----

</translate>

<translate>

=== getEventList === 


<code>getEventList($isVisibleOnly, $asArray)</code>


Parameters:


* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean


Returns Array.


Returns company's events list. If <code>$asArray</code> is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
event's details object.


----

</translate>

<translate>

=== getFeedbacks === 


<code>getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)</code>


Parameters:


* '''$approvedOnly''' Boolean
* '''$reviewsOnly''' Boolean
* '''$lastOnly''' Boolean
* '''$limit''' Integer


Returns Array.


Get list of feedbacks


----

</translate>

<translate>

=== getFirstWorkingDay === 


<code>getFirstWorkingDay($unitId)</code>


Parameters:


* '''$unitId''' Integer


Returns String.


Returns first working date for unit


----

</translate>

<translate>

=== getGoogleCalendarBusyTime === 


<code>getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)</code>


Parameters:


* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in
this parameter. In this case method will use time value '23:59:59'.
* '''$unitId''' integer


Returns Array.


Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
be returned. You should call <code>[[Company administration service methods#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.Example:
<code>
[
{"from" : "2016-02-16 13:30:00",
"to" : "2016-02-16 16:00:00"},
...
]
</code>


----

</translate>

<translate>

=== getGoogleCalendarBusyTimeAvailableUnits === 


<code>getGoogleCalendarBusyTimeAvailableUnits()</code>


No arguments.
Returns Array.


Returns configured unit ids, allowed to sync busy time


----
</translate>

<translate>

=== getLastNotificationUpdate === 


<code>getLastNotificationUpdate($type)</code>


Parameters:


* '''$type''' String


Returns String.


Returns last update datetime


----

</translate>

<translate>

=== getLocationsList === 


<code>getLocationsList($isPublic, $asArray)</code>


Parameters:


* '''$isPublic''' Boolean Optional. Default value is '''false'''.
* '''$asArray''' boolean Optional. Default value is '''false'''.


Returns Array.


Returns available locations for company if Custom Feature [[Custom Features#Multiple Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.


This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.


----
</translate>

<translate>

=== getPluginList === 


<code>getPluginList()</code>


No arguments.
Returns Array.


Returns a list of all Custom Features associated with company with status.


----

</translate>

<translate>



<code>getPluginPromoInfoByCode($code)</code>


Parameters:


* '''$code'''


Returns Array.


Returns an object with detailed information about Rewards and referrals promotion by promotion code. You can get promotion code
using <code>[[Catalogue#getPromotionList|getPromotionList]]</code> API method. If promotion record with specified code not found then method returns an empty array (an empty object). If [[Rewards and Referrals custom feature|Rewards and Referrals Custom Feature]]
not enabled then method returns an error with code -32001 (Custom Feature is not activated). Use
<code>[[Company administration service methods#isPluginActivated|isPluginActivated('promo')]]</code> API method call to check if Custom Feature enabled. See [[Company administration service methods#getPromotionList response|example]] of <code>getPromotionList</code> API method response. Please note that
response contains a list of services for wich promotion discount can be applied (<code>service_ids</code> key).
--->

</translate>

----

<translate>

=== getPluginStatuses === 


<code>getPluginStatuses($pluginNames)</code>


Parameters:


* '''$pluginNames''' Array


Returns Array.


Return Custom Feature status true if status active, else false. See [[Company administration service methods#Custom Features.27 identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== getRecentActions === 


<code>getRecentActions($lastOnly, $limit)</code>


Parameters:


* '''$lastOnly''' Boolean
* '''$limit''' Integer


Returns Array.


Returns latest actions

</translate>

----

<translate>

=== getRecurringDatetimes === 


<code>getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData, $endDateTime)</code>


Parameters:


* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String
* '''$time''' String
* '''$recurringData''' Array
* '''$endDateTime''' String (optional)


Returns Array.


Get list of dates for recurring booking

</translate>

----

<translate>

=== getRecurringSettings === 


<code>getRecurringSettings($eventId)</code>


Parameters:


* '''$eventId''' Integer


Returns Array.


Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.


See also:


* [http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription]

</translate>

----

<translate>

=== getRegistrations === 


<code>getRegistrations($groupBy)</code>


Parameters:


* '''$groupBy''' String either 'day', 'week' or 'month'


Returns Array.


Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getReservedTime === 


<code>getReservedTime($from, $to, $eventId, $unitId, $count)</code>


Parameters:


* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$count''' Integer


Returns Object.


Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom Features#Calendar Sync| Calendar Sync Custom Feature]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[Company administration service methods#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.


Example:
<pre>
{
"2016-02-05": [
{
"dd": [], // time slots from Google calendar
"events": [ // reserved time slots
{ "from": "16:00", "to": "16:30" },
{ "from": "16:30", "to": "17:00" },
... ],
"type": "reserved_time",
},
{
"events": [
{ "from": "09:00", "to": "09:30" },
{ "from": "09:30", "to": "10:00" },
... ],
"type": "not_worked_time"
}],
...
}
</pre>

</translate>

----

<translate>

=== getReservedTimeIntervals === 


<code>getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>


Parameters:


* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Integer|Array
* '''$count''' Integer


Returns Object.


Returns not available time
Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

</translate>

----

<translate>

=== getSocialCounterStats === 


<code>getSocialCounterStats($provider)</code>


Parameters:


* '''$provider''' String


Returns Integer.


Returns social counters value for your domain

</translate>

----

<translate>

=== getStartTimeMatrix === 


<code>getStartTimeMatrix($from, $to, $eventId, $unitId, $count)</code>


Parameters:


* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer


Returns Object.


Returns available start time, taking into account breaktimes, start and end working time
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>


If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom Features#Multiple Locations|Multiple locations]] Custom Feature description for
more details.

</translate>

----

<translate>

=== getStatuses === 


<code>getStatuses()</code>


No arguments.
Returns Array.


Returns list of available statuses or an empty list if [[Custom Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== getTimeframe === 


<code>getTimeframe()</code>


No arguments.
Returns Integer.


Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need to change interval (timeframe)|here]].

</translate>

----

<translate>

=== getTimelineType === 


<code>getTimelineType()</code>


No arguments.
Returns String.


Returns company calendar layout type

</translate>

----

<translate>

=== getTopPerformers === 


<code>getTopPerformers()</code>


No arguments.
Returns Array.


Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

</translate>

----

<translate>

=== getTopServices === 


<code>getTopServices($dateStart, $dateEnd)</code>


Parameters:


* '''$dateStart''' String
* '''$dateEnd''' String


Returns Array.


Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.

</translate>

----

<translate>

=== getUnitList === 


<code>getUnitList($isVisibleOnly, $asArray)</code>


Parameters:


* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean


Returns Array.


Returns list of service performers. If <code>$asArray</code> is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
of event's details object.

</translate>

----

<translate>

=== getUnitWorkdayInfo === 


<code>getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)</code>


Parameters:


* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer


Returns Array.


Return workday info (date_start and date_end)

</translate>

----

<translate>

=== getUnitWorkingDurations === 


<code>getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)</code>


Parameters:


* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer


Returns Array.


Return working durations

</translate>

----

<translate>

=== getVisitorStats === 


<code>getVisitorStats($groupBy)</code>


Parameters:


* '''$groupBy''' String


Returns Array.


Returns statistics about page visits if Custom Feature [[Custom Features#Visitor Counter|Visitor Counter Custom Feature]] enabled. Returns
an empty list if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('counter')]]</code> API method
call to check if Custom Feature enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getWarnings === 


<code>getWarnings($lastOnly)</code>


Parameters:


* '''$lastOnly''' Boolean. Default value is '''false'''.


Returns Array.


Returns a list of objects represented system warnings. Each warning contains <code>warning_type</code> and <code>warning_text</code>
properties. <code>warning_text</code> property contains localized message. <code>warning_type</code> can be one of the values:


* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings

</translate>

----

<translate>

=== getWorkCalendar === 


<code>getWorkCalendar($year, $month, $unitId)</code>


Parameters:


* '''$year''' Integer
* '''$month''' Integer
* '''$unitId''' Integer


Returns Object.


Returns company work schedule as array
Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

</translate>

----

<translate>

=== getWorkDaysInfo === 


<code>getWorkDaysInfo($from, $to, $unitId, $eventId, $count)</code>


Parameters:


* '''$from''' String
* '''$to''' String
* '''$unitId''' Integer (optional)
* '''$eventId''' Integer (optional)
* '''$count''' Integer (optional)


Returns Object.


Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from
service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:<pre>
{'2014-05-14' : [
{'from': '09:00:00', 'to': '13:00:00'},
{'from': '14:00:00', 'to': '19:00:00'}
] }
</pre>


Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.

</translate>

----

<translate>

=== getWorkDaysTimes === 


<code>getWorkDaysTimes($startDateTime, $endDateTime, $type = 'unit_group')</code>


Parameters:


* '''$startDateTime''' string
* '''$endDateTime''' string
* '''$type''' string. Optional. Either 'unit_group' or 'event'.


Returns Array.


Return busy time by unit id by Calendar Sync Custom Feature if enabled. Please note that this method may return not actual data because data synchronization between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.

</translate>

----

<translate>

=== getWorkload === 


<code>getWorkload($dateStart, $dateEnd, $unitGroupId)</code>


Parameters:


* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer


Returns Array.


Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]

</translate>

----

<translate>

=== isPluginActivated === 


<code>isPluginActivated($pluginName)</code>


Parameters:


* '''$pluginName''' String


Returns Boolean.


Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom Features]] page for full Custom Features description. See [[Company administration service methods#Custom Features.27 identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== pluginApproveBookingApprove === 


<code>pluginApproveBookingApprove($id)</code>


Parameters:


* '''$id''' Integer


Returns Array.


Sets approve booking status to 'approved' if [[Custom Features#Approve Bookings|Approve booking]] Custom Feature enabled and returns
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveBookingCancel === 


<code>pluginApproveBookingCancel($id)</code>


Parameters:


* '''$id''' Integer


Returns Boolean.


Sets approve booking status to 'canceled' if [[Custom Features#Approve Bookings|Approve bookings]] Custom Feature enabled and returns
true. Returns false if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookings === 


<code>pluginApproveGetPendingBookings()</code>


No arguments.
Returns array.


Returns list of objects with information about bookings pending approval if [[Custom Features#Approve Bookings|Approve bookings]]
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookingsCount === 


<code>pluginApproveGetPendingBookingsCount()</code>


No arguments.
Returns Integer.


Returns count of bookings pending approval if [[Custom Features#Approve Bookings|Approve bookings]] Custom Feature enabled. Returns
0 if Custom Feature not enabled. Use <code>[[Company administration service methods#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
call to check if Custom Feature enabled.

</translate>

----

<translate>

=== setBookingComment === 


<code>setBookingComment($id, $comment)</code>


Parameters:


* '''$id''' Integer
* '''$comment''' String


Returns Integer.


Set booking comment

</translate>

----

<translate>

=== getBookingStatus === 


<code>getBookingStatus ($bookingId)</code>


Parameters:


* '''$bookingId''' Integer


Returns Array.


Returns an object of status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists

</translate>

----

<translate>

=== setStatus === 


<code>setStatus($bookingId, $statusId)</code>


Parameters:


* '''$bookingId''' Integer
* '''$statusId''' Integer


Returns Boolean.


Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Custom Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== updateNotification === 


<code>updateNotification($type)</code>


Parameters:


* '''$type''' String


Returns .


Mark notifications as readed

</translate>

----

<translate>

=== setWorkDayInfo=== 


<code>setWorkDayInfo($info)</code>


Parameters:


* '''$info''' Array


Returns true on success


Set work day schedule for company|service|provider for week_day|date


Example:
<pre>
{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}


index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company
</pre>

</translate>

----

<translate>

=== deleteSpecialDay=== 


<code>deleteSpecialDay($date, $params = null)</code>


Parameters:


* '''$date''' String
* '''$params''' Array


Returns true on success


Delete special date if set


Example:
<pre>
'2017-08-21',
{
"unit_group_id":"",
"event_id":""
}
</pre>

</translate>

----

<translate>

=== addServiceProvider=== 


<code>addServiceProvider($data)</code>


Parameters:


* '''$data''' Array


Returns Array with result and id of new service provider (unit_group)


Create new service provider


Example:
<pre>
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

</translate>

----

<translate>

=== editServiceProvider=== 


<code>editServiceProvider($id, $data)</code>


Parameters:


* '''$id''' Integer
* '''$data''' Array


Returns Array with result and id of new service provider (unit_group)


Edit service provider
(there is no way to delete provider via API, in this case set is_active = 0)


Example:
<pre>
1,
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>


-
</translate>

----

<translate>

== Constants == 

=== Error codes === 


See [[Errors handling]] for details.


* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32015 Passed event id is not reccuren
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Intake form values are wrong
* -32080 Appointemnt couldn't be found
* -32081 Service can't be performed when company does not work
* -32082 Service performer can't work when company does not work
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found

</translate>

----

<translate>

===Company params=== 


Use these values to get configuration params for company with <code>[[Company administration service methods#getCompanyParam|getCompanyParam]]</code> API method.

=====General params===== 


Administration API inherits all [[Company public service methods#Company params|keys]] allowed for public API and extends this list with keys:


* attach_ical
* auto_redirect
* auto_redirect_text
* blockchain_address
* blockchain_secret
* borgun_merchant_id
* borgun_payment_gateway_id
* borgun_secret_code
* client_batch_cancel_template
* client_batch_cancel_template_email
* client_batch_cancel_template_email_subject
* client_event_cancel_template
* client_event_cancel_template_email
* client_event_cancel_template_email_subject
* client_event_change_template
* client_event_change_template_email
* client_event_change_template_email_subject
* client_event_creation_template
* client_event_creation_template_email
* client_event_creation_template_email_subject
* client_event_group_creation_template
* client_event_group_creation_template_email
* client_event_group_creation_template_email_subject
* client_event_multiple_creation_template
* client_event_multiple_creation_template_email
* client_event_multiple_creation_template_email_subject
* client_group_notification_template
* client_group_notification_template_email
* client_group_notification_template_email_subject
* client_multiple_notification_template
* client_multiple_notification_template_email
* client_multiple_notification_template_email_subject
* client_notification_template
* client_notification_template_email
* client_notification_template_email_subject
* client_notification_time
* client_recurring_event_creation_template
* client_recurring_event_creation_template_email
* client_recurring_event_creation_template_email_subject
* common_limit_booking
* company_ga_tracking_id
* default_phone
* disconnect_on_timeout
* email_event_list
* email_events_list_template
* email_group_events_list_template
* event_list_style
* feed_back_interval
* feedback_invite_template_email
* feedback_invite_template_email_subject
* google_conversion_color
* google_conversion_currency
* google_conversion_format
* google_conversion_id
* google_conversion_label
* google_conversion_language
* google_conversion_value
* hide_working_hours_block
* include_cancel_link
* kortais_merchant
* kortais_secret_code
* kortais_terminal
* layout_background
* layout_background_repeat
* mobile_site_link
* mobile_site_link_title
* no_show_period
* on_success_button_link
* on_success_button_text
* recap_interval
* recap_send_after_time
* recap_send_canceled_bookings
* recap_send_new_bookings
* recap_send_upcomming_bookings
* send_cancel_to_client
* send_cancel_to_client_email
* send_cancel_to_unit
* send_cancel_to_unit_email
* send_contact_widget_email_notification
* send_contact_widget_sms_notification
* send_notify_to_client
* send_notify_to_client_email
* send_notify_to_unit
* send_notify_to_unit_email
* send_onchange_to_client
* send_onchange_to_client_email
* send_onchange_to_unit
* send_onchange_to_unit_email
* send_oncreate_to_client
* send_oncreate_to_client_email
* send_oncreate_to_unit
* send_oncreate_to_unit_email
* send_sms_if_push_enabled
* site_link
* site_link_title
* skip_limits_for_admin
* skip_show_mobile_app_ads
* skip_show_on_success_button
* sms_event_list
* sms_events_list_template
* sms_group_events_list_template
* unit_batch_cancel_template
* unit_batch_cancel_template_email
* unit_batch_cancel_template_email_subject
* unit_event_cancel_template
* unit_event_cancel_template_email
* unit_event_cancel_template_email_subject
* unit_event_change_template
* unit_event_change_template_email
* unit_event_change_template_email_subject
* unit_event_creation_template
* unit_event_creation_template_email
* unit_event_creation_template_email_subject
* unit_event_group_creation_template
* unit_event_group_creation_template_email
* unit_event_group_creation_template_email_subject
* unit_group_notification_template
* unit_group_notification_template_email
* unit_group_notification_template_email_subject
* unit_notification_template
* unit_notification_template_email
* unit_notification_template_email_subject
* unit_notification_time
* unit_recurring_event_creation_template
* unit_recurring_event_creation_template_email
* unit_recurring_event_creation_template_email_subject
* use_common_client_db
* user_confirmation
* user_public_layout
* user_public_theme
* waiting_video

</translate>

----

<translate>

=====Accept payments Custom Feature params===== 


Read more about [[Custom Features#Accept Payments|Accept Payments Custom Feature configuration]].


* allow_delay_payment
*: Allow delay payment option. Boolean.
* company_currency
*:
* hide_sale_tax
*: Hide sales tax option. Boolean.
* payment_timeout
*: Payment timeout option. String ("5 minutes", "1 hour", ...)
* sale_tax
*: Sales tax option. Integer. You should divide by 100 to get percent value.
* paypal_account
*: PayPal payment processor configuration. String.
* skrill_account
*: Skrill payment processor configuration parameter. String.
* skrill_secret
*: Skrill payment processor configuration parameter. String.
* zooz_app_id
*: ZooZ payment processor configuration parameter. String.
* zooz_app_key
*: ZooZ payment processor configuration parameter. String.
* dwolla_application_key
*: Dwolla payment processor configuration parameter. String.
* dwolla_id
*: Dwolla payment processor configuration parameter. String.
* dwolla_secret_key
*: Dwolla payment processor configuration parameter. String.
* liqpay_merchant_id
* liqpay_merchant_pass

</translate>

----

<translate>

=====Term & Conditions Custom Feature params===== 


Read more about [[Custom Features#Terms and Conditions|Terms and Conditions Custom Feature]].


* user_license_text
*: Terms and conditions text. String.

</translate>

----

<translate>

===Custom Features' identifiers=== 


Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[Company administration service methods#isPluginActivated|isPluginActivated]]</code> and <code>[[Company administration service methods#getPluginStatuses|getPluginStatuses]]</code> API methods.


* advanced_notification
*:Book Soon notification system
* any_unit
*:Any Employee selector
* api
*:API
* approve_booking
*:Approve booking
* back_to_site
*:Take me back home
* contact_widget
*:Contact widget
* counter
*:Visitor Counter
* custom_css
*:Custom CSS
* data_security
*:Clean history
* description
*:HTML description field for events
* event_category
*:Service categories
* event_field
*:Intake forms
* facebookImage
*:Facebook client info
* financial_dashboard
*:Insights
* google_analytics
*:Google Adwords and analytics
* google_calendar_export
*:Calendar sync
* group_booking
*:Group bookings
* hipaa
*:HIPAA
* limit_bookings
*:Limit bookings
* location
*:Multiple locations
* mobile_app_backend
*:Mobile application
* multiple_booking
*:Multiple bookings
* news
*:News
* paid_events
*:Accept payments

* recap
*:Daily report
* secure
*:SSL
* status
*:Status
* unit_colors
*:Providers color coding
* user_license
*:Terms and conditions
* cancelation_policy
*:Cancellation Policy


See [[Custom Features]] page for description for each Custom Feature.

</translate>

<translate>
== Examples == 

====getBookingDetails response==== 


An example of data returned by [[Company administration service methods#getBookingDetails|getBookingDetails]] API method.


{
"id": "321",
"event_id": "5",
"event_name": "Massage",
"unit_id": "3",
"unit_name": "John",
"client_id": "1",
"client_name": "Bob",
"start_date_time": "2015-11-25 15:00:00",
"end_date_time": "2015-11-25 16:00:00",
"is_confirmed": "1",
"code": "h8v8w5ls",
"record_date": "2015-11-19 04:06:38",
"comment": null,
"company_login": "testzt",
"company_name": "My Cool Company",
"company_phone": "+1-555-55-55",
"company_email": "into@mycoolcompany.com",
"additional_fields": [{
"value": "on",
"field_name": "201a89517de509f6b3a60858918faac3",
"field_title": "Include washing",
"field_position": "4",
"field_type": "checkbox",
"field_id": "4"
}],
"comments": [],
"history": [{
"id": "536",
"sheduler_id": "321",
"datetime": "2015-11-19 11:06:38",
"type": "create",
"user_id": "1",
"agent": "SimplyBook.me\/55 CFNetwork\/758.0.2 Darwin\/15.0.0",
"ip": "213.174.0.53, 158.69.224.50:127.0.0.1",
"referer": "",
"login": "admin",
"firstname": "Mikhail",
"lastname": ""
}],
"status": {
"id": "3",
"name": "Fancy Status",
"description": null,
"color": "4cbadb",
"is_default": "1"
},
"location": {
"id": "1",
"title": "location",
"description": null,
"picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
"address1": null,
"address2": "Saint Margaret Street",
"city": "\u041b\u043e\u043d\u0434\u043e\u043d",
"zip": null,
"country_id": "GB",
"lat": "51.50013000000000000000",
"lng": "-0.12630500000000000000",
"phone": "44",
"position": "1",
"is_default": "1"
},
"price": [],
"promo": false
}

</translate>

<translate>


Location field is present in response only if [[Custom Features#Multiple Locations|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.


Status field is present in response only if [[Custom Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.


Price field is present in response only if [[Custom Features#Accept Payments|Accept payments Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a free service.



<code>additional_fields</code> field is present in response only if [[Custom Features#Intake Forms|Intake Forms Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a service with no intake forms.

</translate>

----

<translate>

====book response==== 


[[Company administration service methods#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.


{
"require_confirm":false,
"bookings":[
{
"id":"434",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-30 13:00:00",
"end_date_time":"2015-12-30 13:30:00",
"is_confirmed":"1",
"code":"h8vc14ca",
"hash":"785cb8cce316e64765b94c05a635f4be"
},
{
"id":"435",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-31 13:00:00",
"end_date_time":"2015-12-31 13:30:00",
"is_confirmed":"1",
"code":"h8vc2pge",
"hash":"8b92d634541bfd93c0830967e56f4653"
},
{
"id":"436",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-04 13:00:00",
"end_date_time":"2016-01-04 13:30:00",
"is_confirmed":"1",
"code":"h8vc3urb",
"hash":"cd22a0bf183f7350e595988dd2486e5b"
},
{
"id":"437",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-05 13:00:00",
"end_date_time":"2016-01-05 13:30:00",
"is_confirmed":"1",
"code":"h8vc44d9",
"hash":"53f98ff4e4a0323aa907156c59c99362"
}
],
"batch_type":"batch_recurrent_booking",
"recurrent_batch_id":"1",
"batch_hash":"357178bce290381bb7235080941ec143"
}

</translate>

----

<translate>

====getCompanyInfo response==== 


An example of data returned by [[Company administration service methods#getCompanyInfo|getCompanyInfo]] API method.


{
"login": "pierrecoetzee",
"name": "Pierre",
"description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"address1": "",
"address2": "Storey's Gate, ",
"city": "London",
"country_id": "GB",
"lat": "51.500435",
"lng": "-0.129811",
"email": "pierre.coe@gmail.com",
"phone": "",
"web": null,
"skip_address": null,
"logo": null,
"address": "GB, London, Storey's Gate, ",
"description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"timezone": "Europe London",
"show_in_client_timezone": false,
"timeframe": "60",
"timeline_type": "modern_week",
"allow_event_day_break": "0",
"allow_event_breaktime_break": "0"
}


<code>timeline_type</code> field can be one the following values:


* flexible
* modern
* flexible_week
* modern_week
* classic
* classes

</translate>

<translate>

Please note that <code>classic</code> timeline type is deprecated and not supported anymore.


<code>description</code> field contains raw data of company's description which can include HTML tags. <code>description_text</code> field contains only text information without HTML tags.


For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[Company administration service methods#Company params|Company params section]].

</translate>
----

<translate>



{
"id": "1",
"title": "[service\/services] with [discount]% discount!",
"code": "yvuvugum",
"description": "We are offering [service\/services] with an amazing [discount]% discount! We are running this deal for a limited time only.",
"discount": "99.9999",
"start_date": "2015-12-23",
"expired_date": "2016-01-23",
"sheduler_start_date": "2015-12-23",
"sheduler_end_date": "2015-12-31",
"sheduler_start_time": "09:00:00",
"sheduler_end_time": "22:30:00",
"allow_usage_count": "20",
"fineprint_text": "Deal is limited for new clients only. Reward is claimable [client_claim_times_number] times per client. Deal is only claimable for the locations specified. Deal is cannot be combined with any other promotion. Must be redeemed prior to the expiration date shown on the deal.",
"redemption_text": "Present your confirmation code when you want to redeem your deal. You may either to print off your confirmation email or show your confirmation code by loggin into Simplybook on your mobile phone\/Pc.\r\n[promocode]\r\n[discount]\r\n[reward]\r\n[referal_qty]",
"headline": "[service\/services] with [discount]% discount!",
"image": null,
"allow_customer_count": "1",
"show_in_catalogue": "1",
"status": "active",
"plugin_promo_message_id": "1",
"common_promotion_id": "132",
"service_ids": ["1"]
}


<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
</translate>

Integration

2025-05-15T13:21:38Z

Tania: Marked this version for translation

<languages/>
<translate>


{{#seo:
|title=Integration - SimplyBook.me
|description=Explore SimplyBook.me integrations to connect with external tools and platforms. Enhance your workflow. Learn more here!
|titlemode=append
|keywords=faq, frequently asked questions, online scheduling, free scheduling software, online booking system, online calendar, employee scheduling software, schedule, scheduling software, scheduling app, booking calendar, calendar software
}}
</translate>

<translate>

*<div class="article">[[SBPay.me | SBPay.me]]</div>
*<div class="article">[[Widgets for your own website]]</div>
*<div class="article">[https://simplydemowidgets.mozello.com/ Widget examples]</div>
*<div class="article">[[Bookings on Facebook |Bookings on Facebook and Instagram]]</div>
*<div class="article">[[WordPress_integration | WordPress integration]]</div>
*<div class="article">[[Bookings on Facebook | Facebook CTA button and widget]]</div>
*<div class="article">[[Other Integrations]]</div>
*<div class="article">[[Own domain | Custom Domain]]</div>
</translate>

Integration

2025-05-15T13:21:31Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Integration - SimplyBook.me
|description=Explore SimplyBook.me integrations to connect with external tools and platforms. Enhance your workflow. Learn more here!
|titlemode=append
|keywords=faq, frequently asked questions, online scheduling, free scheduling software, online booking system, online calendar, employee scheduling software, schedule, scheduling software, scheduling app, booking calendar, calendar software
}}
</translate>

<translate>
*<div class="article">[[SBPay.me | SBPay.me]]</div>
*<div class="article">[[Widgets for your own website]]</div>
*<div class="article">[https://simplydemowidgets.mozello.com/ Widget examples]</div>
*<div class="article">[[Bookings on Facebook |Bookings on Facebook and Instagram]]</div>
*<div class="article">[[WordPress_integration | WordPress integration]]</div>
*<div class="article">[[Bookings on Facebook | Facebook CTA button and widget]]</div>
*<div class="article">[[Other Integrations]]</div>
*<div class="article">[[Own domain | Custom Domain]]</div>
</translate>

Catalogue

2025-05-15T13:18:13Z

Tania: Marked this version for translation

<languages/>
<translate>

{{#seo:
|title=Catalogue - SimplyBook.me
|description=Learn about the SimplyBook.me API built on JSON-RPC protocol. Access remote services via HTTPS with JSON-serialized requests!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}
</translate>

<translate>
==General Information== 


SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using JSON. A request is a call to a specific method provided by a remote system. It must contain three certain properties:


* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.


The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.


* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>

Example


<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "Если Вы хотите попробовать себя в роли модели, но не определились с образом. 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>


All calls of public service methods should have additional HTTP header:


* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.
</translate>

<translate>
===Endpoint=== 


Use URL <code>https://user-api.simplybook.me/catalogue</code> for all service API calls listed in [[#Methods|methods section]].

===Authentication=== 


Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> or <code>[[Authentication#getToken|getToken]]</code> API methods on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.

== Methods == 

=== getCategories === 


<code>getCategories()</code>


No arguments.
Returns Array.


Get lsit of ALL categories
</translate>

----
<translate>
=== getCities === 


<code>getCities($country)</code>


Parameters:


* '''$country''' String


Returns Array.


Returns city list as Array order by name
</translate>

----
<translate>
=== getCompanyCount === 


<code>getCompanyCount($filter)</code>


Parameters:


* '''$filter''' Object - filter object


Returns array.


Returns total companies count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
</translate>

----
<translate>
=== getCompanyInfo === 


<code>getCompanyInfo($login)</code>


Parameters:


* '''$login''' String


Returns Object.


Returns company information by company login

</translate>
----
<translate>
=== getCompanyList === 


<code>getCompanyList($filter, $from, $limit)</code>


Parameters:


* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit


Returns array.


Returns companies list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
</translate>

----
<translate>
=== getCompanyMarkers === 


<code>getCompanyMarkers($filter, $bounds, $zoom, $clustering)</code>


Parameters:


* '''$filter''' Object - filter object
* '''$bounds'''
* '''$zoom'''
* '''$clustering'''


Returns array.


Returns company markers$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>
=== getCompanyReviews === 


<code>getCompanyReviews($login)</code>


Parameters:


* '''$login''' String


Returns Object.


Returns company reviews list

</translate>
----
<translate>

=== getCountries === 


<code>getCountries()</code>


No arguments.
Returns Array.


Returns country list as Array order by name

</translate>
----
<translate>

=== getFeedbackList === 


<code>getFeedbackList()</code>


No arguments.
Returns Array.


Get lsit of ALL simplybook feedbacks

</translate>
----
<translate>

=== getPromotionCount === 


<code>getPromotionCount($filter)</code>


Parameters:


* '''$filter''' Object - filter object


Returns array.


Returns total active promotions count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getPromotionInfo === 


<code>getPromotionInfo($id, $feedbackFrom, $feedbackCount)</code>


Parameters:


* '''$id''' Integer
* '''$feedbackFrom''' Integer = 0
* '''$feedbackCount''' Integer = 100


Returns Object.


Returns promotion information by id

</translate>
----
<translate>

=== getPromotionList === 


<code>getPromotionList($filter, $from, $limit)</code>


Parameters:


* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit


Returns array.


Returns active promotion list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getPromotionListByIds === 


<code>getPromotionListByIds($ids)</code>


Parameters:


* '''$ids'''


Returns array.


Returns active promotion list

</translate>
----
<translate>

=== getPromotionReviews === 


<code>getPromotionReviews($promotionId)</code>


Parameters:


* '''$promotionId''' Integer


Returns Object.


Returns promotion reviews list

</translate>
----
<translate>

=== getRecentCompanies === 


<code>getRecentCompanies($count)</code>


Parameters:


* '''$count''' Integer


Returns Array.


Returns list of companies ordered by date DESC

</translate>
----
<translate>

=== getRecentFeedbacks === 


<code>getRecentFeedbacks($count)</code>


Parameters:


* '''$count''' Integer


Returns Array.


Returns list of feedbacs ordered by date DESC

</translate>
----
<translate>

=== getRecentPromotions === 


<code>getRecentPromotions($count)</code>


Parameters:


* '''$count''' Integer


Returns Array.


Returns list of promotions ordered by date DESC

</translate>
----
<translate>

=== getRelatedPromotions === 


<code>getRelatedPromotions($id, $count)</code>


Parameters:


* '''$id''' Integer
* '''$count''' Integer = 10


Returns Array.


Returns related promotions by given promotion id

</translate>
----
<translate>

=== getTags === 


<code>getTags($filter)</code>


Parameters:


* '''$filter''' Object - filter object


Returns Array.


Returns tags list$filter filter params. Object that contains following params
<pre>
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getTopCities === 


<code>getTopCities()</code>


No arguments.
Returns Array.


Returns city list as Array order by company count in city

</translate>
----
<translate>

=== getTopCountries === 


<code>getTopCountries()</code>


No arguments.
Returns Array.


Returns country list as Array order by company count in country
</translate>

Catalogue

2025-05-15T13:14:17Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Catalogue - SimplyBook.me
|description=Learn about the SimplyBook.me API built on JSON-RPC protocol. Access remote services via HTTPS with JSON-serialized requests!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}
</translate>

<translate>
==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using JSON. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.

The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>
Example

<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "Если Вы хотите попробовать себя в роли модели, но не определились с образом. 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>

All calls of public service methods should have additional HTTP header:

* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.
</translate>

<translate>
===Endpoint===

Use URL <code>https://user-api.simplybook.me/catalogue</code> for all service API calls listed in [[#Methods|methods section]].

===Authentication===

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> or <code>[[Authentication#getToken|getToken]]</code> API methods on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.

== Methods ==

=== getCategories ===

<code>getCategories()</code>

No arguments.
Returns Array.

Get lsit of ALL categories
</translate>

----
<translate>
=== getCities ===

<code>getCities($country)</code>

Parameters:

* '''$country''' String

Returns Array.

Returns city list as Array order by name
</translate>

----
<translate>
=== getCompanyCount ===

<code>getCompanyCount($filter)</code>

Parameters:

* '''$filter''' Object - filter object

Returns array.

Returns total companies count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
</translate>

----
<translate>
=== getCompanyInfo ===

<code>getCompanyInfo($login)</code>

Parameters:

* '''$login''' String

Returns Object.

Returns company information by company login

</translate>
----
<translate>
=== getCompanyList ===

<code>getCompanyList($filter, $from, $limit)</code>

Parameters:

* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit

Returns array.

Returns companies list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags
</translate>

----
<translate>
=== getCompanyMarkers ===

<code>getCompanyMarkers($filter, $bounds, $zoom, $clustering)</code>

Parameters:

* '''$filter''' Object - filter object
* '''$bounds'''
* '''$zoom'''
* '''$clustering'''

Returns array.

Returns company markers$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>
=== getCompanyReviews ===

<code>getCompanyReviews($login)</code>

Parameters:

* '''$login''' String

Returns Object.

Returns company reviews list

</translate>
----
<translate>

=== getCountries ===

<code>getCountries()</code>

No arguments.
Returns Array.

Returns country list as Array order by name

</translate>
----
<translate>

=== getFeedbackList ===

<code>getFeedbackList()</code>

No arguments.
Returns Array.

Get lsit of ALL simplybook feedbacks

</translate>
----
<translate>

=== getPromotionCount ===

<code>getPromotionCount($filter)</code>

Parameters:

* '''$filter''' Object - filter object

Returns array.

Returns total active promotions count with specified filter$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getPromotionInfo ===

<code>getPromotionInfo($id, $feedbackFrom, $feedbackCount)</code>

Parameters:

* '''$id''' Integer
* '''$feedbackFrom''' Integer = 0
* '''$feedbackCount''' Integer = 100

Returns Object.

Returns promotion information by id

</translate>
----
<translate>

=== getPromotionList ===

<code>getPromotionList($filter, $from, $limit)</code>

Parameters:

* '''$filter''' Object - filter object
* '''$from''' Integer - from position
* '''$limit''' Integer - rows limit

Returns array.

Returns active promotion list$filter filter params. Object that contains following params
<pre>
'search_string': String,
'service_name': String,
'company_name': String,
'company_address': String,
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String,
'nearby': {
'radius': Integer,
'center': {
'lat': Number,
'lng': NUmber
}
}
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getPromotionListByIds ===

<code>getPromotionListByIds($ids)</code>

Parameters:

* '''$ids'''

Returns array.

Returns active promotion list

</translate>
----
<translate>

=== getPromotionReviews ===

<code>getPromotionReviews($promotionId)</code>

Parameters:

* '''$promotionId''' Integer

Returns Object.

Returns promotion reviews list

</translate>
----
<translate>

=== getRecentCompanies ===

<code>getRecentCompanies($count)</code>

Parameters:

* '''$count''' Integer

Returns Array.

Returns list of companies ordered by date DESC

</translate>
----
<translate>

=== getRecentFeedbacks ===

<code>getRecentFeedbacks($count)</code>

Parameters:

* '''$count''' Integer

Returns Array.

Returns list of feedbacs ordered by date DESC

</translate>
----
<translate>

=== getRecentPromotions ===

<code>getRecentPromotions($count)</code>

Parameters:

* '''$count''' Integer

Returns Array.

Returns list of promotions ordered by date DESC

</translate>
----
<translate>

=== getRelatedPromotions ===

<code>getRelatedPromotions($id, $count)</code>

Parameters:

* '''$id''' Integer
* '''$count''' Integer = 10

Returns Array.

Returns related promotions by given promotion id

</translate>
----
<translate>

=== getTags ===

<code>getTags($filter)</code>

Parameters:

* '''$filter''' Object - filter object

Returns Array.

Returns tags list$filter filter params. Object that contains following params
<pre>
'tag_ids': [Integer, Integer, ...],
'tags': String,
'country_id': String,
'city_id': String
</pre>
Use tag_ids OR tags

</translate>
----
<translate>

=== getTopCities ===

<code>getTopCities()</code>

No arguments.
Returns Array.

Returns city list as Array order by company count in city

</translate>
----
<translate>

=== getTopCountries ===

<code>getTopCountries()</code>

No arguments.
Returns Array.

Returns country list as Array order by company count in country
</translate>

Authentication

2025-05-15T13:11:02Z

Tania: Marked this version for translation

<languages/>
<translate>

{{#seo:
|title=Authentication - SimplyBook.me
|description=Add authentication for secure access to your booking system. Protect client and business data. Learn more about this feature!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
== Methods == 

=== getServiceUrl === 


<code>getServiceUrl($companyLogin)</code>


Parameters:


* '''$companyLogin''' String


Returns String.


Returns API url for given company login

</translate>
----
<translate>
=== getApplicationToken === 


<code>getApplicationToken($applicationApiKey)</code>


Parameters:


* '''$applicationApiKey''' String


Returns String.


Returns an application's token string for an application. You should use this token to authenticate all calls of
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To
get application API key please contact SimplyBook.me support team.

</translate>
----
<translate>
=== getToken === 


<code>getToken($companyLogin, $apiKey)</code>


Parameters:


* '''$companyLogin''' String
* '''$apiKey''' String


Returns String.


Returns an application's token string for a company. You should use this token to authenticate all calls of
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To
get application API key you need to enable [[Custom_Features#API|API Custom Feature]].

</translate>
----
<translate>
=== getUserToken === 


<code>getUserToken($companyLogin, $userLogin, $userPassword)</code>


Parameters:


* '''$companyLogin''' String a company identifier (login)
* '''$userLogin''' String user's login associated with company
* '''$userPassword''' String user's password


Returns String.


Returns an authentication token string for certain user registered for company. You should use this token to
authenticate all calls of [[Company administration service methods|Company administration service API methods]] and
[[Catalogue|Catalogue API methods]].
</translate>

<translate>
==Constants== 

=== Error codes === 


See [[Errors handling]] for details.


* -33001 Company does not exist
* -33002 Wrong API key
* -33003 User with this login and password not found
* -33004 User is blocked
* -33005 You are not allowed to use this application when HIPAA Custom Feature is enabled
</translate>

Authentication

2025-05-15T13:10:48Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Authentication - SimplyBook.me
|description=Add authentication for secure access to your booking system. Protect client and business data. Learn more about this feature!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
== Methods ==

=== getServiceUrl ===

<code>getServiceUrl($companyLogin)</code>

Parameters:

* '''$companyLogin''' String

Returns String.

Returns API url for given company login

</translate>
----
<translate>
=== getApplicationToken ===

<code>getApplicationToken($applicationApiKey)</code>

Parameters:

* '''$applicationApiKey''' String

Returns String.

Returns an application's token string for an application. You should use this token to authenticate all calls of
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To
get application API key please contact SimplyBook.me support team.

</translate>
----
<translate>
=== getToken ===

<code>getToken($companyLogin, $apiKey)</code>

Parameters:

* '''$companyLogin''' String
* '''$apiKey''' String

Returns String.

Returns an application's token string for a company. You should use this token to authenticate all calls of
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To
get application API key you need to enable [[Custom_Features#API|API Custom Feature]].

</translate>
----
<translate>
=== getUserToken ===

<code>getUserToken($companyLogin, $userLogin, $userPassword)</code>

Parameters:

* '''$companyLogin''' String a company identifier (login)
* '''$userLogin''' String user's login associated with company
* '''$userPassword''' String user's password

Returns String.

Returns an authentication token string for certain user registered for company. You should use this token to
authenticate all calls of [[Company administration service methods|Company administration service API methods]] and
[[Catalogue|Catalogue API methods]].
</translate>

<translate>
==Constants==

=== Error codes ===

See [[Errors handling]] for details.

* -33001 Company does not exist
* -33002 Wrong API key
* -33003 User with this login and password not found
* -33004 User is blocked
* -33005 You are not allowed to use this application when HIPAA Custom Feature is enabled
</translate>

Authentication

2025-05-15T13:10:20Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Authentication - SimplyBook.me
|description=Add authentication for secure access to your booking system. Protect client and business data. Learn more about this feature!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
== Methods ==

=== getServiceUrl ===

<code>getServiceUrl($companyLogin)</code>

Parameters:

* '''$companyLogin''' String

Returns String.

Returns API url for given company login

</translate>
----
<translate>
=== getApplicationToken ===

<code>getApplicationToken($applicationApiKey)</code>

Parameters:

* '''$applicationApiKey''' String

Returns String.

Returns an application's token string for an application. You should use this token to authenticate all calls of
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To
get application API key please contact SimplyBook.me support team.

</translate>
----
<translate>
=== getToken ===

<code>getToken($companyLogin, $apiKey)</code>

Parameters:

* '''$companyLogin''' String
* '''$apiKey''' String

Returns String.

Returns an application's token string for a company. You should use this token to authenticate all calls of
[[Company public service methods|Company public service API methods]] and [[Catalogue|Catalogue API methods]]. To
get application API key you need to enable [[Custom_Features#API|API Custom Feature]].

</translate>
----
<translate>
=== getUserToken ===

<code>getUserToken($companyLogin, $userLogin, $userPassword)</code>

Parameters:

* '''$companyLogin''' String a company identifier (login)
* '''$userLogin''' String user's login associated with company
* '''$userPassword''' String user's password

Returns String.

Returns an authentication token string for certain user registered for company. You should use this token to
authenticate all calls of [[Company administration service methods|Company administration service API methods]] and
[[Catalogue|Catalogue API methods]].
</translate>
----
<translate>
==Constants==

=== Error codes ===

See [[Errors handling]] for details.

* -33001 Company does not exist
* -33002 Wrong API key
* -33003 User with this login and password not found
* -33004 User is blocked
* -33005 You are not allowed to use this application when HIPAA Custom Feature is enabled
</translate>

Errors handling

2025-05-15T13:07:49Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Errors handling - SimplyBook.me
|description=Get guidance on managing errors in your SimplyBook.me account. Resolve issues quickly with our troubleshooting tips.
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}
</translate>

<translate>
= Errors handling =

In case of error server returns an object.

<pre>
{
"error" : {
"code" : "-32602",
"message" : "Invalid params"
},
"id" : "2126711093",
"jsonrpc" : "2.0"
}
</pre>

== Error codes ==

* -32001 Plugin is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Additional field values are wrong
* -32080 Appointemnt couldn't be found
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600 : An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found
</translate>

<translate>
== Login API error codes ==

Authentication [https://simplybook.me/api/doc#/login API methods] have different set of errors.

* -33001 Company does not exist
* -33002 Wrong API key
* -33003 User with this login and password not found
* -33004 User is blocked
* -33005 You are not allowed to use this application when HIPAA Plugin is enabled
</translate>

Errors handling

2025-05-15T13:07:12Z

Tania:

<languages/>
<translate>
{{#seo:
|title=Errors handling - SimplyBook.me
|description=Get guidance on managing errors in your SimplyBook.me account. Resolve issues quickly with our troubleshooting tips.
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, plugins, custom features, custom booking page link, domain name, custom domain name, custom url
}}
</translate>

<translate>
= Errors handling =

In case of error server returns an object.

<pre>
{
"error" : {
"code" : "-32602",
"message" : "Invalid params"
},
"id" : "2126711093",
"jsonrpc" : "2.0"
}
</pre>

== Error codes ==

* -32001 Plugin is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Additional field values are wrong
* -32080 Appointemnt couldn't be found
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found
</translate>

<translate>
== Login API error codes ==

Authentication [https://simplybook.me/api/doc#/login API methods] have different set of errors.

* -33001 Company does not exist
* -33002 Wrong API key
* -33003 User with this login and password not found
* -33004 User is blocked
* -33005 You are not allowed to use this application when HIPAA Plugin is enabled
</translate>

Company administration service methods

2025-05-15T12:57:46Z

Tania: Marked this version for translation

<languages/>
<translate>


{{#seo:
|title=Company administration service methods - SimplyBook.me
|description=Learn about service methods for internal company administration. Manage bookings tailored to your operations. Start here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
==General Information== 


SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

</translate>

<translate>


* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.
</translate>

<translate>

The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.


* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>

Example


<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "Если Вы хотите попробовать себя в роли модели, но не определились с образом. 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>
</translate>

<translate>

Example of request with error response:


<pre>
Request
{
"jsonrpc": "2.0",
"method": "someNotExistingMethod",
"params":[],
"id":1
}

Response
{
"jsonrpc": "2.0",
"id":1,
"error": {
"code": -32601,
"message": "Method not found"
}
}
</pre>
</translate>

<translate>

All calls of public service methods should have additional HTTP header:


* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.

===Endpoint=== 


Use URL <code>https://user-api.simplybook.me/admin</code> for all administration service API calls.

===Authentication=== 


Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.

== Methods == 

=== addClient === 


<code>addClient($clientData)</code>


Parameters:


* '''$clientData''' Object


Returns Integer.

</translate>

<translate>


Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id. If client record with specified data exists method will return an id of this record. Otherwise data
will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.Also email, phone number or both of them can be mandatory fields. You should call
<code>getCompanyParam('require_fields')</code> method to check which fields are required.


Method returns an error:


* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong


Example:


{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "FrancesTPerez@teleworm.us",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872
}

</translate>

<translate>

----

=== addDeviceToken === 


<code>addDeviceToken($token, $device)</code>


Parameters:


* '''$token''' String a device token string
* '''$device''' String a device type ('android' or 'apple')


Returns boolean.


Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
changes in already created bookings. Use either <code>'apple'</code> or <code>'android'</code> for <code>device</code>
parameter.


----
</translate>

<translate>

=== book === 


<code>book($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)</code>


Parameters:


* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' string a date string in format 'Y-m-d'
* '''$startTime''' string a time string in format 'H:i:s'
* '''$endDate''' string a date string in format 'Y-m-d'
* '''$endTime''' string a time string in format 'H:i:s'
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.
* '''$count''' Integer bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
* '''$batchId''' Integer add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
* '''$recurringData''' Array - make booking recurrent. (optional)


Returns Object.

</translate>

<translate>


Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>$clientTimeOffset</code> parameter as difference between company's time zone and
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specified). You should specify an <code>$additionalFields</code> parameter if service requires some intake forms (see [[Custom_Features#Intake_Forms|Intake Forms Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>

</translate>

<translate>


If [[Custom_Features#Multiple_Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
to check if Custom feature active and <code>[[#getLocationsList|getLocationsList()]]</code> method to get list of
available locations.


See [[#book response|example]] of <code>book</code> API method response.


See also:


* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

</translate>

----
<translate>

=== calculateEndTime === 


<code>calculateEndTime($startDateTime, $eventId, $unitId)</code>


Parameters:


* '''$startDateTime''' String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
* '''$eventId''' Integer
* '''$unitId''' Integer


Returns String|Boolean.


Returns end datetime if booking is available, else return false


----
</translate>

<translate>

=== cancelBatch === 


<code>cancelBatch($id, $bookingIds)</code>


Parameters:


* '''$id''' Integer identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
* '''$bookingIds''' Array ids of bookings included to batch.


Returns boolean.


Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in <code>$bookingIds</code> list is used for
information in notifications.


----
</translate>

<translate>

=== cancelBooking === 


<code>cancelBooking($id)</code>


Parameters:


* '''$id''' Integer


Returns Boolean.


Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.


----
</translate>

<translate>

=== createBatch === 


<code>createBatch()</code>


No arguments.
Returns Integer.


Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[#book|book]]</code>
API method.


----
</translate>

<translate>

=== deleteDeviceToken === 


<code>deleteDeviceToken($token)</code>


Parameters:


* '''$token''' String - device token


Returns boolean.


Unsubscribe from push notifications service.


----
</translate>

<translate>

=== editBook === 


<code>editBook($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)</code>


Parameters:


* '''$shedulerId''' Integer an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' String - in Y-m-d format
* '''$startTime''' String - in H:i:s format
* '''$endDate''' String - in Y-m-d format
* '''$endTime''' String - in H:i:s format
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.


Returns Object.


Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.


----
</translate>

<translate>

=== editClient === 


<code>editClient($clientId, $clientData)</code>


Parameters:


* '''$clientId''' Integer
* '''$clientData''' Object


Returns Integer.


Edits client's record. See <code>[[#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.


----
</translate>

<translate>

=== filterAvailableUnits === 


<code>filterAvailableUnits($eventId, $dateTime, $unitIds, $count)</code>


Parameters:


* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$unitIds'''
* '''$count''' Integer


Returns Array.


Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom Feature.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>


----
</translate>

<translate>

=== getAdditionalFields === 


<code>getAdditionalFields($eventId)</code>


Parameters:


* '''$eventId''' Integer


Returns Array.


Return intake forms for certain event if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.


----
</translate>

<translate>

=== getAnyUnitData === 


<code>getAnyUnitData()</code>


No arguments.
Returns Object|null.


Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}


----
</translate>

<translate>

=== getAvailableTimeIntervals === 


<code>getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>


Parameters:


* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer


Returns Object.


Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: <code>{['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}</code>


----
</translate>

<translate>

=== getAvailableUnits === 


<code>getAvailableUnits($eventId, $dateTime, $count)</code>


Parameters:


* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$count''' Integer


Returns Array.


Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: <code>[1, 2, 3]</code>


----

</translate>

<translate>

=== getBookingCancellationsInfo === 


<code>getBookingCancellationsInfo($dateStart, $dateEnd)</code>


Parameters:


* '''$dateStart''' String a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
* '''$dateEnd''' String a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.


Returns Array.


Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. <code>"type"</code> field can be either
"create", "cancel" or "nopayment_cancel". If <code>"user_id"</code> not specified then bookings where created or
cancelled by admin or employee. Data with type <code>"nopayment_cancel"</code> represents bookings cancelled
automatically by system.Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]


----

</translate>

<translate>

=== getBookingComment === 


<code>getBookingComment($id)</code>


Parameters:


* '''$id''' Integer


Returns String.


Returns booking comment


----
</translate>

<translate>

=== getBookingDetails === 


<code>getBookingDetails($id)</code>


Parameters:


* '''$id''' integer booking id


Returns Array.


Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].


----
</translate>

<translate>

=== getBookingLimitUnavailableTimeInterval === 


<code>getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)</code>


Parameters:


* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$eventId''' integer


Returns Array.


Returns time intervals not available for bookings because of configuration of [[Custom_Features#Limit_Bookings|Limit bookings]]
Custom Feature for period of time. Returns empty array if Custom Feature not available.


----
</translate>

<translate>

=== getBookingRevenue === 


<code>getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)</code>


Parameters:


* '''$dateStart''' string a date string in format 'Y-m-d'.
* '''$dateEnd''' string a date string in format 'Y-m-d'
* '''$unitGroupId''' integer
* '''$serviceId''' integer


Returns Array.


Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either
by unit or by service. Set <code>$dateStart</code> and <code>$dateEnd</code> to null to get data for current week.Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}


----
</translate>

<translate>

=== getBookingStats === 


<code>getBookingStats($groupBy)</code>


Parameters:


* '''$groupBy''' String either 'day', 'week' or 'month'


Returns Array.


Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months


----
</translate>

<translate>

=== getBookings === 


<code>getBookings($params)</code>


Parameters:


* '''$params'''


Returns Array.


Returns list of bookings filtered by given params. Filter params represented as object with following fields:* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking Custom Feature status.
*: If Custom Feature not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If Custom Feature active:
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)


Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}


----
</translate>

<translate>

=== getBookingsZapier === 


<code>getBookingsZapier()</code>


No arguments.
Returns Array.


Returns list of bookings filtered by given params


----
</translate>

<translate>

=== getCategoriesList === 


<code>getCategoriesList($isPublic)</code>


Parameters:


* '''$isPublic''' Boolean


Returns Array.


Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.


----

</translate>

<translate>

=== getClient === 


<code>getClient($clientId)</code>


Parameters:


* '''$clientId'''


Returns Array.


Returns client's data object. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.


----

</translate>

<translate>

=== getClientComments === 


<code>getClientComments($clientId, $shedulerId)</code>


Parameters:


* '''$clientId''' Integer
* '''$shedulerId''' Integer


Returns Array.


Returns list of all comments for given client


----

</translate>

<translate>

=== getClientList === 


<code>getClientList($searchString, $limit)</code>


Parameters:


* '''$searchString''' String
* '''$limit''' Integer


Returns Array.


Returns list of clients associated with company. You can use either phone number, email address or name as value
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
parameters to get all records. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.


----

</translate>

<translate>

=== getCompanyCurrency === 


<code>getCompanyCurrency()</code>


No arguments.
Returns String.


Returns company's currency as three chars code (ISO 4217).


----
</translate>

<translate>

=== getCompanyInfo === 


<code>getCompanyInfo()</code>


No arguments.
Returns Object.


Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].


----

</translate>

<translate>

=== getCompanyParam === 


<code>getCompanyParam($key)</code>


Parameters:


* '''$key''' String


Returns mixed.


Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].


----

</translate>

<translate>

=== getCompanyParams === 


<code>getCompanyParams($keys)</code>


Parameters:


* '''$keys''' Array


Returns Array.


Returns company config values for keys. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].For non-existent and not-allowed params it will return false as result


----

</translate>

<translate>

=== getCompanyTimezoneOffset === 


<code>getCompanyTimezoneOffset()</code>


No arguments.
Returns array.


Returns company timezone offset and company timezone


----

</translate>

<translate>

=== getCountryList === 


<code>getCountryList()</code>


No arguments.
Returns Array.


Get list of all countries


----

</translate>

<translate>

=== getCountryPhoneCodes === 


<code>getCountryPhoneCodes()</code>


No arguments.
Returns Array.


Returns country phone code list


----

</translate>

<translate>

=== getCurrentTariffInfo === 


<code>getCurrentTariffInfo()</code>


No arguments.
Returns Array.


Returns all information about current tariff (subscription). For example:{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}


----

</translate>

<translate>

=== getCurrentUserDetails === 


<code>getCurrentUserDetails()</code>


No arguments. Returns Object.


Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on <code>group</code> property value. Most of API methods returns an error if user has low access
rights but not all. There are 4 roles:


* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode


<code>group</code> property can be one of the values:


* <code>shop_user</code> - "Senior Employee" access role
* <code>station_user</code> - "Junior Employee" access role
* <code>admin</code> - "Administrator" access role
* <code>viewer</code> - "Viewer" access role
* <code>reseller_company_admin</code> - reserved


Example:


{
"id": 1,
"login": admin,
"email": "admin@mycoolcompany.com";
"firstname": "Michail",
"lastname": " ",
"phone": "",
"group": "admin",
"is_blocked": 0,
"last_access_time": "2016-06-06 17:55:51",
"unit_group_id": null
}


----

</translate>

<translate>

=== getEventList === 


<code>getEventList($isVisibleOnly, $asArray)</code>


Parameters:


* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean


Returns Array.


Returns company's events list. If <code>$asArray</code> is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
event's details object.


----

</translate>

<translate>

=== getFeedbacks === 


<code>getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)</code>


Parameters:


* '''$approvedOnly''' Boolean
* '''$reviewsOnly''' Boolean
* '''$lastOnly''' Boolean
* '''$limit''' Integer


Returns Array.


Get list of feedbacks


----

</translate>

<translate>

=== getFirstWorkingDay === 


<code>getFirstWorkingDay($unitId)</code>


Parameters:


* '''$unitId''' Integer


Returns String.


Returns first working date for unit


----

</translate>

<translate>

=== getGoogleCalendarBusyTime === 


<code>getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)</code>


Parameters:


* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in
this parameter. In this case method will use time value '23:59:59'.
* '''$unitId''' integer


Returns Array.


Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
be returned. You should call <code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.Example:
<code>
[
{"from" : "2016-02-16 13:30:00",
"to" : "2016-02-16 16:00:00"},
...
]
</code>


----

</translate>

<translate>

=== getGoogleCalendarBusyTimeAvailableUnits === 


<code>getGoogleCalendarBusyTimeAvailableUnits()</code>


No arguments.
Returns Array.


Returns configured unit ids, allowed to sync busy time


----
</translate>

<translate>

=== getLastNotificationUpdate === 


<code>getLastNotificationUpdate($type)</code>


Parameters:


* '''$type''' String


Returns String.


Returns last update datetime


----

</translate>

<translate>

=== getLocationsList === 


<code>getLocationsList($isPublic, $asArray)</code>


Parameters:


* '''$isPublic''' Boolean Optional. Default value is '''false'''.
* '''$asArray''' boolean Optional. Default value is '''false'''.


Returns Array.


Returns available locations for company if Custom Feature [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.


This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.


----
</translate>

<translate>

=== getPluginList === 


<code>getPluginList()</code>


No arguments.
Returns Array.


Returns a list of all Custom Features associated with company with status.


----

</translate>

<translate>



<code>getPluginPromoInfoByCode($code)</code>


Parameters:


* '''$code'''


Returns Array.


Returns an object with detailed information about Rewards and referrals promotion by promotion code. You can get promotion code
using <code>[[Catalogue#getPromotionList|getPromotionList]]</code> API method. If promotion record with specified code not found then method returns an empty array (an empty object). If [[Rewards_and_Referrals_custom_feature|Rewards and Referrals Custom Feature]]
not enabled then method returns an error with code -32001 (Custom Feature is not activated). Use
<code>[[#isPluginActivated|isPluginActivated('promo')]]</code> API method call to check if Custom Feature enabled. See [[#getPromotionList response|example]] of <code>getPromotionList</code> API method response. Please note that
response contains a list of services for wich promotion discount can be applied (<code>service_ids</code> key).
--->

</translate>

----

<translate>

=== getPluginStatuses === 


<code>getPluginStatuses($pluginNames)</code>


Parameters:


* '''$pluginNames''' Array


Returns Array.


Return Custom Feature status true if status active, else false. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== getRecentActions === 


<code>getRecentActions($lastOnly, $limit)</code>


Parameters:


* '''$lastOnly''' Boolean
* '''$limit''' Integer


Returns Array.


Returns latest actions

</translate>

----

<translate>

=== getRecurringDatetimes === 


<code>getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData, $endDateTime)</code>


Parameters:


* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String
* '''$time''' String
* '''$recurringData''' Array
* '''$endDateTime''' String (optional)


Returns Array.


Get list of dates for recurring booking

</translate>

----

<translate>

=== getRecurringSettings === 


<code>getRecurringSettings($eventId)</code>


Parameters:


* '''$eventId''' Integer


Returns Array.


Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.


See also:


* [http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription]

</translate>

----

<translate>

=== getRegistrations === 


<code>getRegistrations($groupBy)</code>


Parameters:


* '''$groupBy''' String either 'day', 'week' or 'month'


Returns Array.


Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getReservedTime === 


<code>getReservedTime($from, $to, $eventId, $unitId, $count)</code>


Parameters:


* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$count''' Integer


Returns Object.


Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom_Features#Calendar_Sync| Calendar Sync Custom Feature]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.


Example:
<pre>
{
"2016-02-05": [
{
"dd": [], // time slots from Google calendar
"events": [ // reserved time slots
{ "from": "16:00", "to": "16:30" },
{ "from": "16:30", "to": "17:00" },
... ],
"type": "reserved_time",
},
{
"events": [
{ "from": "09:00", "to": "09:30" },
{ "from": "09:30", "to": "10:00" },
... ],
"type": "not_worked_time"
}],
...
}
</pre>

</translate>

----

<translate>

=== getReservedTimeIntervals === 


<code>getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>


Parameters:


* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Integer|Array
* '''$count''' Integer


Returns Object.


Returns not available time
Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

</translate>

----

<translate>

=== getSocialCounterStats === 


<code>getSocialCounterStats($provider)</code>


Parameters:


* '''$provider''' String


Returns Integer.


Returns social counters value for your domain

</translate>

----

<translate>

=== getStartTimeMatrix === 


<code>getStartTimeMatrix($from, $to, $eventId, $unitId, $count)</code>


Parameters:


* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer


Returns Object.


Returns available start time, taking into account breaktimes, start and end working time
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>


If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom_Features#Multiple_Locations|Multiple locations]] Custom Feature description for
more details.

</translate>

----

<translate>

=== getStatuses === 


<code>getStatuses()</code>


No arguments.
Returns Array.


Returns list of available statuses or an empty list if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== getTimeframe === 


<code>getTimeframe()</code>


No arguments.
Returns Integer.


Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need_to_change_interval_(timeframe)|here]].

</translate>

----

<translate>

=== getTimelineType === 


<code>getTimelineType()</code>


No arguments.
Returns String.


Returns company calendar layout type

</translate>

----

<translate>

=== getTopPerformers === 


<code>getTopPerformers()</code>


No arguments.
Returns Array.


Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

</translate>

----

<translate>

=== getTopServices === 


<code>getTopServices($dateStart, $dateEnd)</code>


Parameters:


* '''$dateStart''' String
* '''$dateEnd''' String


Returns Array.


Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.

</translate>

----

<translate>

=== getUnitList === 


<code>getUnitList($isVisibleOnly, $asArray)</code>


Parameters:


* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean


Returns Array.


Returns list of service performers. If <code>$asArray</code> is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
of event's details object.

</translate>

----

<translate>

=== getUnitWorkdayInfo === 


<code>getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)</code>


Parameters:


* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer


Returns Array.


Return workday info (date_start and date_end)

</translate>

----

<translate>

=== getUnitWorkingDurations === 


<code>getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)</code>


Parameters:


* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer


Returns Array.


Return working durations

</translate>

----

<translate>

=== getVisitorStats === 


<code>getVisitorStats($groupBy)</code>


Parameters:


* '''$groupBy''' String


Returns Array.


Returns statistics about page visits if Custom Feature [[Custom_Features#Visitor_Counter|Visitor Counter Custom Feature]] enabled. Returns
an empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('counter')]]</code> API method
call to check if Custom Feature enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getWarnings === 


<code>getWarnings($lastOnly)</code>


Parameters:


* '''$lastOnly''' Boolean. Default value is '''false'''.


Returns Array.


Returns a list of objects represented system warnings. Each warning contains <code>warning_type</code> and <code>warning_text</code>
properties. <code>warning_text</code> property contains localized message. <code>warning_type</code> can be one of the values:


* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings

</translate>

----

<translate>

=== getWorkCalendar === 


<code>getWorkCalendar($year, $month, $unitId)</code>


Parameters:


* '''$year''' Integer
* '''$month''' Integer
* '''$unitId''' Integer


Returns Object.


Returns company work schedule as array
Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

</translate>

----

<translate>

=== getWorkDaysInfo === 


<code>getWorkDaysInfo($from, $to, $unitId, $eventId, $count)</code>


Parameters:


* '''$from''' String
* '''$to''' String
* '''$unitId''' Integer (optional)
* '''$eventId''' Integer (optional)
* '''$count''' Integer (optional)


Returns Object.


Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from
service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:<pre>
{'2014-05-14' : [
{'from': '09:00:00', 'to': '13:00:00'},
{'from': '14:00:00', 'to': '19:00:00'}
] }
</pre>


Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.

</translate>

----

<translate>

=== getWorkDaysTimes === 


<code>getWorkDaysTimes($startDateTime, $endDateTime, $type = 'unit_group')</code>


Parameters:


* '''$startDateTime''' string
* '''$endDateTime''' string
* '''$type''' string. Optional. Either 'unit_group' or 'event'.


Returns Array.


Return busy time by unit id by Calendar Sync Custom Feature if enabled. Please note that this method may return not actual data because data synchronization between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.

</translate>

----

<translate>

=== getWorkload === 


<code>getWorkload($dateStart, $dateEnd, $unitGroupId)</code>


Parameters:


* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer


Returns Array.


Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]

</translate>

----

<translate>

=== isPluginActivated === 


<code>isPluginActivated($pluginName)</code>


Parameters:


* '''$pluginName''' String


Returns Boolean.


Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom_Features|Custom Features]] page for full Custom Features description. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== pluginApproveBookingApprove === 


<code>pluginApproveBookingApprove($id)</code>


Parameters:


* '''$id''' Integer


Returns Array.


Sets approve booking status to 'approved' if [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled and returns
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveBookingCancel === 


<code>pluginApproveBookingCancel($id)</code>


Parameters:


* '''$id''' Integer


Returns Boolean.


Sets approve booking status to 'canceled' if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled and returns
true. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookings === 


<code>pluginApproveGetPendingBookings()</code>


No arguments.
Returns array.


Returns list of objects with information about bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]]
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookingsCount === 


<code>pluginApproveGetPendingBookingsCount()</code>


No arguments.
Returns Integer.


Returns count of bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled. Returns
0 if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
call to check if Custom Feature enabled.

</translate>

----

<translate>

=== setBookingComment === 


<code>setBookingComment($id, $comment)</code>


Parameters:


* '''$id''' Integer
* '''$comment''' String


Returns Integer.


Set booking comment

</translate>

----

<translate>

=== getBookingStatus === 


<code>getBookingStatus ($bookingId)</code>


Parameters:


* '''$bookingId''' Integer


Returns Array.


Returns an object of status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists

</translate>

----

<translate>

=== setStatus === 


<code>setStatus($bookingId, $statusId)</code>


Parameters:


* '''$bookingId''' Integer
* '''$statusId''' Integer


Returns Boolean.


Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== updateNotification === 


<code>updateNotification($type)</code>


Parameters:


* '''$type''' String


Returns .


Mark notifications as readed

</translate>

----

<translate>

=== setWorkDayInfo=== 


<code>setWorkDayInfo($info)</code>


Parameters:


* '''$info''' Array


Returns true on success


Set work day schedule for company|service|provider for week_day|date


Example:
<pre>
{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}


index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company
</pre>

</translate>

----

<translate>

=== deleteSpecialDay=== 


<code>deleteSpecialDay($date, $params = null)</code>


Parameters:


* '''$date''' String
* '''$params''' Array


Returns true on success


Delete special date if set


Example:
<pre>
'2017-08-21',
{
"unit_group_id":"",
"event_id":""
}
</pre>

</translate>

----

<translate>

=== addServiceProvider=== 


<code>addServiceProvider($data)</code>


Parameters:


* '''$data''' Array


Returns Array with result and id of new service provider (unit_group)


Create new service provider


Example:
<pre>
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

</translate>

----

<translate>

=== editServiceProvider=== 


<code>editServiceProvider($id, $data)</code>


Parameters:


* '''$id''' Integer
* '''$data''' Array


Returns Array with result and id of new service provider (unit_group)


Edit service provider
(there is no way to delete provider via API, in this case set is_active = 0)


Example:
<pre>
1,
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>


-
</translate>

----

<translate>

== Constants == 

=== Error codes === 


See [[Errors handling]] for details.


* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32015 Passed event id is not reccuren
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Intake form values are wrong
* -32080 Appointemnt couldn't be found
* -32081 Service can't be performed when company does not work
* -32082 Service performer can't work when company does not work
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found

</translate>

----

<translate>

===Company params=== 


Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.

=====General params===== 


Administration API inherits all [[Company public service methods#Company_params|keys]] allowed for public API and extends this list with keys:


* attach_ical
* auto_redirect
* auto_redirect_text
* blockchain_address
* blockchain_secret
* borgun_merchant_id
* borgun_payment_gateway_id
* borgun_secret_code
* client_batch_cancel_template
* client_batch_cancel_template_email
* client_batch_cancel_template_email_subject
* client_event_cancel_template
* client_event_cancel_template_email
* client_event_cancel_template_email_subject
* client_event_change_template
* client_event_change_template_email
* client_event_change_template_email_subject
* client_event_creation_template
* client_event_creation_template_email
* client_event_creation_template_email_subject
* client_event_group_creation_template
* client_event_group_creation_template_email
* client_event_group_creation_template_email_subject
* client_event_multiple_creation_template
* client_event_multiple_creation_template_email
* client_event_multiple_creation_template_email_subject
* client_group_notification_template
* client_group_notification_template_email
* client_group_notification_template_email_subject
* client_multiple_notification_template
* client_multiple_notification_template_email
* client_multiple_notification_template_email_subject
* client_notification_template
* client_notification_template_email
* client_notification_template_email_subject
* client_notification_time
* client_recurring_event_creation_template
* client_recurring_event_creation_template_email
* client_recurring_event_creation_template_email_subject
* common_limit_booking
* company_ga_tracking_id
* default_phone
* disconnect_on_timeout
* email_event_list
* email_events_list_template
* email_group_events_list_template
* event_list_style
* feed_back_interval
* feedback_invite_template_email
* feedback_invite_template_email_subject
* google_conversion_color
* google_conversion_currency
* google_conversion_format
* google_conversion_id
* google_conversion_label
* google_conversion_language
* google_conversion_value
* hide_working_hours_block
* include_cancel_link
* kortais_merchant
* kortais_secret_code
* kortais_terminal
* layout_background
* layout_background_repeat
* mobile_site_link
* mobile_site_link_title
* no_show_period
* on_success_button_link
* on_success_button_text
* recap_interval
* recap_send_after_time
* recap_send_canceled_bookings
* recap_send_new_bookings
* recap_send_upcomming_bookings
* send_cancel_to_client
* send_cancel_to_client_email
* send_cancel_to_unit
* send_cancel_to_unit_email
* send_contact_widget_email_notification
* send_contact_widget_sms_notification
* send_notify_to_client
* send_notify_to_client_email
* send_notify_to_unit
* send_notify_to_unit_email
* send_onchange_to_client
* send_onchange_to_client_email
* send_onchange_to_unit
* send_onchange_to_unit_email
* send_oncreate_to_client
* send_oncreate_to_client_email
* send_oncreate_to_unit
* send_oncreate_to_unit_email
* send_sms_if_push_enabled
* site_link
* site_link_title
* skip_limits_for_admin
* skip_show_mobile_app_ads
* skip_show_on_success_button
* sms_event_list
* sms_events_list_template
* sms_group_events_list_template
* unit_batch_cancel_template
* unit_batch_cancel_template_email
* unit_batch_cancel_template_email_subject
* unit_event_cancel_template
* unit_event_cancel_template_email
* unit_event_cancel_template_email_subject
* unit_event_change_template
* unit_event_change_template_email
* unit_event_change_template_email_subject
* unit_event_creation_template
* unit_event_creation_template_email
* unit_event_creation_template_email_subject
* unit_event_group_creation_template
* unit_event_group_creation_template_email
* unit_event_group_creation_template_email_subject
* unit_group_notification_template
* unit_group_notification_template_email
* unit_group_notification_template_email_subject
* unit_notification_template
* unit_notification_template_email
* unit_notification_template_email_subject
* unit_notification_time
* unit_recurring_event_creation_template
* unit_recurring_event_creation_template_email
* unit_recurring_event_creation_template_email_subject
* use_common_client_db
* user_confirmation
* user_public_layout
* user_public_theme
* waiting_video

</translate>

----

<translate>

=====Accept payments Custom Feature params===== 


Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].


* allow_delay_payment
*: Allow delay payment option. Boolean.
* company_currency
*:
* hide_sale_tax
*: Hide sales tax option. Boolean.
* payment_timeout
*: Payment timeout option. String ("5 minutes", "1 hour", ...)
* sale_tax
*: Sales tax option. Integer. You should divide by 100 to get percent value.
* paypal_account
*: PayPal payment processor configuration. String.
* skrill_account
*: Skrill payment processor configuration parameter. String.
* skrill_secret
*: Skrill payment processor configuration parameter. String.
* zooz_app_id
*: ZooZ payment processor configuration parameter. String.
* zooz_app_key
*: ZooZ payment processor configuration parameter. String.
* dwolla_application_key
*: Dwolla payment processor configuration parameter. String.
* dwolla_id
*: Dwolla payment processor configuration parameter. String.
* dwolla_secret_key
*: Dwolla payment processor configuration parameter. String.
* liqpay_merchant_id
* liqpay_merchant_pass

</translate>

----

<translate>

=====Term & Conditions Custom Feature params===== 


Read more about [[Custom_Features#Terms_and_Conditions|Terms and Conditions Custom Feature]].


* user_license_text
*: Terms and conditions text. String.

</translate>

----

<translate>

===Custom Features' identifiers=== 


Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[#isPluginActivated|isPluginActivated]]</code> and <code>[[#getPluginStatuses|getPluginStatuses]]</code> API methods.


* advanced_notification
*:Book Soon notification system
* any_unit
*:Any Employee selector
* api
*:API
* approve_booking
*:Approve booking
* back_to_site
*:Take me back home
* contact_widget
*:Contact widget
* counter
*:Visitor Counter
* custom_css
*:Custom CSS
* data_security
*:Clean history
* description
*:HTML description field for events
* event_category
*:Service categories
* event_field
*:Intake forms
* facebookImage
*:Facebook client info
* financial_dashboard
*:Insights
* google_analytics
*:Google Adwords and analytics
* google_calendar_export
*:Calendar sync
* group_booking
*:Group bookings
* hipaa
*:HIPAA
* limit_bookings
*:Limit bookings
* location
*:Multiple locations
* mobile_app_backend
*:Mobile application
* multiple_booking
*:Multiple bookings
* news
*:News
* paid_events
*:Accept payments

* recap
*:Daily report
* secure
*:SSL
* status
*:Status
* unit_colors
*:Providers color coding
* user_license
*:Terms and conditions
* cancelation_policy
*:Cancellation Policy


See [[Custom_Features|Custom Features]] page for description for each Custom Feature.

</translate>

<translate>
== Examples == 

====getBookingDetails response==== 


An example of data returned by [[#getBookingDetails|getBookingDetails]] API method.


{
"id": "321",
"event_id": "5",
"event_name": "Massage",
"unit_id": "3",
"unit_name": "John",
"client_id": "1",
"client_name": "Bob",
"start_date_time": "2015-11-25 15:00:00",
"end_date_time": "2015-11-25 16:00:00",
"is_confirmed": "1",
"code": "h8v8w5ls",
"record_date": "2015-11-19 04:06:38",
"comment": null,
"company_login": "testzt",
"company_name": "My Cool Company",
"company_phone": "+1-555-55-55",
"company_email": "into@mycoolcompany.com",
"additional_fields": [{
"value": "on",
"field_name": "201a89517de509f6b3a60858918faac3",
"field_title": "Include washing",
"field_position": "4",
"field_type": "checkbox",
"field_id": "4"
}],
"comments": [],
"history": [{
"id": "536",
"sheduler_id": "321",
"datetime": "2015-11-19 11:06:38",
"type": "create",
"user_id": "1",
"agent": "SimplyBook.me\/55 CFNetwork\/758.0.2 Darwin\/15.0.0",
"ip": "213.174.0.53, 158.69.224.50:127.0.0.1",
"referer": "",
"login": "admin",
"firstname": "Mikhail",
"lastname": ""
}],
"status": {
"id": "3",
"name": "Fancy Status",
"description": null,
"color": "4cbadb",
"is_default": "1"
},
"location": {
"id": "1",
"title": "location",
"description": null,
"picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
"address1": null,
"address2": "Saint Margaret Street",
"city": "\u041b\u043e\u043d\u0434\u043e\u043d",
"zip": null,
"country_id": "GB",
"lat": "51.50013000000000000000",
"lng": "-0.12630500000000000000",
"phone": "44",
"position": "1",
"is_default": "1"
},
"price": [],
"promo": false
}

</translate>

<translate>


Location field is present in response only if [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.


Status field is present in response only if [[Custom_Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.


Price field is present in response only if [[Custom_Features#Accept_Payments|Accept payments Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a free service.



<code>additional_fields</code> field is present in response only if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a service with no intake forms.

</translate>

----

<translate>

====book response==== 


[[#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.


{
"require_confirm":false,
"bookings":[
{
"id":"434",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-30 13:00:00",
"end_date_time":"2015-12-30 13:30:00",
"is_confirmed":"1",
"code":"h8vc14ca",
"hash":"785cb8cce316e64765b94c05a635f4be"
},
{
"id":"435",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-31 13:00:00",
"end_date_time":"2015-12-31 13:30:00",
"is_confirmed":"1",
"code":"h8vc2pge",
"hash":"8b92d634541bfd93c0830967e56f4653"
},
{
"id":"436",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-04 13:00:00",
"end_date_time":"2016-01-04 13:30:00",
"is_confirmed":"1",
"code":"h8vc3urb",
"hash":"cd22a0bf183f7350e595988dd2486e5b"
},
{
"id":"437",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-05 13:00:00",
"end_date_time":"2016-01-05 13:30:00",
"is_confirmed":"1",
"code":"h8vc44d9",
"hash":"53f98ff4e4a0323aa907156c59c99362"
}
],
"batch_type":"batch_recurrent_booking",
"recurrent_batch_id":"1",
"batch_hash":"357178bce290381bb7235080941ec143"
}

</translate>

----

<translate>

====getCompanyInfo response==== 


An example of data returned by [[#getCompanyInfo|getCompanyInfo]] API method.


{
"login": "pierrecoetzee",
"name": "Pierre",
"description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"address1": "",
"address2": "Storey's Gate, ",
"city": "London",
"country_id": "GB",
"lat": "51.500435",
"lng": "-0.129811",
"email": "pierre.coe@gmail.com",
"phone": "",
"web": null,
"skip_address": null,
"logo": null,
"address": "GB, London, Storey's Gate, ",
"description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"timezone": "Europe London",
"show_in_client_timezone": false,
"timeframe": "60",
"timeline_type": "modern_week",
"allow_event_day_break": "0",
"allow_event_breaktime_break": "0"
}


<code>timeline_type</code> field can be one the following values:


* flexible
* modern
* flexible_week
* modern_week
* classic
* classes

</translate>

<translate>

Please note that <code>classic</code> timeline type is deprecated and not supported anymore.


<code>description</code> field contains raw data of company's description which can include HTML tags. <code>description_text</code> field contains only text information without HTML tags.


For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params|Company params section]].

</translate>
----

<translate>



{
"id": "1",
"title": "[service\/services] with [discount]% discount!",
"code": "yvuvugum",
"description": "We are offering [service\/services] with an amazing [discount]% discount! We are running this deal for a limited time only.",
"discount": "99.9999",
"start_date": "2015-12-23",
"expired_date": "2016-01-23",
"sheduler_start_date": "2015-12-23",
"sheduler_end_date": "2015-12-31",
"sheduler_start_time": "09:00:00",
"sheduler_end_time": "22:30:00",
"allow_usage_count": "20",
"fineprint_text": "Deal is limited for new clients only. Reward is claimable [client_claim_times_number] times per client. Deal is only claimable for the locations specified. Deal is cannot be combined with any other promotion. Must be redeemed prior to the expiration date shown on the deal.",
"redemption_text": "Present your confirmation code when you want to redeem your deal. You may either to print off your confirmation email or show your confirmation code by loggin into Simplybook on your mobile phone\/Pc.\r\n[promocode]\r\n[discount]\r\n[reward]\r\n[referal_qty]",
"headline": "[service\/services] with [discount]% discount!",
"image": null,
"allow_customer_count": "1",
"show_in_catalogue": "1",
"status": "active",
"plugin_promo_message_id": "1",
"common_promotion_id": "132",
"service_ids": ["1"]
}


<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
</translate>

Company administration service methods

2025-05-15T12:56:49Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Company administration service methods - SimplyBook.me
|description=Learn about service methods for internal company administration. Manage bookings tailored to your operations. Start here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

</translate>

<translate>

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.
</translate>

<translate>
The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>
Example

<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "Если Вы хотите попробовать себя в роли модели, но не определились с образом. 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>
</translate>

<translate>
Example of request with error response:

<pre>
Request
{
"jsonrpc": "2.0",
"method": "someNotExistingMethod",
"params":[],
"id":1
}

Response
{
"jsonrpc": "2.0",
"id":1,
"error": {
"code": -32601,
"message": "Method not found"
}
}
</pre>
</translate>

<translate>
All calls of public service methods should have additional HTTP header:

* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.

===Endpoint===

Use URL <code>https://user-api.simplybook.me/admin</code> for all administration service API calls.

===Authentication===

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.

== Methods ==

=== addClient ===

<code>addClient($clientData)</code>

Parameters:

* '''$clientData''' Object

Returns Integer.

</translate>

<translate>

Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id. If client record with specified data exists method will return an id of this record. Otherwise data
will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.Also email, phone number or both of them can be mandatory fields. You should call
<code>getCompanyParam('require_fields')</code> method to check which fields are required.

Method returns an error:

* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong

Example:

{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "FrancesTPerez@teleworm.us",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872
}

</translate>

<translate>
----

=== addDeviceToken ===

<code>addDeviceToken($token, $device)</code>

Parameters:

* '''$token''' String a device token string
* '''$device''' String a device type ('android' or 'apple')

Returns boolean.

Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
changes in already created bookings. Use either <code>'apple'</code> or <code>'android'</code> for <code>device</code>
parameter.

----
</translate>

<translate>

=== book ===

<code>book($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' string a date string in format 'Y-m-d'
* '''$startTime''' string a time string in format 'H:i:s'
* '''$endDate''' string a date string in format 'Y-m-d'
* '''$endTime''' string a time string in format 'H:i:s'
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.
* '''$count''' Integer bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
* '''$batchId''' Integer add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
* '''$recurringData''' Array - make booking recurrent. (optional)

Returns Object.

</translate>

<translate>

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>$clientTimeOffset</code> parameter as difference between company's time zone and
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specified). You should specify an <code>$additionalFields</code> parameter if service requires some intake forms (see [[Custom_Features#Intake_Forms|Intake Forms Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>

</translate>

<translate>

If [[Custom_Features#Multiple_Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
to check if Custom feature active and <code>[[#getLocationsList|getLocationsList()]]</code> method to get list of
available locations.

See [[#book response|example]] of <code>book</code> API method response.

See also:

* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

</translate>

----
<translate>

=== calculateEndTime ===

<code>calculateEndTime($startDateTime, $eventId, $unitId)</code>

Parameters:

* '''$startDateTime''' String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
* '''$eventId''' Integer
* '''$unitId''' Integer

Returns String|Boolean.

Returns end datetime if booking is available, else return false

----
</translate>

<translate>

=== cancelBatch ===

<code>cancelBatch($id, $bookingIds)</code>

Parameters:

* '''$id''' Integer identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
* '''$bookingIds''' Array ids of bookings included to batch.

Returns boolean.

Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in <code>$bookingIds</code> list is used for
information in notifications.

----
</translate>

<translate>

=== cancelBooking ===

<code>cancelBooking($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.

----
</translate>

<translate>

=== createBatch ===

<code>createBatch()</code>

No arguments.
Returns Integer.

Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[#book|book]]</code>
API method.

----
</translate>

<translate>

=== deleteDeviceToken ===

<code>deleteDeviceToken($token)</code>

Parameters:

* '''$token''' String - device token

Returns boolean.

Unsubscribe from push notifications service.

----
</translate>

<translate>

=== editBook ===

<code>editBook($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)</code>

Parameters:

* '''$shedulerId''' Integer an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' String - in Y-m-d format
* '''$startTime''' String - in H:i:s format
* '''$endDate''' String - in Y-m-d format
* '''$endTime''' String - in H:i:s format
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.

Returns Object.

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.

----
</translate>

<translate>

=== editClient ===

<code>editClient($clientId, $clientData)</code>

Parameters:

* '''$clientId''' Integer
* '''$clientData''' Object

Returns Integer.

Edits client's record. See <code>[[#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.

----
</translate>

<translate>

=== filterAvailableUnits ===

<code>filterAvailableUnits($eventId, $dateTime, $unitIds, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$unitIds'''
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom Feature.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>

----
</translate>

<translate>

=== getAdditionalFields ===

<code>getAdditionalFields($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Return intake forms for certain event if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.

----
</translate>

<translate>

=== getAnyUnitData ===

<code>getAnyUnitData()</code>

No arguments.
Returns Object|null.

Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}

----
</translate>

<translate>

=== getAvailableTimeIntervals ===

<code>getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: <code>{['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}</code>

----
</translate>

<translate>

=== getAvailableUnits ===

<code>getAvailableUnits($eventId, $dateTime, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: <code>[1, 2, 3]</code>

----

</translate>

<translate>

=== getBookingCancellationsInfo ===

<code>getBookingCancellationsInfo($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
* '''$dateEnd''' String a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.

Returns Array.

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. <code>"type"</code> field can be either
"create", "cancel" or "nopayment_cancel". If <code>"user_id"</code> not specified then bookings where created or
cancelled by admin or employee. Data with type <code>"nopayment_cancel"</code> represents bookings cancelled
automatically by system.Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]

----

</translate>

<translate>

=== getBookingComment ===

<code>getBookingComment($id)</code>

Parameters:

* '''$id''' Integer

Returns String.

Returns booking comment

----
</translate>

<translate>

=== getBookingDetails ===

<code>getBookingDetails($id)</code>

Parameters:

* '''$id''' integer booking id

Returns Array.

Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].

----
</translate>

<translate>

=== getBookingLimitUnavailableTimeInterval ===

<code>getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$eventId''' integer

Returns Array.

Returns time intervals not available for bookings because of configuration of [[Custom_Features#Limit_Bookings|Limit bookings]]
Custom Feature for period of time. Returns empty array if Custom Feature not available.

----
</translate>

<translate>

=== getBookingRevenue ===

<code>getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)</code>

Parameters:

* '''$dateStart''' string a date string in format 'Y-m-d'.
* '''$dateEnd''' string a date string in format 'Y-m-d'
* '''$unitGroupId''' integer
* '''$serviceId''' integer

Returns Array.

Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either
by unit or by service. Set <code>$dateStart</code> and <code>$dateEnd</code> to null to get data for current week.Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}

----
</translate>

<translate>

=== getBookingStats ===

<code>getBookingStats($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

----
</translate>

<translate>

=== getBookings ===

<code>getBookings($params)</code>

Parameters:

* '''$params'''

Returns Array.

Returns list of bookings filtered by given params. Filter params represented as object with following fields:* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking Custom Feature status.
*: If Custom Feature not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If Custom Feature active:
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}

----
</translate>

<translate>

=== getBookingsZapier ===

<code>getBookingsZapier()</code>

No arguments.
Returns Array.

Returns list of bookings filtered by given params

----
</translate>

<translate>

=== getCategoriesList ===

<code>getCategoriesList($isPublic)</code>

Parameters:

* '''$isPublic''' Boolean

Returns Array.

Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.

----

</translate>

<translate>

=== getClient ===

<code>getClient($clientId)</code>

Parameters:

* '''$clientId'''

Returns Array.

Returns client's data object. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getClientComments ===

<code>getClientComments($clientId, $shedulerId)</code>

Parameters:

* '''$clientId''' Integer
* '''$shedulerId''' Integer

Returns Array.

Returns list of all comments for given client

----

</translate>

<translate>

=== getClientList ===

<code>getClientList($searchString, $limit)</code>

Parameters:

* '''$searchString''' String
* '''$limit''' Integer

Returns Array.

Returns list of clients associated with company. You can use either phone number, email address or name as value
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
parameters to get all records. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getCompanyCurrency ===

<code>getCompanyCurrency()</code>

No arguments.
Returns String.

Returns company's currency as three chars code (ISO 4217).

----
</translate>

<translate>

=== getCompanyInfo ===

<code>getCompanyInfo()</code>

No arguments.
Returns Object.

Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].

----

</translate>

<translate>

=== getCompanyParam ===

<code>getCompanyParam($key)</code>

Parameters:

* '''$key''' String

Returns mixed.

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].

----

</translate>

<translate>

=== getCompanyParams ===

<code>getCompanyParams($keys)</code>

Parameters:

* '''$keys''' Array

Returns Array.

Returns company config values for keys. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].For non-existent and not-allowed params it will return false as result

----

</translate>

<translate>

=== getCompanyTimezoneOffset ===

<code>getCompanyTimezoneOffset()</code>

No arguments.
Returns array.

Returns company timezone offset and company timezone

----

</translate>

<translate>

=== getCountryList ===

<code>getCountryList()</code>

No arguments.
Returns Array.

Get list of all countries

----

</translate>

<translate>

=== getCountryPhoneCodes ===

<code>getCountryPhoneCodes()</code>

No arguments.
Returns Array.

Returns country phone code list

----

</translate>

<translate>

=== getCurrentTariffInfo ===

<code>getCurrentTariffInfo()</code>

No arguments.
Returns Array.

Returns all information about current tariff (subscription). For example:{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}

----

</translate>

<translate>

=== getCurrentUserDetails ===

<code>getCurrentUserDetails()</code>

No arguments. Returns Object.

Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on <code>group</code> property value. Most of API methods returns an error if user has low access
rights but not all. There are 4 roles:

* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode

<code>group</code> property can be one of the values:

* <code>shop_user</code> - "Senior Employee" access role
* <code>station_user</code> - "Junior Employee" access role
* <code>admin</code> - "Administrator" access role
* <code>viewer</code> - "Viewer" access role
* <code>reseller_company_admin</code> - reserved

Example:

{
"id": 1,
"login": admin,
"email": "admin@mycoolcompany.com";
"firstname": "Michail",
"lastname": " ",
"phone": "",
"group": "admin",
"is_blocked": 0,
"last_access_time": "2016-06-06 17:55:51",
"unit_group_id": null
}

----

</translate>

<translate>

=== getEventList ===

<code>getEventList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns company's events list. If <code>$asArray</code> is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
event's details object.

----

</translate>

<translate>

=== getFeedbacks ===

<code>getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)</code>

Parameters:

* '''$approvedOnly''' Boolean
* '''$reviewsOnly''' Boolean
* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Get list of feedbacks

----

</translate>

<translate>

=== getFirstWorkingDay ===

<code>getFirstWorkingDay($unitId)</code>

Parameters:

* '''$unitId''' Integer

Returns String.

Returns first working date for unit

----

</translate>

<translate>

=== getGoogleCalendarBusyTime ===

<code>getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in
this parameter. In this case method will use time value '23:59:59'.
* '''$unitId''' integer

Returns Array.

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
be returned. You should call <code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.Example:
<code>
[
{"from" : "2016-02-16 13:30:00",
"to" : "2016-02-16 16:00:00"},
...
]
</code>

----

</translate>

<translate>

=== getGoogleCalendarBusyTimeAvailableUnits ===

<code>getGoogleCalendarBusyTimeAvailableUnits()</code>

No arguments.
Returns Array.

Returns configured unit ids, allowed to sync busy time

----
</translate>

<translate>

=== getLastNotificationUpdate ===

<code>getLastNotificationUpdate($type)</code>

Parameters:

* '''$type''' String

Returns String.

Returns last update datetime

----

</translate>

<translate>

=== getLocationsList ===

<code>getLocationsList($isPublic, $asArray)</code>

Parameters:

* '''$isPublic''' Boolean Optional. Default value is '''false'''.
* '''$asArray''' boolean Optional. Default value is '''false'''.

Returns Array.

Returns available locations for company if Custom Feature [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.

This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.

----
</translate>

<translate>

=== getPluginList ===

<code>getPluginList()</code>

No arguments.
Returns Array.

Returns a list of all Custom Features associated with company with status.

----

</translate>

<translate>



</translate>

----

<translate>

=== getPluginStatuses ===

<code>getPluginStatuses($pluginNames)</code>

Parameters:

* '''$pluginNames''' Array

Returns Array.

Return Custom Feature status true if status active, else false. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== getRecentActions ===

<code>getRecentActions($lastOnly, $limit)</code>

Parameters:

* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Returns latest actions

</translate>

----

<translate>

=== getRecurringDatetimes ===

<code>getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData, $endDateTime)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String
* '''$time''' String
* '''$recurringData''' Array
* '''$endDateTime''' String (optional)

Returns Array.

Get list of dates for recurring booking

</translate>

----

<translate>

=== getRecurringSettings ===

<code>getRecurringSettings($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.

See also:

* [http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription]

</translate>

----

<translate>

=== getRegistrations ===

<code>getRegistrations($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getReservedTime ===

<code>getReservedTime($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$count''' Integer

Returns Object.

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom_Features#Calendar_Sync| Calendar Sync Custom Feature]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.

Example:
<pre>
{
"2016-02-05": [
{
"dd": [], // time slots from Google calendar
"events": [ // reserved time slots
{ "from": "16:00", "to": "16:30" },
{ "from": "16:30", "to": "17:00" },
... ],
"type": "reserved_time",
},
{
"events": [
{ "from": "09:00", "to": "09:30" },
{ "from": "09:30", "to": "10:00" },
... ],
"type": "not_worked_time"
}],
...
}
</pre>

</translate>

----

<translate>

=== getReservedTimeIntervals ===

<code>getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Integer|Array
* '''$count''' Integer

Returns Object.

Returns not available time
Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

</translate>

----

<translate>

=== getSocialCounterStats ===

<code>getSocialCounterStats($provider)</code>

Parameters:

* '''$provider''' String

Returns Integer.

Returns social counters value for your domain

</translate>

----

<translate>

=== getStartTimeMatrix ===

<code>getStartTimeMatrix($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available start time, taking into account breaktimes, start and end working time
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>

If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom_Features#Multiple_Locations|Multiple locations]] Custom Feature description for
more details.

</translate>

----

<translate>

=== getStatuses ===

<code>getStatuses()</code>

No arguments.
Returns Array.

Returns list of available statuses or an empty list if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== getTimeframe ===

<code>getTimeframe()</code>

No arguments.
Returns Integer.

Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need_to_change_interval_(timeframe)|here]].

</translate>

----

<translate>

=== getTimelineType ===

<code>getTimelineType()</code>

No arguments.
Returns String.

Returns company calendar layout type

</translate>

----

<translate>

=== getTopPerformers ===

<code>getTopPerformers()</code>

No arguments.
Returns Array.

Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

</translate>

----

<translate>

=== getTopServices ===

<code>getTopServices($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String
* '''$dateEnd''' String

Returns Array.

Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.

</translate>

----

<translate>

=== getUnitList ===

<code>getUnitList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns list of service performers. If <code>$asArray</code> is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
of event's details object.

</translate>

----

<translate>

=== getUnitWorkdayInfo ===

<code>getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workday info (date_start and date_end)

</translate>

----

<translate>

=== getUnitWorkingDurations ===

<code>getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return working durations

</translate>

----

<translate>

=== getVisitorStats ===

<code>getVisitorStats($groupBy)</code>

Parameters:

* '''$groupBy''' String

Returns Array.

Returns statistics about page visits if Custom Feature [[Custom_Features#Visitor_Counter|Visitor Counter Custom Feature]] enabled. Returns
an empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('counter')]]</code> API method
call to check if Custom Feature enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getWarnings ===

<code>getWarnings($lastOnly)</code>

Parameters:

* '''$lastOnly''' Boolean. Default value is '''false'''.

Returns Array.

Returns a list of objects represented system warnings. Each warning contains <code>warning_type</code> and <code>warning_text</code>
properties. <code>warning_text</code> property contains localized message. <code>warning_type</code> can be one of the values:

* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings

</translate>

----

<translate>

=== getWorkCalendar ===

<code>getWorkCalendar($year, $month, $unitId)</code>

Parameters:

* '''$year''' Integer
* '''$month''' Integer
* '''$unitId''' Integer

Returns Object.

Returns company work schedule as array
Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

</translate>

----

<translate>

=== getWorkDaysInfo ===

<code>getWorkDaysInfo($from, $to, $unitId, $eventId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$unitId''' Integer (optional)
* '''$eventId''' Integer (optional)
* '''$count''' Integer (optional)

Returns Object.

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from
service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:<pre>
{'2014-05-14' : [
{'from': '09:00:00', 'to': '13:00:00'},
{'from': '14:00:00', 'to': '19:00:00'}
] }
</pre>

Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.

</translate>

----

<translate>

=== getWorkDaysTimes ===

<code>getWorkDaysTimes($startDateTime, $endDateTime, $type = 'unit_group')</code>

Parameters:

* '''$startDateTime''' string
* '''$endDateTime''' string
* '''$type''' string. Optional. Either 'unit_group' or 'event'.

Returns Array.

Return busy time by unit id by Calendar Sync Custom Feature if enabled. Please note that this method may return not actual data because data synchronization between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.

</translate>

----

<translate>

=== getWorkload ===

<code>getWorkload($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]

</translate>

----

<translate>

=== isPluginActivated ===

<code>isPluginActivated($pluginName)</code>

Parameters:

* '''$pluginName''' String

Returns Boolean.

Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom_Features|Custom Features]] page for full Custom Features description. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== pluginApproveBookingApprove ===

<code>pluginApproveBookingApprove($id)</code>

Parameters:

* '''$id''' Integer

Returns Array.

Sets approve booking status to 'approved' if [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled and returns
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveBookingCancel ===

<code>pluginApproveBookingCancel($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Sets approve booking status to 'canceled' if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled and returns
true. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookings ===

<code>pluginApproveGetPendingBookings()</code>

No arguments.
Returns array.

Returns list of objects with information about bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]]
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookingsCount ===

<code>pluginApproveGetPendingBookingsCount()</code>

No arguments.
Returns Integer.

Returns count of bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled. Returns
0 if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
call to check if Custom Feature enabled.

</translate>

----

<translate>

=== setBookingComment ===

<code>setBookingComment($id, $comment)</code>

Parameters:

* '''$id''' Integer
* '''$comment''' String

Returns Integer.

Set booking comment

</translate>

----

<translate>

=== getBookingStatus ===

<code>getBookingStatus ($bookingId)</code>

Parameters:

* '''$bookingId''' Integer

Returns Array.

Returns an object of status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists

</translate>

----

<translate>

=== setStatus ===

<code>setStatus($bookingId, $statusId)</code>

Parameters:

* '''$bookingId''' Integer
* '''$statusId''' Integer

Returns Boolean.

Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== updateNotification ===

<code>updateNotification($type)</code>

Parameters:

* '''$type''' String

Returns .

Mark notifications as readed

</translate>

----

<translate>

=== setWorkDayInfo===

<code>setWorkDayInfo($info)</code>

Parameters:

* '''$info''' Array

Returns true on success

Set work day schedule for company|service|provider for week_day|date

Example:
<pre>
{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}

index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company
</pre>

</translate>

----

<translate>

=== deleteSpecialDay===

<code>deleteSpecialDay($date, $params = null)</code>

Parameters:

* '''$date''' String
* '''$params''' Array

Returns true on success

Delete special date if set

Example:
<pre>
'2017-08-21',
{
"unit_group_id":"",
"event_id":""
}
</pre>

</translate>

----

<translate>

=== addServiceProvider===

<code>addServiceProvider($data)</code>

Parameters:

* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Create new service provider

Example:
<pre>
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

</translate>

----

<translate>

=== editServiceProvider===

<code>editServiceProvider($id, $data)</code>

Parameters:

* '''$id''' Integer
* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Edit service provider
(there is no way to delete provider via API, in this case set is_active = 0)

Example:
<pre>
1,
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

-
</translate>

----

<translate>

== Constants ==

=== Error codes ===

See [[Errors handling]] for details.

* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32015 Passed event id is not reccuren
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Intake form values are wrong
* -32080 Appointemnt couldn't be found
* -32081 Service can't be performed when company does not work
* -32082 Service performer can't work when company does not work
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found

</translate>

----

<translate>

===Company params===

Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.

=====General params=====

Administration API inherits all [[Company public service methods#Company_params|keys]] allowed for public API and extends this list with keys:

* attach_ical
* auto_redirect
* auto_redirect_text
* blockchain_address
* blockchain_secret
* borgun_merchant_id
* borgun_payment_gateway_id
* borgun_secret_code
* client_batch_cancel_template
* client_batch_cancel_template_email
* client_batch_cancel_template_email_subject
* client_event_cancel_template
* client_event_cancel_template_email
* client_event_cancel_template_email_subject
* client_event_change_template
* client_event_change_template_email
* client_event_change_template_email_subject
* client_event_creation_template
* client_event_creation_template_email
* client_event_creation_template_email_subject
* client_event_group_creation_template
* client_event_group_creation_template_email
* client_event_group_creation_template_email_subject
* client_event_multiple_creation_template
* client_event_multiple_creation_template_email
* client_event_multiple_creation_template_email_subject
* client_group_notification_template
* client_group_notification_template_email
* client_group_notification_template_email_subject
* client_multiple_notification_template
* client_multiple_notification_template_email
* client_multiple_notification_template_email_subject
* client_notification_template
* client_notification_template_email
* client_notification_template_email_subject
* client_notification_time
* client_recurring_event_creation_template
* client_recurring_event_creation_template_email
* client_recurring_event_creation_template_email_subject
* common_limit_booking
* company_ga_tracking_id
* default_phone
* disconnect_on_timeout
* email_event_list
* email_events_list_template
* email_group_events_list_template
* event_list_style
* feed_back_interval
* feedback_invite_template_email
* feedback_invite_template_email_subject
* google_conversion_color
* google_conversion_currency
* google_conversion_format
* google_conversion_id
* google_conversion_label
* google_conversion_language
* google_conversion_value
* hide_working_hours_block
* include_cancel_link
* kortais_merchant
* kortais_secret_code
* kortais_terminal
* layout_background
* layout_background_repeat
* mobile_site_link
* mobile_site_link_title
* no_show_period
* on_success_button_link
* on_success_button_text
* recap_interval
* recap_send_after_time
* recap_send_canceled_bookings
* recap_send_new_bookings
* recap_send_upcomming_bookings
* send_cancel_to_client
* send_cancel_to_client_email
* send_cancel_to_unit
* send_cancel_to_unit_email
* send_contact_widget_email_notification
* send_contact_widget_sms_notification
* send_notify_to_client
* send_notify_to_client_email
* send_notify_to_unit
* send_notify_to_unit_email
* send_onchange_to_client
* send_onchange_to_client_email
* send_onchange_to_unit
* send_onchange_to_unit_email
* send_oncreate_to_client
* send_oncreate_to_client_email
* send_oncreate_to_unit
* send_oncreate_to_unit_email
* send_sms_if_push_enabled
* site_link
* site_link_title
* skip_limits_for_admin
* skip_show_mobile_app_ads
* skip_show_on_success_button
* sms_event_list
* sms_events_list_template
* sms_group_events_list_template
* unit_batch_cancel_template
* unit_batch_cancel_template_email
* unit_batch_cancel_template_email_subject
* unit_event_cancel_template
* unit_event_cancel_template_email
* unit_event_cancel_template_email_subject
* unit_event_change_template
* unit_event_change_template_email
* unit_event_change_template_email_subject
* unit_event_creation_template
* unit_event_creation_template_email
* unit_event_creation_template_email_subject
* unit_event_group_creation_template
* unit_event_group_creation_template_email
* unit_event_group_creation_template_email_subject
* unit_group_notification_template
* unit_group_notification_template_email
* unit_group_notification_template_email_subject
* unit_notification_template
* unit_notification_template_email
* unit_notification_template_email_subject
* unit_notification_time
* unit_recurring_event_creation_template
* unit_recurring_event_creation_template_email
* unit_recurring_event_creation_template_email_subject
* use_common_client_db
* user_confirmation
* user_public_layout
* user_public_theme
* waiting_video

</translate>

----

<translate>

=====Accept payments Custom Feature params=====

Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].

* allow_delay_payment
*: Allow delay payment option. Boolean.
* company_currency
*:
* hide_sale_tax
*: Hide sales tax option. Boolean.
* payment_timeout
*: Payment timeout option. String ("5 minutes", "1 hour", ...)
* sale_tax
*: Sales tax option. Integer. You should divide by 100 to get percent value.
* paypal_account
*: PayPal payment processor configuration. String.
* skrill_account
*: Skrill payment processor configuration parameter. String.
* skrill_secret
*: Skrill payment processor configuration parameter. String.
* zooz_app_id
*: ZooZ payment processor configuration parameter. String.
* zooz_app_key
*: ZooZ payment processor configuration parameter. String.
* dwolla_application_key
*: Dwolla payment processor configuration parameter. String.
* dwolla_id
*: Dwolla payment processor configuration parameter. String.
* dwolla_secret_key
*: Dwolla payment processor configuration parameter. String.
* liqpay_merchant_id
* liqpay_merchant_pass

</translate>

----

<translate>

=====Term & Conditions Custom Feature params=====

Read more about [[Custom_Features#Terms_and_Conditions|Terms and Conditions Custom Feature]].

* user_license_text
*: Terms and conditions text. String.

</translate>

----

<translate>

===Custom Features' identifiers===

Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[#isPluginActivated|isPluginActivated]]</code> and <code>[[#getPluginStatuses|getPluginStatuses]]</code> API methods.

* advanced_notification
*:Book Soon notification system
* any_unit
*:Any Employee selector
* api
*:API
* approve_booking
*:Approve booking
* back_to_site
*:Take me back home
* contact_widget
*:Contact widget
* counter
*:Visitor Counter
* custom_css
*:Custom CSS
* data_security
*:Clean history
* description
*:HTML description field for events
* event_category
*:Service categories
* event_field
*:Intake forms
* facebookImage
*:Facebook client info
* financial_dashboard
*:Insights
* google_analytics
*:Google Adwords and analytics
* google_calendar_export
*:Calendar sync
* group_booking
*:Group bookings
* hipaa
*:HIPAA
* limit_bookings
*:Limit bookings
* location
*:Multiple locations
* mobile_app_backend
*:Mobile application
* multiple_booking
*:Multiple bookings
* news
*:News
* paid_events
*:Accept payments

* recap
*:Daily report
* secure
*:SSL
* status
*:Status
* unit_colors
*:Providers color coding
* user_license
*:Terms and conditions
* cancelation_policy
*:Cancellation Policy

See [[Custom_Features|Custom Features]] page for description for each Custom Feature.

</translate>

<translate>
== Examples ==

====getBookingDetails response====

An example of data returned by [[#getBookingDetails|getBookingDetails]] API method.

{
"id": "321",
"event_id": "5",
"event_name": "Massage",
"unit_id": "3",
"unit_name": "John",
"client_id": "1",
"client_name": "Bob",
"start_date_time": "2015-11-25 15:00:00",
"end_date_time": "2015-11-25 16:00:00",
"is_confirmed": "1",
"code": "h8v8w5ls",
"record_date": "2015-11-19 04:06:38",
"comment": null,
"company_login": "testzt",
"company_name": "My Cool Company",
"company_phone": "+1-555-55-55",
"company_email": "into@mycoolcompany.com",
"additional_fields": [{
"value": "on",
"field_name": "201a89517de509f6b3a60858918faac3",
"field_title": "Include washing",
"field_position": "4",
"field_type": "checkbox",
"field_id": "4"
}],
"comments": [],
"history": [{
"id": "536",
"sheduler_id": "321",
"datetime": "2015-11-19 11:06:38",
"type": "create",
"user_id": "1",
"agent": "SimplyBook.me\/55 CFNetwork\/758.0.2 Darwin\/15.0.0",
"ip": "213.174.0.53, 158.69.224.50:127.0.0.1",
"referer": "",
"login": "admin",
"firstname": "Mikhail",
"lastname": ""
}],
"status": {
"id": "3",
"name": "Fancy Status",
"description": null,
"color": "4cbadb",
"is_default": "1"
},
"location": {
"id": "1",
"title": "location",
"description": null,
"picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
"address1": null,
"address2": "Saint Margaret Street",
"city": "\u041b\u043e\u043d\u0434\u043e\u043d",
"zip": null,
"country_id": "GB",
"lat": "51.50013000000000000000",
"lng": "-0.12630500000000000000",
"phone": "44",
"position": "1",
"is_default": "1"
},
"price": [],
"promo": false
}

</translate>

<translate>

Location field is present in response only if [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.

Status field is present in response only if [[Custom_Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.

Price field is present in response only if [[Custom_Features#Accept_Payments|Accept payments Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a free service.


<code>additional_fields</code> field is present in response only if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a service with no intake forms.

</translate>

----

<translate>

====book response====

[[#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.

{
"require_confirm":false,
"bookings":[
{
"id":"434",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-30 13:00:00",
"end_date_time":"2015-12-30 13:30:00",
"is_confirmed":"1",
"code":"h8vc14ca",
"hash":"785cb8cce316e64765b94c05a635f4be"
},
{
"id":"435",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-31 13:00:00",
"end_date_time":"2015-12-31 13:30:00",
"is_confirmed":"1",
"code":"h8vc2pge",
"hash":"8b92d634541bfd93c0830967e56f4653"
},
{
"id":"436",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-04 13:00:00",
"end_date_time":"2016-01-04 13:30:00",
"is_confirmed":"1",
"code":"h8vc3urb",
"hash":"cd22a0bf183f7350e595988dd2486e5b"
},
{
"id":"437",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-05 13:00:00",
"end_date_time":"2016-01-05 13:30:00",
"is_confirmed":"1",
"code":"h8vc44d9",
"hash":"53f98ff4e4a0323aa907156c59c99362"
}
],
"batch_type":"batch_recurrent_booking",
"recurrent_batch_id":"1",
"batch_hash":"357178bce290381bb7235080941ec143"
}

</translate>

----

<translate>

====getCompanyInfo response====

An example of data returned by [[#getCompanyInfo|getCompanyInfo]] API method.

{
"login": "pierrecoetzee",
"name": "Pierre",
"description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"address1": "",
"address2": "Storey's Gate, ",
"city": "London",
"country_id": "GB",
"lat": "51.500435",
"lng": "-0.129811",
"email": "pierre.coe@gmail.com",
"phone": "",
"web": null,
"skip_address": null,
"logo": null,
"address": "GB, London, Storey's Gate, ",
"description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"timezone": "Europe London",
"show_in_client_timezone": false,
"timeframe": "60",
"timeline_type": "modern_week",
"allow_event_day_break": "0",
"allow_event_breaktime_break": "0"
}

<code>timeline_type</code> field can be one the following values:

* flexible
* modern
* flexible_week
* modern_week
* classic
* classes

</translate>

<translate>
Please note that <code>classic</code> timeline type is deprecated and not supported anymore.

<code>description</code> field contains raw data of company's description which can include HTML tags. <code>description_text</code> field contains only text information without HTML tags.

For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params|Company params section]].

</translate>
----

<translate>

<!--====getPluginPromoInfoByCode response====

{
"id": "1",
"title": "[service\/services] with [discount]% discount!",
"code": "yvuvugum",
"description": "We are offering [service\/services] with an amazing [discount]% discount! We are running this deal for a limited time only.",
"discount": "99.9999",
"start_date": "2015-12-23",
"expired_date": "2016-01-23",
"sheduler_start_date": "2015-12-23",
"sheduler_end_date": "2015-12-31",
"sheduler_start_time": "09:00:00",
"sheduler_end_time": "22:30:00",
"allow_usage_count": "20",
"fineprint_text": "Deal is limited for new clients only. Reward is claimable [client_claim_times_number] times per client. Deal is only claimable for the locations specified. Deal is cannot be combined with any other promotion. Must be redeemed prior to the expiration date shown on the deal.",
"redemption_text": "Present your confirmation code when you want to redeem your deal. You may either to print off your confirmation email or show your confirmation code by loggin into Simplybook on your mobile phone\/Pc.\r\n[promocode]\r\n[discount]\r\n[reward]\r\n[referal_qty]",
"headline": "[service\/services] with [discount]% discount!",
"image": null,
"allow_customer_count": "1",
"show_in_catalogue": "1",
"status": "active",
"plugin_promo_message_id": "1",
"common_promotion_id": "132",
"service_ids": ["1"]
}

<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
</translate>

Company administration service methods

2025-05-15T12:55:48Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Company administration service methods - SimplyBook.me
|description=Learn about service methods for internal company administration. Manage bookings tailored to your operations. Start here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

</translate>

<translate>

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.
</translate>

<translate>
The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>
Example

<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "Если Вы хотите попробовать себя в роли модели, но не определились с образом. 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>
</translate>

<translate>
Example of request with error response:

<pre>
Request
{
"jsonrpc": "2.0",
"method": "someNotExistingMethod",
"params":[],
"id":1
}

Response
{
"jsonrpc": "2.0",
"id":1,
"error": {
"code": -32601,
"message": "Method not found"
}
}
</pre>
</translate>

<translate>
All calls of public service methods should have additional HTTP header:

* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.

===Endpoint===

Use URL <code>https://user-api.simplybook.me/admin</code> for all administration service API calls.

===Authentication===

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.

== Methods ==

=== addClient ===

<code>addClient($clientData)</code>

Parameters:

* '''$clientData''' Object

Returns Integer.

</translate>

<translate>

Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id. If client record with specified data exists method will return an id of this record. Otherwise data
will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.Also email, phone number or both of them can be mandatory fields. You should call
<code>getCompanyParam('require_fields')</code> method to check which fields are required.

Method returns an error:

* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong

Example:

{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "FrancesTPerez@teleworm.us",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872
}

</translate>

<translate>
----

=== addDeviceToken ===

<code>addDeviceToken($token, $device)</code>

Parameters:

* '''$token''' String a device token string
* '''$device''' String a device type ('android' or 'apple')

Returns boolean.

Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
changes in already created bookings. Use either <code>'apple'</code> or <code>'android'</code> for <code>device</code>
parameter.

----
</translate>

<translate>

=== book ===

<code>book($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' string a date string in format 'Y-m-d'
* '''$startTime''' string a time string in format 'H:i:s'
* '''$endDate''' string a date string in format 'Y-m-d'
* '''$endTime''' string a time string in format 'H:i:s'
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.
* '''$count''' Integer bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
* '''$batchId''' Integer add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
* '''$recurringData''' Array - make booking recurrent. (optional)

Returns Object.

</translate>

<translate>

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>$clientTimeOffset</code> parameter as difference between company's time zone and
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specified). You should specify an <code>$additionalFields</code> parameter if service requires some intake forms (see [[Custom_Features#Intake_Forms|Intake Forms Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>

</translate>

<translate>

If [[Custom_Features#Multiple_Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
to check if Custom feature active and <code>[[#getLocationsList|getLocationsList()]]</code> method to get list of
available locations.

See [[#book response|example]] of <code>book</code> API method response.

See also:

* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

</translate>

----
<translate>

=== calculateEndTime ===

<code>calculateEndTime($startDateTime, $eventId, $unitId)</code>

Parameters:

* '''$startDateTime''' String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
* '''$eventId''' Integer
* '''$unitId''' Integer

Returns String|Boolean.

Returns end datetime if booking is available, else return false

----
</translate>

<translate>

=== cancelBatch ===

<code>cancelBatch($id, $bookingIds)</code>

Parameters:

* '''$id''' Integer identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
* '''$bookingIds''' Array ids of bookings included to batch.

Returns boolean.

Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in <code>$bookingIds</code> list is used for
information in notifications.

----
</translate>

<translate>

=== cancelBooking ===

<code>cancelBooking($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.

----
</translate>

<translate>

=== createBatch ===

<code>createBatch()</code>

No arguments.
Returns Integer.

Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[#book|book]]</code>
API method.

----
</translate>

<translate>

=== deleteDeviceToken ===

<code>deleteDeviceToken($token)</code>

Parameters:

* '''$token''' String - device token

Returns boolean.

Unsubscribe from push notifications service.

----
</translate>

<translate>

=== editBook ===

<code>editBook($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)</code>

Parameters:

* '''$shedulerId''' Integer an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' String - in Y-m-d format
* '''$startTime''' String - in H:i:s format
* '''$endDate''' String - in Y-m-d format
* '''$endTime''' String - in H:i:s format
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.

Returns Object.

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.

----
</translate>

<translate>

=== editClient ===

<code>editClient($clientId, $clientData)</code>

Parameters:

* '''$clientId''' Integer
* '''$clientData''' Object

Returns Integer.

Edits client's record. See <code>[[#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.

----
</translate>

<translate>

=== filterAvailableUnits ===

<code>filterAvailableUnits($eventId, $dateTime, $unitIds, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$unitIds'''
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom Feature.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>

----
</translate>

<translate>

=== getAdditionalFields ===

<code>getAdditionalFields($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Return intake forms for certain event if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.

----
</translate>

<translate>

=== getAnyUnitData ===

<code>getAnyUnitData()</code>

No arguments.
Returns Object|null.

Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}

----
</translate>

<translate>

=== getAvailableTimeIntervals ===

<code>getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: <code>{['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}</code>

----
</translate>

<translate>

=== getAvailableUnits ===

<code>getAvailableUnits($eventId, $dateTime, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: <code>[1, 2, 3]</code>

----

</translate>

<translate>

=== getBookingCancellationsInfo ===

<code>getBookingCancellationsInfo($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
* '''$dateEnd''' String a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.

Returns Array.

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. <code>"type"</code> field can be either
"create", "cancel" or "nopayment_cancel". If <code>"user_id"</code> not specified then bookings where created or
cancelled by admin or employee. Data with type <code>"nopayment_cancel"</code> represents bookings cancelled
automatically by system.Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]

----

</translate>

<translate>

=== getBookingComment ===

<code>getBookingComment($id)</code>

Parameters:

* '''$id''' Integer

Returns String.

Returns booking comment

----
</translate>

<translate>

=== getBookingDetails ===

<code>getBookingDetails($id)</code>

Parameters:

* '''$id''' integer booking id

Returns Array.

Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].

----
</translate>

<translate>

=== getBookingLimitUnavailableTimeInterval ===

<code>getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$eventId''' integer

Returns Array.

Returns time intervals not available for bookings because of configuration of [[Custom_Features#Limit_Bookings|Limit bookings]]
Custom Feature for period of time. Returns empty array if Custom Feature not available.

----
</translate>

<translate>

=== getBookingRevenue ===

<code>getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)</code>

Parameters:

* '''$dateStart''' string a date string in format 'Y-m-d'.
* '''$dateEnd''' string a date string in format 'Y-m-d'
* '''$unitGroupId''' integer
* '''$serviceId''' integer

Returns Array.

Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either
by unit or by service. Set <code>$dateStart</code> and <code>$dateEnd</code> to null to get data for current week.Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}

----
</translate>

<translate>

=== getBookingStats ===

<code>getBookingStats($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

----
</translate>

<translate>

=== getBookings ===

<code>getBookings($params)</code>

Parameters:

* '''$params'''

Returns Array.

Returns list of bookings filtered by given params. Filter params represented as object with following fields:* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking Custom Feature status.
*: If Custom Feature not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If Custom Feature active:
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}

----
</translate>

<translate>

=== getBookingsZapier ===

<code>getBookingsZapier()</code>

No arguments.
Returns Array.

Returns list of bookings filtered by given params

----
</translate>

<translate>

=== getCategoriesList ===

<code>getCategoriesList($isPublic)</code>

Parameters:

* '''$isPublic''' Boolean

Returns Array.

Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.

----

</translate>

<translate>

=== getClient ===

<code>getClient($clientId)</code>

Parameters:

* '''$clientId'''

Returns Array.

Returns client's data object. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getClientComments ===

<code>getClientComments($clientId, $shedulerId)</code>

Parameters:

* '''$clientId''' Integer
* '''$shedulerId''' Integer

Returns Array.

Returns list of all comments for given client

----

</translate>

<translate>

=== getClientList ===

<code>getClientList($searchString, $limit)</code>

Parameters:

* '''$searchString''' String
* '''$limit''' Integer

Returns Array.

Returns list of clients associated with company. You can use either phone number, email address or name as value
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
parameters to get all records. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getCompanyCurrency ===

<code>getCompanyCurrency()</code>

No arguments.
Returns String.

Returns company's currency as three chars code (ISO 4217).

----
</translate>

<translate>

=== getCompanyInfo ===

<code>getCompanyInfo()</code>

No arguments.
Returns Object.

Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].

----

</translate>

<translate>

=== getCompanyParam ===

<code>getCompanyParam($key)</code>

Parameters:

* '''$key''' String

Returns mixed.

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].

----

</translate>

<translate>

=== getCompanyParams ===

<code>getCompanyParams($keys)</code>

Parameters:

* '''$keys''' Array

Returns Array.

Returns company config values for keys. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].For non-existent and not-allowed params it will return false as result

----

</translate>

<translate>

=== getCompanyTimezoneOffset ===

<code>getCompanyTimezoneOffset()</code>

No arguments.
Returns array.

Returns company timezone offset and company timezone

----

</translate>

<translate>

=== getCountryList ===

<code>getCountryList()</code>

No arguments.
Returns Array.

Get list of all countries

----

</translate>

<translate>

=== getCountryPhoneCodes ===

<code>getCountryPhoneCodes()</code>

No arguments.
Returns Array.

Returns country phone code list

----

</translate>

<translate>

=== getCurrentTariffInfo ===

<code>getCurrentTariffInfo()</code>

No arguments.
Returns Array.

Returns all information about current tariff (subscription). For example:{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}

----

</translate>

<translate>

=== getCurrentUserDetails ===

<code>getCurrentUserDetails()</code>

No arguments. Returns Object.

Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on <code>group</code> property value. Most of API methods returns an error if user has low access
rights but not all. There are 4 roles:

* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode

<code>group</code> property can be one of the values:

* <code>shop_user</code> - "Senior Employee" access role
* <code>station_user</code> - "Junior Employee" access role
* <code>admin</code> - "Administrator" access role
* <code>viewer</code> - "Viewer" access role
* <code>reseller_company_admin</code> - reserved

Example:

{
"id": 1,
"login": admin,
"email": "admin@mycoolcompany.com";
"firstname": "Michail",
"lastname": " ",
"phone": "",
"group": "admin",
"is_blocked": 0,
"last_access_time": "2016-06-06 17:55:51",
"unit_group_id": null
}

----

</translate>

<translate>

=== getEventList ===

<code>getEventList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns company's events list. If <code>$asArray</code> is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
event's details object.

----

</translate>

<translate>

=== getFeedbacks ===

<code>getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)</code>

Parameters:

* '''$approvedOnly''' Boolean
* '''$reviewsOnly''' Boolean
* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Get list of feedbacks

----

</translate>

<translate>

=== getFirstWorkingDay ===

<code>getFirstWorkingDay($unitId)</code>

Parameters:

* '''$unitId''' Integer

Returns String.

Returns first working date for unit

----

</translate>

<translate>

=== getGoogleCalendarBusyTime ===

<code>getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in
this parameter. In this case method will use time value '23:59:59'.
* '''$unitId''' integer

Returns Array.

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
be returned. You should call <code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.Example:
<code>
[
{"from" : "2016-02-16 13:30:00",
"to" : "2016-02-16 16:00:00"},
...
]
</code>

----

</translate>

<translate>

=== getGoogleCalendarBusyTimeAvailableUnits ===

<code>getGoogleCalendarBusyTimeAvailableUnits()</code>

No arguments.
Returns Array.

Returns configured unit ids, allowed to sync busy time

----
</translate>

<translate>

=== getLastNotificationUpdate ===

<code>getLastNotificationUpdate($type)</code>

Parameters:

* '''$type''' String

Returns String.

Returns last update datetime

----

</translate>

<translate>

=== getLocationsList ===

<code>getLocationsList($isPublic, $asArray)</code>

Parameters:

* '''$isPublic''' Boolean Optional. Default value is '''false'''.
* '''$asArray''' boolean Optional. Default value is '''false'''.

Returns Array.

Returns available locations for company if Custom Feature [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.

This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.

----
</translate>

<translate>

=== getPluginList ===

<code>getPluginList()</code>

No arguments.
Returns Array.

Returns a list of all Custom Features associated with company with status.

----

</translate>

<translate>



</translate>

----

<translate>

=== getPluginStatuses ===

<code>getPluginStatuses($pluginNames)</code>

Parameters:

* '''$pluginNames''' Array

Returns Array.

Return Custom Feature status true if status active, else false. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== getRecentActions ===

<code>getRecentActions($lastOnly, $limit)</code>

Parameters:

* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Returns latest actions

</translate>

----

<translate>

=== getRecurringDatetimes ===

<code>getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData, $endDateTime)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String
* '''$time''' String
* '''$recurringData''' Array
* '''$endDateTime''' String (optional)

Returns Array.

Get list of dates for recurring booking

</translate>

----

<translate>

=== getRecurringSettings ===

<code>getRecurringSettings($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.

See also:

* [http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription]

</translate>

----

<translate>

=== getRegistrations ===

<code>getRegistrations($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getReservedTime ===

<code>getReservedTime($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$count''' Integer

Returns Object.

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom_Features#Calendar_Sync| Calendar Sync Custom Feature]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.

Example:
<pre>
{
"2016-02-05": [
{
"dd": [], // time slots from Google calendar
"events": [ // reserved time slots
{ "from": "16:00", "to": "16:30" },
{ "from": "16:30", "to": "17:00" },
... ],
"type": "reserved_time",
},
{
"events": [
{ "from": "09:00", "to": "09:30" },
{ "from": "09:30", "to": "10:00" },
... ],
"type": "not_worked_time"
}],
...
}
</pre>

</translate>

----

<translate>

=== getReservedTimeIntervals ===

<code>getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Integer|Array
* '''$count''' Integer

Returns Object.

Returns not available time
Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

</translate>

----

<translate>

=== getSocialCounterStats ===

<code>getSocialCounterStats($provider)</code>

Parameters:

* '''$provider''' String

Returns Integer.

Returns social counters value for your domain

</translate>

----

<translate>

=== getStartTimeMatrix ===

<code>getStartTimeMatrix($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available start time, taking into account breaktimes, start and end working time
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>

If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom_Features#Multiple_Locations|Multiple locations]] Custom Feature description for
more details.

</translate>

----

<translate>

=== getStatuses ===

<code>getStatuses()</code>

No arguments.
Returns Array.

Returns list of available statuses or an empty list if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== getTimeframe ===

<code>getTimeframe()</code>

No arguments.
Returns Integer.

Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need_to_change_interval_(timeframe)|here]].

</translate>

----

<translate>

=== getTimelineType ===

<code>getTimelineType()</code>

No arguments.
Returns String.

Returns company calendar layout type

</translate>

----

<translate>

=== getTopPerformers ===

<code>getTopPerformers()</code>

No arguments.
Returns Array.

Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

</translate>

----

<translate>

=== getTopServices ===

<code>getTopServices($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String
* '''$dateEnd''' String

Returns Array.

Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.

</translate>

----

<translate>

=== getUnitList ===

<code>getUnitList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns list of service performers. If <code>$asArray</code> is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
of event's details object.

</translate>

----

<translate>

=== getUnitWorkdayInfo ===

<code>getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workday info (date_start and date_end)

</translate>

----

<translate>

=== getUnitWorkingDurations ===

<code>getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return working durations

</translate>

----

<translate>

=== getVisitorStats ===

<code>getVisitorStats($groupBy)</code>

Parameters:

* '''$groupBy''' String

Returns Array.

Returns statistics about page visits if Custom Feature [[Custom_Features#Visitor_Counter|Visitor Counter Custom Feature]] enabled. Returns
an empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('counter')]]</code> API method
call to check if Custom Feature enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getWarnings ===

<code>getWarnings($lastOnly)</code>

Parameters:

* '''$lastOnly''' Boolean. Default value is '''false'''.

Returns Array.

Returns a list of objects represented system warnings. Each warning contains <code>warning_type</code> and <code>warning_text</code>
properties. <code>warning_text</code> property contains localized message. <code>warning_type</code> can be one of the values:

* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings

</translate>

----

<translate>

=== getWorkCalendar ===

<code>getWorkCalendar($year, $month, $unitId)</code>

Parameters:

* '''$year''' Integer
* '''$month''' Integer
* '''$unitId''' Integer

Returns Object.

Returns company work schedule as array
Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

</translate>

----

<translate>

=== getWorkDaysInfo ===

<code>getWorkDaysInfo($from, $to, $unitId, $eventId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$unitId''' Integer (optional)
* '''$eventId''' Integer (optional)
* '''$count''' Integer (optional)

Returns Object.

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from
service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:<pre>
{'2014-05-14' : [
{'from': '09:00:00', 'to': '13:00:00'},
{'from': '14:00:00', 'to': '19:00:00'}
] }
</pre>

Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.

</translate>

----

<translate>

=== getWorkDaysTimes ===

<code>getWorkDaysTimes($startDateTime, $endDateTime, $type = 'unit_group')</code>

Parameters:

* '''$startDateTime''' string
* '''$endDateTime''' string
* '''$type''' string. Optional. Either 'unit_group' or 'event'.

Returns Array.

Return busy time by unit id by Calendar Sync Custom Feature if enabled. Please note that this method may return not actual data because data synchronization between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.

</translate>

----

<translate>

=== getWorkload ===

<code>getWorkload($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]

</translate>

----

<translate>

=== isPluginActivated ===

<code>isPluginActivated($pluginName)</code>

Parameters:

* '''$pluginName''' String

Returns Boolean.

Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom_Features|Custom Features]] page for full Custom Features description. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== pluginApproveBookingApprove ===

<code>pluginApproveBookingApprove($id)</code>

Parameters:

* '''$id''' Integer

Returns Array.

Sets approve booking status to 'approved' if [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled and returns
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveBookingCancel ===

<code>pluginApproveBookingCancel($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Sets approve booking status to 'canceled' if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled and returns
true. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookings ===

<code>pluginApproveGetPendingBookings()</code>

No arguments.
Returns array.

Returns list of objects with information about bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]]
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookingsCount ===

<code>pluginApproveGetPendingBookingsCount()</code>

No arguments.
Returns Integer.

Returns count of bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled. Returns
0 if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
call to check if Custom Feature enabled.

</translate>

----

<translate>

=== setBookingComment ===

<code>setBookingComment($id, $comment)</code>

Parameters:

* '''$id''' Integer
* '''$comment''' String

Returns Integer.

Set booking comment

</translate>

----

<translate>

=== getBookingStatus ===

<code>getBookingStatus ($bookingId)</code>

Parameters:

* '''$bookingId''' Integer

Returns Array.

Returns an object of status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists

</translate>

----

<translate>

=== setStatus ===

<code>setStatus($bookingId, $statusId)</code>

Parameters:

* '''$bookingId''' Integer
* '''$statusId''' Integer

Returns Boolean.

Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== updateNotification ===

<code>updateNotification($type)</code>

Parameters:

* '''$type''' String

Returns .

Mark notifications as readed

</translate>

----

<translate>

=== setWorkDayInfo===

<code>setWorkDayInfo($info)</code>

Parameters:

* '''$info''' Array

Returns true on success

Set work day schedule for company|service|provider for week_day|date

Example:
<pre>
{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}

index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company
</pre>

</translate>

----

<translate>

=== deleteSpecialDay===

<code>deleteSpecialDay($date, $params = null)</code>

Parameters:

* '''$date''' String
* '''$params''' Array

Returns true on success

Delete special date if set

Example:
<pre>
'2017-08-21',
{
"unit_group_id":"",
"event_id":""
}
</pre>

</translate>

----

<translate>

=== addServiceProvider===

<code>addServiceProvider($data)</code>

Parameters:

* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Create new service provider

Example:
<pre>
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

</translate>

----

<translate>

=== editServiceProvider===

<code>editServiceProvider($id, $data)</code>

Parameters:

* '''$id''' Integer
* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Edit service provider
(there is no way to delete provider via API, in this case set is_active = 0)

Example:
<pre>
1,
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

-
</translate>

----

<translate>

== Constants ==

=== Error codes ===

See [[Errors handling]] for details.

* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32015 Passed event id is not reccuren
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Intake form values are wrong
* -32080 Appointemnt couldn't be found
* -32081 Service can't be performed when company does not work
* -32082 Service performer can't work when company does not work
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found

</translate>

----

<translate>

===Company params===

Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.

=====General params=====

Administration API inherits all [[Company public service methods#Company_params|keys]] allowed for public API and extends this list with keys:

* attach_ical
* auto_redirect
* auto_redirect_text
* blockchain_address
* blockchain_secret
* borgun_merchant_id
* borgun_payment_gateway_id
* borgun_secret_code
* client_batch_cancel_template
* client_batch_cancel_template_email
* client_batch_cancel_template_email_subject
* client_event_cancel_template
* client_event_cancel_template_email
* client_event_cancel_template_email_subject
* client_event_change_template
* client_event_change_template_email
* client_event_change_template_email_subject
* client_event_creation_template
* client_event_creation_template_email
* client_event_creation_template_email_subject
* client_event_group_creation_template
* client_event_group_creation_template_email
* client_event_group_creation_template_email_subject
* client_event_multiple_creation_template
* client_event_multiple_creation_template_email
* client_event_multiple_creation_template_email_subject
* client_group_notification_template
* client_group_notification_template_email
* client_group_notification_template_email_subject
* client_multiple_notification_template
* client_multiple_notification_template_email
* client_multiple_notification_template_email_subject
* client_notification_template
* client_notification_template_email
* client_notification_template_email_subject
* client_notification_time
* client_recurring_event_creation_template
* client_recurring_event_creation_template_email
* client_recurring_event_creation_template_email_subject
* common_limit_booking
* company_ga_tracking_id
* default_phone
* disconnect_on_timeout
* email_event_list
* email_events_list_template
* email_group_events_list_template
* event_list_style
* feed_back_interval
* feedback_invite_template_email
* feedback_invite_template_email_subject
* google_conversion_color
* google_conversion_currency
* google_conversion_format
* google_conversion_id
* google_conversion_label
* google_conversion_language
* google_conversion_value
* hide_working_hours_block
* include_cancel_link
* kortais_merchant
* kortais_secret_code
* kortais_terminal
* layout_background
* layout_background_repeat
* mobile_site_link
* mobile_site_link_title
* no_show_period
* on_success_button_link
* on_success_button_text
* recap_interval
* recap_send_after_time
* recap_send_canceled_bookings
* recap_send_new_bookings
* recap_send_upcomming_bookings
* send_cancel_to_client
* send_cancel_to_client_email
* send_cancel_to_unit
* send_cancel_to_unit_email
* send_contact_widget_email_notification
* send_contact_widget_sms_notification
* send_notify_to_client
* send_notify_to_client_email
* send_notify_to_unit
* send_notify_to_unit_email
* send_onchange_to_client
* send_onchange_to_client_email
* send_onchange_to_unit
* send_onchange_to_unit_email
* send_oncreate_to_client
* send_oncreate_to_client_email
* send_oncreate_to_unit
* send_oncreate_to_unit_email
* send_sms_if_push_enabled
* site_link
* site_link_title
* skip_limits_for_admin
* skip_show_mobile_app_ads
* skip_show_on_success_button
* sms_event_list
* sms_events_list_template
* sms_group_events_list_template
* unit_batch_cancel_template
* unit_batch_cancel_template_email
* unit_batch_cancel_template_email_subject
* unit_event_cancel_template
* unit_event_cancel_template_email
* unit_event_cancel_template_email_subject
* unit_event_change_template
* unit_event_change_template_email
* unit_event_change_template_email_subject
* unit_event_creation_template
* unit_event_creation_template_email
* unit_event_creation_template_email_subject
* unit_event_group_creation_template
* unit_event_group_creation_template_email
* unit_event_group_creation_template_email_subject
* unit_group_notification_template
* unit_group_notification_template_email
* unit_group_notification_template_email_subject
* unit_notification_template
* unit_notification_template_email
* unit_notification_template_email_subject
* unit_notification_time
* unit_recurring_event_creation_template
* unit_recurring_event_creation_template_email
* unit_recurring_event_creation_template_email_subject
* use_common_client_db
* user_confirmation
* user_public_layout
* user_public_theme
* waiting_video

</translate>

----

<translate>

=====Accept payments Custom Feature params=====

Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].

* allow_delay_payment
*: Allow delay payment option. Boolean.
* company_currency
*:
* hide_sale_tax
*: Hide sales tax option. Boolean.
* payment_timeout
*: Payment timeout option. String ("5 minutes", "1 hour", ...)
* sale_tax
*: Sales tax option. Integer. You should divide by 100 to get percent value.
* paypal_account
*: PayPal payment processor configuration. String.
* skrill_account
*: Skrill payment processor configuration parameter. String.
* skrill_secret
*: Skrill payment processor configuration parameter. String.
* zooz_app_id
*: ZooZ payment processor configuration parameter. String.
* zooz_app_key
*: ZooZ payment processor configuration parameter. String.
* dwolla_application_key
*: Dwolla payment processor configuration parameter. String.
* dwolla_id
*: Dwolla payment processor configuration parameter. String.
* dwolla_secret_key
*: Dwolla payment processor configuration parameter. String.
* liqpay_merchant_id
* liqpay_merchant_pass

</translate>

----

<translate>

=====Term & Conditions Custom Feature params=====

Read more about [[Custom_Features#Terms_and_Conditions|Terms and Conditions Custom Feature]].

* user_license_text
*: Terms and conditions text. String.

</translate>

----

<translate>

===Custom Features' identifiers===

Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[#isPluginActivated|isPluginActivated]]</code> and <code>[[#getPluginStatuses|getPluginStatuses]]</code> API methods.

* advanced_notification
*:Book Soon notification system
* any_unit
*:Any Employee selector
* api
*:API
* approve_booking
*:Approve booking
* back_to_site
*:Take me back home
* contact_widget
*:Contact widget
* counter
*:Visitor Counter
* custom_css
*:Custom CSS
* data_security
*:Clean history
* description
*:HTML description field for events
* event_category
*:Service categories
* event_field
*:Intake forms
* facebookImage
*:Facebook client info
* financial_dashboard
*:Insights
* google_analytics
*:Google Adwords and analytics
* google_calendar_export
*:Calendar sync
* group_booking
*:Group bookings
* hipaa
*:HIPAA
* limit_bookings
*:Limit bookings
* location
*:Multiple locations
* mobile_app_backend
*:Mobile application
* multiple_booking
*:Multiple bookings
* news
*:News
* paid_events
*:Accept payments

* recap
*:Daily report
* secure
*:SSL
* status
*:Status
* unit_colors
*:Providers color coding
* user_license
*:Terms and conditions
* cancelation_policy
*:Cancellation Policy

See [[Custom_Features|Custom Features]] page for description for each Custom Feature.

</translate>

<translate>

== Examples ==

====getBookingDetails response====

An example of data returned by [[#getBookingDetails|getBookingDetails]] API method.

{
"id": "321",
"event_id": "5",
"event_name": "Massage",
"unit_id": "3",
"unit_name": "John",
"client_id": "1",
"client_name": "Bob",
"start_date_time": "2015-11-25 15:00:00",
"end_date_time": "2015-11-25 16:00:00",
"is_confirmed": "1",
"code": "h8v8w5ls",
"record_date": "2015-11-19 04:06:38",
"comment": null,
"company_login": "testzt",
"company_name": "My Cool Company",
"company_phone": "+1-555-55-55",
"company_email": "into@mycoolcompany.com",
"additional_fields": [{
"value": "on",
"field_name": "201a89517de509f6b3a60858918faac3",
"field_title": "Include washing",
"field_position": "4",
"field_type": "checkbox",
"field_id": "4"
}],
"comments": [],
"history": [{
"id": "536",
"sheduler_id": "321",
"datetime": "2015-11-19 11:06:38",
"type": "create",
"user_id": "1",
"agent": "SimplyBook.me\/55 CFNetwork\/758.0.2 Darwin\/15.0.0",
"ip": "213.174.0.53, 158.69.224.50:127.0.0.1",
"referer": "",
"login": "admin",
"firstname": "Mikhail",
"lastname": ""
}],
"status": {
"id": "3",
"name": "Fancy Status",
"description": null,
"color": "4cbadb",
"is_default": "1"
},
"location": {
"id": "1",
"title": "location",
"description": null,
"picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
"address1": null,
"address2": "Saint Margaret Street",
"city": "\u041b\u043e\u043d\u0434\u043e\u043d",
"zip": null,
"country_id": "GB",
"lat": "51.50013000000000000000",
"lng": "-0.12630500000000000000",
"phone": "44",
"position": "1",
"is_default": "1"
},
"price": [],
"promo": false
}

</translate>

<translate>

Location field is present in response only if [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.

Status field is present in response only if [[Custom_Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.

Price field is present in response only if [[Custom_Features#Accept_Payments|Accept payments Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a free service.


<code>additional_fields</code> field is present in response only if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a service with no intake forms.

</translate>

----

<translate>

====book response====

[[#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.

{
"require_confirm":false,
"bookings":[
{
"id":"434",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-30 13:00:00",
"end_date_time":"2015-12-30 13:30:00",
"is_confirmed":"1",
"code":"h8vc14ca",
"hash":"785cb8cce316e64765b94c05a635f4be"
},
{
"id":"435",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-31 13:00:00",
"end_date_time":"2015-12-31 13:30:00",
"is_confirmed":"1",
"code":"h8vc2pge",
"hash":"8b92d634541bfd93c0830967e56f4653"
},
{
"id":"436",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-04 13:00:00",
"end_date_time":"2016-01-04 13:30:00",
"is_confirmed":"1",
"code":"h8vc3urb",
"hash":"cd22a0bf183f7350e595988dd2486e5b"
},
{
"id":"437",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-05 13:00:00",
"end_date_time":"2016-01-05 13:30:00",
"is_confirmed":"1",
"code":"h8vc44d9",
"hash":"53f98ff4e4a0323aa907156c59c99362"
}
],
"batch_type":"batch_recurrent_booking",
"recurrent_batch_id":"1",
"batch_hash":"357178bce290381bb7235080941ec143"
}

</translate>

----

<translate>

====getCompanyInfo response====

An example of data returned by [[#getCompanyInfo|getCompanyInfo]] API method.

{
"login": "pierrecoetzee",
"name": "Pierre",
"description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"address1": "",
"address2": "Storey's Gate, ",
"city": "London",
"country_id": "GB",
"lat": "51.500435",
"lng": "-0.129811",
"email": "pierre.coe@gmail.com",
"phone": "",
"web": null,
"skip_address": null,
"logo": null,
"address": "GB, London, Storey's Gate, ",
"description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"timezone": "Europe London",
"show_in_client_timezone": false,
"timeframe": "60",
"timeline_type": "modern_week",
"allow_event_day_break": "0",
"allow_event_breaktime_break": "0"
}

<code>timeline_type</code> field can be one the following values:

* flexible
* modern
* flexible_week
* modern_week
* classic
* classes

</translate>

<translate>
Please note that <code>classic</code> timeline type is deprecated and not supported anymore.

<code>description</code> field contains raw data of company's description which can include HTML tags. <code>description_text</code> field contains only text information without HTML tags.

For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params|Company params section]].

</translate>
----

<translate>

<!--====getPluginPromoInfoByCode response====

{
"id": "1",
"title": "[service\/services] with [discount]% discount!",
"code": "yvuvugum",
"description": "We are offering [service\/services] with an amazing [discount]% discount! We are running this deal for a limited time only.",
"discount": "99.9999",
"start_date": "2015-12-23",
"expired_date": "2016-01-23",
"sheduler_start_date": "2015-12-23",
"sheduler_end_date": "2015-12-31",
"sheduler_start_time": "09:00:00",
"sheduler_end_time": "22:30:00",
"allow_usage_count": "20",
"fineprint_text": "Deal is limited for new clients only. Reward is claimable [client_claim_times_number] times per client. Deal is only claimable for the locations specified. Deal is cannot be combined with any other promotion. Must be redeemed prior to the expiration date shown on the deal.",
"redemption_text": "Present your confirmation code when you want to redeem your deal. You may either to print off your confirmation email or show your confirmation code by loggin into Simplybook on your mobile phone\/Pc.\r\n[promocode]\r\n[discount]\r\n[reward]\r\n[referal_qty]",
"headline": "[service\/services] with [discount]% discount!",
"image": null,
"allow_customer_count": "1",
"show_in_catalogue": "1",
"status": "active",
"plugin_promo_message_id": "1",
"common_promotion_id": "132",
"service_ids": ["1"]
}

<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
</translate>

Company administration service methods

2025-05-15T12:55:04Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Company administration service methods - SimplyBook.me
|description=Learn about service methods for internal company administration. Manage bookings tailored to your operations. Start here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

</translate>

<translate>

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.
</translate>

<translate>
The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>
Example

<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "Если Вы хотите попробовать себя в роли модели, но не определились с образом. 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>
</translate>

<translate>
Example of request with error response:

<pre>
Request
{
"jsonrpc": "2.0",
"method": "someNotExistingMethod",
"params":[],
"id":1
}

Response
{
"jsonrpc": "2.0",
"id":1,
"error": {
"code": -32601,
"message": "Method not found"
}
}
</pre>
</translate>

<translate>
All calls of public service methods should have additional HTTP header:

* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.

===Endpoint===

Use URL <code>https://user-api.simplybook.me/admin</code> for all administration service API calls.

===Authentication===

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.

== Methods ==

=== addClient ===

<code>addClient($clientData)</code>

Parameters:

* '''$clientData''' Object

Returns Integer.

</translate>

<translate>

Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id. If client record with specified data exists method will return an id of this record. Otherwise data
will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.Also email, phone number or both of them can be mandatory fields. You should call
<code>getCompanyParam('require_fields')</code> method to check which fields are required.

Method returns an error:

* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong

Example:

{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "FrancesTPerez@teleworm.us",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872
}

</translate>

<translate>
----

=== addDeviceToken ===

<code>addDeviceToken($token, $device)</code>

Parameters:

* '''$token''' String a device token string
* '''$device''' String a device type ('android' or 'apple')

Returns boolean.

Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
changes in already created bookings. Use either <code>'apple'</code> or <code>'android'</code> for <code>device</code>
parameter.

----
</translate>

<translate>

=== book ===

<code>book($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' string a date string in format 'Y-m-d'
* '''$startTime''' string a time string in format 'H:i:s'
* '''$endDate''' string a date string in format 'Y-m-d'
* '''$endTime''' string a time string in format 'H:i:s'
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.
* '''$count''' Integer bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
* '''$batchId''' Integer add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
* '''$recurringData''' Array - make booking recurrent. (optional)

Returns Object.

</translate>

<translate>

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>$clientTimeOffset</code> parameter as difference between company's time zone and
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specified). You should specify an <code>$additionalFields</code> parameter if service requires some intake forms (see [[Custom_Features#Intake_Forms|Intake Forms Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>

</translate>

<translate>

If [[Custom_Features#Multiple_Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
to check if Custom feature active and <code>[[#getLocationsList|getLocationsList()]]</code> method to get list of
available locations.

See [[#book response|example]] of <code>book</code> API method response.

See also:

* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

</translate>
----
<translate>
=== calculateEndTime ===

<code>calculateEndTime($startDateTime, $eventId, $unitId)</code>

Parameters:

* '''$startDateTime''' String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
* '''$eventId''' Integer
* '''$unitId''' Integer

Returns String|Boolean.

Returns end datetime if booking is available, else return false

----
</translate>

<translate>

=== cancelBatch ===

<code>cancelBatch($id, $bookingIds)</code>

Parameters:

* '''$id''' Integer identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
* '''$bookingIds''' Array ids of bookings included to batch.

Returns boolean.

Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in <code>$bookingIds</code> list is used for
information in notifications.

----
</translate>

<translate>

=== cancelBooking ===

<code>cancelBooking($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.

----
</translate>

<translate>

=== createBatch ===

<code>createBatch()</code>

No arguments.
Returns Integer.

Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[#book|book]]</code>
API method.

----
</translate>

<translate>

=== deleteDeviceToken ===

<code>deleteDeviceToken($token)</code>

Parameters:

* '''$token''' String - device token

Returns boolean.

Unsubscribe from push notifications service.

----
</translate>

<translate>

=== editBook ===

<code>editBook($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)</code>

Parameters:

* '''$shedulerId''' Integer an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' String - in Y-m-d format
* '''$startTime''' String - in H:i:s format
* '''$endDate''' String - in Y-m-d format
* '''$endTime''' String - in H:i:s format
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.

Returns Object.

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.

----
</translate>

<translate>

=== editClient ===

<code>editClient($clientId, $clientData)</code>

Parameters:

* '''$clientId''' Integer
* '''$clientData''' Object

Returns Integer.

Edits client's record. See <code>[[#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.

----
</translate>

<translate>

=== filterAvailableUnits ===

<code>filterAvailableUnits($eventId, $dateTime, $unitIds, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$unitIds'''
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom Feature.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>

----
</translate>

<translate>

=== getAdditionalFields ===

<code>getAdditionalFields($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Return intake forms for certain event if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.

----
</translate>

<translate>

=== getAnyUnitData ===

<code>getAnyUnitData()</code>

No arguments.
Returns Object|null.

Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}

----
</translate>

<translate>

=== getAvailableTimeIntervals ===

<code>getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: <code>{['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}</code>

----
</translate>

<translate>

=== getAvailableUnits ===

<code>getAvailableUnits($eventId, $dateTime, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: <code>[1, 2, 3]</code>

----

</translate>

<translate>

=== getBookingCancellationsInfo ===

<code>getBookingCancellationsInfo($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
* '''$dateEnd''' String a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.

Returns Array.

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. <code>"type"</code> field can be either
"create", "cancel" or "nopayment_cancel". If <code>"user_id"</code> not specified then bookings where created or
cancelled by admin or employee. Data with type <code>"nopayment_cancel"</code> represents bookings cancelled
automatically by system.Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]

----

</translate>

<translate>

=== getBookingComment ===

<code>getBookingComment($id)</code>

Parameters:

* '''$id''' Integer

Returns String.

Returns booking comment

----
</translate>

<translate>

=== getBookingDetails ===

<code>getBookingDetails($id)</code>

Parameters:

* '''$id''' integer booking id

Returns Array.

Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].

----
</translate>

<translate>

=== getBookingLimitUnavailableTimeInterval ===

<code>getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$eventId''' integer

Returns Array.

Returns time intervals not available for bookings because of configuration of [[Custom_Features#Limit_Bookings|Limit bookings]]
Custom Feature for period of time. Returns empty array if Custom Feature not available.

----
</translate>

<translate>

=== getBookingRevenue ===

<code>getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)</code>

Parameters:

* '''$dateStart''' string a date string in format 'Y-m-d'.
* '''$dateEnd''' string a date string in format 'Y-m-d'
* '''$unitGroupId''' integer
* '''$serviceId''' integer

Returns Array.

Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either
by unit or by service. Set <code>$dateStart</code> and <code>$dateEnd</code> to null to get data for current week.Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}

----
</translate>

<translate>

=== getBookingStats ===

<code>getBookingStats($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

----
</translate>

<translate>

=== getBookings ===

<code>getBookings($params)</code>

Parameters:

* '''$params'''

Returns Array.

Returns list of bookings filtered by given params. Filter params represented as object with following fields:* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking Custom Feature status.
*: If Custom Feature not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If Custom Feature active:
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}

----
</translate>

<translate>

=== getBookingsZapier ===

<code>getBookingsZapier()</code>

No arguments.
Returns Array.

Returns list of bookings filtered by given params

----
</translate>

<translate>

=== getCategoriesList ===

<code>getCategoriesList($isPublic)</code>

Parameters:

* '''$isPublic''' Boolean

Returns Array.

Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.

----

</translate>

<translate>

=== getClient ===

<code>getClient($clientId)</code>

Parameters:

* '''$clientId'''

Returns Array.

Returns client's data object. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getClientComments ===

<code>getClientComments($clientId, $shedulerId)</code>

Parameters:

* '''$clientId''' Integer
* '''$shedulerId''' Integer

Returns Array.

Returns list of all comments for given client

----

</translate>

<translate>

=== getClientList ===

<code>getClientList($searchString, $limit)</code>

Parameters:

* '''$searchString''' String
* '''$limit''' Integer

Returns Array.

Returns list of clients associated with company. You can use either phone number, email address or name as value
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
parameters to get all records. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getCompanyCurrency ===

<code>getCompanyCurrency()</code>

No arguments.
Returns String.

Returns company's currency as three chars code (ISO 4217).

----
</translate>

<translate>

=== getCompanyInfo ===

<code>getCompanyInfo()</code>

No arguments.
Returns Object.

Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].

----

</translate>

<translate>

=== getCompanyParam ===

<code>getCompanyParam($key)</code>

Parameters:

* '''$key''' String

Returns mixed.

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].

----

</translate>

<translate>

=== getCompanyParams ===

<code>getCompanyParams($keys)</code>

Parameters:

* '''$keys''' Array

Returns Array.

Returns company config values for keys. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].For non-existent and not-allowed params it will return false as result

----

</translate>

<translate>

=== getCompanyTimezoneOffset ===

<code>getCompanyTimezoneOffset()</code>

No arguments.
Returns array.

Returns company timezone offset and company timezone

----

</translate>

<translate>

=== getCountryList ===

<code>getCountryList()</code>

No arguments.
Returns Array.

Get list of all countries

----

</translate>

<translate>

=== getCountryPhoneCodes ===

<code>getCountryPhoneCodes()</code>

No arguments.
Returns Array.

Returns country phone code list

----

</translate>

<translate>

=== getCurrentTariffInfo ===

<code>getCurrentTariffInfo()</code>

No arguments.
Returns Array.

Returns all information about current tariff (subscription). For example:{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}

----

</translate>

<translate>

=== getCurrentUserDetails ===

<code>getCurrentUserDetails()</code>

No arguments. Returns Object.

Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on <code>group</code> property value. Most of API methods returns an error if user has low access
rights but not all. There are 4 roles:

* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode

<code>group</code> property can be one of the values:

* <code>shop_user</code> - "Senior Employee" access role
* <code>station_user</code> - "Junior Employee" access role
* <code>admin</code> - "Administrator" access role
* <code>viewer</code> - "Viewer" access role
* <code>reseller_company_admin</code> - reserved

Example:

{
"id": 1,
"login": admin,
"email": "admin@mycoolcompany.com";
"firstname": "Michail",
"lastname": " ",
"phone": "",
"group": "admin",
"is_blocked": 0,
"last_access_time": "2016-06-06 17:55:51",
"unit_group_id": null
}

----

</translate>

<translate>

=== getEventList ===

<code>getEventList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns company's events list. If <code>$asArray</code> is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
event's details object.

----

</translate>

<translate>

=== getFeedbacks ===

<code>getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)</code>

Parameters:

* '''$approvedOnly''' Boolean
* '''$reviewsOnly''' Boolean
* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Get list of feedbacks

----

</translate>

<translate>

=== getFirstWorkingDay ===

<code>getFirstWorkingDay($unitId)</code>

Parameters:

* '''$unitId''' Integer

Returns String.

Returns first working date for unit

----

</translate>

<translate>

=== getGoogleCalendarBusyTime ===

<code>getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in
this parameter. In this case method will use time value '23:59:59'.
* '''$unitId''' integer

Returns Array.

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
be returned. You should call <code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.Example:
<code>
[
{"from" : "2016-02-16 13:30:00",
"to" : "2016-02-16 16:00:00"},
...
]
</code>

----

</translate>

<translate>

=== getGoogleCalendarBusyTimeAvailableUnits ===

<code>getGoogleCalendarBusyTimeAvailableUnits()</code>

No arguments.
Returns Array.

Returns configured unit ids, allowed to sync busy time

----
</translate>

<translate>

=== getLastNotificationUpdate ===

<code>getLastNotificationUpdate($type)</code>

Parameters:

* '''$type''' String

Returns String.

Returns last update datetime

----

</translate>

<translate>

=== getLocationsList ===

<code>getLocationsList($isPublic, $asArray)</code>

Parameters:

* '''$isPublic''' Boolean Optional. Default value is '''false'''.
* '''$asArray''' boolean Optional. Default value is '''false'''.

Returns Array.

Returns available locations for company if Custom Feature [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.

This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.

----
</translate>

<translate>

=== getPluginList ===

<code>getPluginList()</code>

No arguments.
Returns Array.

Returns a list of all Custom Features associated with company with status.

----

</translate>

<translate>



</translate>

----

<translate>

=== getPluginStatuses ===

<code>getPluginStatuses($pluginNames)</code>

Parameters:

* '''$pluginNames''' Array

Returns Array.

Return Custom Feature status true if status active, else false. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== getRecentActions ===

<code>getRecentActions($lastOnly, $limit)</code>

Parameters:

* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Returns latest actions

</translate>

----

<translate>

=== getRecurringDatetimes ===

<code>getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData, $endDateTime)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String
* '''$time''' String
* '''$recurringData''' Array
* '''$endDateTime''' String (optional)

Returns Array.

Get list of dates for recurring booking

</translate>

----

<translate>

=== getRecurringSettings ===

<code>getRecurringSettings($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.

See also:

* [http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription]

</translate>

----

<translate>

=== getRegistrations ===

<code>getRegistrations($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getReservedTime ===

<code>getReservedTime($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$count''' Integer

Returns Object.

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom_Features#Calendar_Sync| Calendar Sync Custom Feature]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.

Example:
<pre>
{
"2016-02-05": [
{
"dd": [], // time slots from Google calendar
"events": [ // reserved time slots
{ "from": "16:00", "to": "16:30" },
{ "from": "16:30", "to": "17:00" },
... ],
"type": "reserved_time",
},
{
"events": [
{ "from": "09:00", "to": "09:30" },
{ "from": "09:30", "to": "10:00" },
... ],
"type": "not_worked_time"
}],
...
}
</pre>

</translate>

----

<translate>

=== getReservedTimeIntervals ===

<code>getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Integer|Array
* '''$count''' Integer

Returns Object.

Returns not available time
Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

</translate>

----

<translate>

=== getSocialCounterStats ===

<code>getSocialCounterStats($provider)</code>

Parameters:

* '''$provider''' String

Returns Integer.

Returns social counters value for your domain

</translate>

----

<translate>

=== getStartTimeMatrix ===

<code>getStartTimeMatrix($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available start time, taking into account breaktimes, start and end working time
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>

If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom_Features#Multiple_Locations|Multiple locations]] Custom Feature description for
more details.

</translate>

----

<translate>

=== getStatuses ===

<code>getStatuses()</code>

No arguments.
Returns Array.

Returns list of available statuses or an empty list if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== getTimeframe ===

<code>getTimeframe()</code>

No arguments.
Returns Integer.

Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need_to_change_interval_(timeframe)|here]].

</translate>

----

<translate>

=== getTimelineType ===

<code>getTimelineType()</code>

No arguments.
Returns String.

Returns company calendar layout type

</translate>

----

<translate>

=== getTopPerformers ===

<code>getTopPerformers()</code>

No arguments.
Returns Array.

Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

</translate>

----

<translate>

=== getTopServices ===

<code>getTopServices($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String
* '''$dateEnd''' String

Returns Array.

Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.

</translate>

----

<translate>

=== getUnitList ===

<code>getUnitList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns list of service performers. If <code>$asArray</code> is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
of event's details object.

</translate>

----

<translate>

=== getUnitWorkdayInfo ===

<code>getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workday info (date_start and date_end)

</translate>

----

<translate>

=== getUnitWorkingDurations ===

<code>getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return working durations

</translate>

----

<translate>

=== getVisitorStats ===

<code>getVisitorStats($groupBy)</code>

Parameters:

* '''$groupBy''' String

Returns Array.

Returns statistics about page visits if Custom Feature [[Custom_Features#Visitor_Counter|Visitor Counter Custom Feature]] enabled. Returns
an empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('counter')]]</code> API method
call to check if Custom Feature enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getWarnings ===

<code>getWarnings($lastOnly)</code>

Parameters:

* '''$lastOnly''' Boolean. Default value is '''false'''.

Returns Array.

Returns a list of objects represented system warnings. Each warning contains <code>warning_type</code> and <code>warning_text</code>
properties. <code>warning_text</code> property contains localized message. <code>warning_type</code> can be one of the values:

* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings

</translate>

----

<translate>

=== getWorkCalendar ===

<code>getWorkCalendar($year, $month, $unitId)</code>

Parameters:

* '''$year''' Integer
* '''$month''' Integer
* '''$unitId''' Integer

Returns Object.

Returns company work schedule as array
Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

</translate>

----

<translate>

=== getWorkDaysInfo ===

<code>getWorkDaysInfo($from, $to, $unitId, $eventId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$unitId''' Integer (optional)
* '''$eventId''' Integer (optional)
* '''$count''' Integer (optional)

Returns Object.

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from
service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:<pre>
{'2014-05-14' : [
{'from': '09:00:00', 'to': '13:00:00'},
{'from': '14:00:00', 'to': '19:00:00'}
] }
</pre>

Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.

</translate>

----

<translate>

=== getWorkDaysTimes ===

<code>getWorkDaysTimes($startDateTime, $endDateTime, $type = 'unit_group')</code>

Parameters:

* '''$startDateTime''' string
* '''$endDateTime''' string
* '''$type''' string. Optional. Either 'unit_group' or 'event'.

Returns Array.

Return busy time by unit id by Calendar Sync Custom Feature if enabled. Please note that this method may return not actual data because data synchronization between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.

</translate>

----

<translate>

=== getWorkload ===

<code>getWorkload($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]

</translate>

----

<translate>

=== isPluginActivated ===

<code>isPluginActivated($pluginName)</code>

Parameters:

* '''$pluginName''' String

Returns Boolean.

Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom_Features|Custom Features]] page for full Custom Features description. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== pluginApproveBookingApprove ===

<code>pluginApproveBookingApprove($id)</code>

Parameters:

* '''$id''' Integer

Returns Array.

Sets approve booking status to 'approved' if [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled and returns
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveBookingCancel ===

<code>pluginApproveBookingCancel($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Sets approve booking status to 'canceled' if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled and returns
true. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookings ===

<code>pluginApproveGetPendingBookings()</code>

No arguments.
Returns array.

Returns list of objects with information about bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]]
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookingsCount ===

<code>pluginApproveGetPendingBookingsCount()</code>

No arguments.
Returns Integer.

Returns count of bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled. Returns
0 if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
call to check if Custom Feature enabled.

</translate>

----

<translate>

=== setBookingComment ===

<code>setBookingComment($id, $comment)</code>

Parameters:

* '''$id''' Integer
* '''$comment''' String

Returns Integer.

Set booking comment

</translate>

----

<translate>

=== getBookingStatus ===

<code>getBookingStatus ($bookingId)</code>

Parameters:

* '''$bookingId''' Integer

Returns Array.

Returns an object of status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists

</translate>

----

<translate>

=== setStatus ===

<code>setStatus($bookingId, $statusId)</code>

Parameters:

* '''$bookingId''' Integer
* '''$statusId''' Integer

Returns Boolean.

Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== updateNotification ===

<code>updateNotification($type)</code>

Parameters:

* '''$type''' String

Returns .

Mark notifications as readed

</translate>

----

<translate>

=== setWorkDayInfo===

<code>setWorkDayInfo($info)</code>

Parameters:

* '''$info''' Array

Returns true on success

Set work day schedule for company|service|provider for week_day|date

Example:
<pre>
{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}

index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company
</pre>

</translate>

----

<translate>

=== deleteSpecialDay===

<code>deleteSpecialDay($date, $params = null)</code>

Parameters:

* '''$date''' String
* '''$params''' Array

Returns true on success

Delete special date if set

Example:
<pre>
'2017-08-21',
{
"unit_group_id":"",
"event_id":""
}
</pre>

</translate>

----

<translate>

=== addServiceProvider===

<code>addServiceProvider($data)</code>

Parameters:

* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Create new service provider

Example:
<pre>
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

</translate>

----

<translate>

=== editServiceProvider===

<code>editServiceProvider($id, $data)</code>

Parameters:

* '''$id''' Integer
* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Edit service provider
(there is no way to delete provider via API, in this case set is_active = 0)

Example:
<pre>
1,
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

-
</translate>

----

<translate>

== Constants ==

=== Error codes ===

See [[Errors handling]] for details.

* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32015 Passed event id is not reccuren
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Intake form values are wrong
* -32080 Appointemnt couldn't be found
* -32081 Service can't be performed when company does not work
* -32082 Service performer can't work when company does not work
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found

</translate>

----

<translate>

===Company params===

Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.

=====General params=====

Administration API inherits all [[Company public service methods#Company_params|keys]] allowed for public API and extends this list with keys:

* attach_ical
* auto_redirect
* auto_redirect_text
* blockchain_address
* blockchain_secret
* borgun_merchant_id
* borgun_payment_gateway_id
* borgun_secret_code
* client_batch_cancel_template
* client_batch_cancel_template_email
* client_batch_cancel_template_email_subject
* client_event_cancel_template
* client_event_cancel_template_email
* client_event_cancel_template_email_subject
* client_event_change_template
* client_event_change_template_email
* client_event_change_template_email_subject
* client_event_creation_template
* client_event_creation_template_email
* client_event_creation_template_email_subject
* client_event_group_creation_template
* client_event_group_creation_template_email
* client_event_group_creation_template_email_subject
* client_event_multiple_creation_template
* client_event_multiple_creation_template_email
* client_event_multiple_creation_template_email_subject
* client_group_notification_template
* client_group_notification_template_email
* client_group_notification_template_email_subject
* client_multiple_notification_template
* client_multiple_notification_template_email
* client_multiple_notification_template_email_subject
* client_notification_template
* client_notification_template_email
* client_notification_template_email_subject
* client_notification_time
* client_recurring_event_creation_template
* client_recurring_event_creation_template_email
* client_recurring_event_creation_template_email_subject
* common_limit_booking
* company_ga_tracking_id
* default_phone
* disconnect_on_timeout
* email_event_list
* email_events_list_template
* email_group_events_list_template
* event_list_style
* feed_back_interval
* feedback_invite_template_email
* feedback_invite_template_email_subject
* google_conversion_color
* google_conversion_currency
* google_conversion_format
* google_conversion_id
* google_conversion_label
* google_conversion_language
* google_conversion_value
* hide_working_hours_block
* include_cancel_link
* kortais_merchant
* kortais_secret_code
* kortais_terminal
* layout_background
* layout_background_repeat
* mobile_site_link
* mobile_site_link_title
* no_show_period
* on_success_button_link
* on_success_button_text
* recap_interval
* recap_send_after_time
* recap_send_canceled_bookings
* recap_send_new_bookings
* recap_send_upcomming_bookings
* send_cancel_to_client
* send_cancel_to_client_email
* send_cancel_to_unit
* send_cancel_to_unit_email
* send_contact_widget_email_notification
* send_contact_widget_sms_notification
* send_notify_to_client
* send_notify_to_client_email
* send_notify_to_unit
* send_notify_to_unit_email
* send_onchange_to_client
* send_onchange_to_client_email
* send_onchange_to_unit
* send_onchange_to_unit_email
* send_oncreate_to_client
* send_oncreate_to_client_email
* send_oncreate_to_unit
* send_oncreate_to_unit_email
* send_sms_if_push_enabled
* site_link
* site_link_title
* skip_limits_for_admin
* skip_show_mobile_app_ads
* skip_show_on_success_button
* sms_event_list
* sms_events_list_template
* sms_group_events_list_template
* unit_batch_cancel_template
* unit_batch_cancel_template_email
* unit_batch_cancel_template_email_subject
* unit_event_cancel_template
* unit_event_cancel_template_email
* unit_event_cancel_template_email_subject
* unit_event_change_template
* unit_event_change_template_email
* unit_event_change_template_email_subject
* unit_event_creation_template
* unit_event_creation_template_email
* unit_event_creation_template_email_subject
* unit_event_group_creation_template
* unit_event_group_creation_template_email
* unit_event_group_creation_template_email_subject
* unit_group_notification_template
* unit_group_notification_template_email
* unit_group_notification_template_email_subject
* unit_notification_template
* unit_notification_template_email
* unit_notification_template_email_subject
* unit_notification_time
* unit_recurring_event_creation_template
* unit_recurring_event_creation_template_email
* unit_recurring_event_creation_template_email_subject
* use_common_client_db
* user_confirmation
* user_public_layout
* user_public_theme
* waiting_video

</translate>

----

<translate>

=====Accept payments Custom Feature params=====

Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].

* allow_delay_payment
*: Allow delay payment option. Boolean.
* company_currency
*:
* hide_sale_tax
*: Hide sales tax option. Boolean.
* payment_timeout
*: Payment timeout option. String ("5 minutes", "1 hour", ...)
* sale_tax
*: Sales tax option. Integer. You should divide by 100 to get percent value.
* paypal_account
*: PayPal payment processor configuration. String.
* skrill_account
*: Skrill payment processor configuration parameter. String.
* skrill_secret
*: Skrill payment processor configuration parameter. String.
* zooz_app_id
*: ZooZ payment processor configuration parameter. String.
* zooz_app_key
*: ZooZ payment processor configuration parameter. String.
* dwolla_application_key
*: Dwolla payment processor configuration parameter. String.
* dwolla_id
*: Dwolla payment processor configuration parameter. String.
* dwolla_secret_key
*: Dwolla payment processor configuration parameter. String.
* liqpay_merchant_id
* liqpay_merchant_pass

</translate>

----

<translate>

=====Term & Conditions Custom Feature params=====

Read more about [[Custom_Features#Terms_and_Conditions|Terms and Conditions Custom Feature]].

* user_license_text
*: Terms and conditions text. String.

</translate>

----

<translate>

===Custom Features' identifiers===

Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[#isPluginActivated|isPluginActivated]]</code> and <code>[[#getPluginStatuses|getPluginStatuses]]</code> API methods.

* advanced_notification
*:Book Soon notification system
* any_unit
*:Any Employee selector
* api
*:API
* approve_booking
*:Approve booking
* back_to_site
*:Take me back home
* contact_widget
*:Contact widget
* counter
*:Visitor Counter
* custom_css
*:Custom CSS
* data_security
*:Clean history
* description
*:HTML description field for events
* event_category
*:Service categories
* event_field
*:Intake forms
* facebookImage
*:Facebook client info
* financial_dashboard
*:Insights
* google_analytics
*:Google Adwords and analytics
* google_calendar_export
*:Calendar sync
* group_booking
*:Group bookings
* hipaa
*:HIPAA
* limit_bookings
*:Limit bookings
* location
*:Multiple locations
* mobile_app_backend
*:Mobile application
* multiple_booking
*:Multiple bookings
* news
*:News
* paid_events
*:Accept payments

* recap
*:Daily report
* secure
*:SSL
* status
*:Status
* unit_colors
*:Providers color coding
* user_license
*:Terms and conditions
* cancelation_policy
*:Cancellation Policy

See [[Custom_Features|Custom Features]] page for description for each Custom Feature.

</translate>

<translate>

== Examples ==

====getBookingDetails response====

An example of data returned by [[#getBookingDetails|getBookingDetails]] API method.

{
"id": "321",
"event_id": "5",
"event_name": "Massage",
"unit_id": "3",
"unit_name": "John",
"client_id": "1",
"client_name": "Bob",
"start_date_time": "2015-11-25 15:00:00",
"end_date_time": "2015-11-25 16:00:00",
"is_confirmed": "1",
"code": "h8v8w5ls",
"record_date": "2015-11-19 04:06:38",
"comment": null,
"company_login": "testzt",
"company_name": "My Cool Company",
"company_phone": "+1-555-55-55",
"company_email": "into@mycoolcompany.com",
"additional_fields": [{
"value": "on",
"field_name": "201a89517de509f6b3a60858918faac3",
"field_title": "Include washing",
"field_position": "4",
"field_type": "checkbox",
"field_id": "4"
}],
"comments": [],
"history": [{
"id": "536",
"sheduler_id": "321",
"datetime": "2015-11-19 11:06:38",
"type": "create",
"user_id": "1",
"agent": "SimplyBook.me\/55 CFNetwork\/758.0.2 Darwin\/15.0.0",
"ip": "213.174.0.53, 158.69.224.50:127.0.0.1",
"referer": "",
"login": "admin",
"firstname": "Mikhail",
"lastname": ""
}],
"status": {
"id": "3",
"name": "Fancy Status",
"description": null,
"color": "4cbadb",
"is_default": "1"
},
"location": {
"id": "1",
"title": "location",
"description": null,
"picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
"address1": null,
"address2": "Saint Margaret Street",
"city": "\u041b\u043e\u043d\u0434\u043e\u043d",
"zip": null,
"country_id": "GB",
"lat": "51.50013000000000000000",
"lng": "-0.12630500000000000000",
"phone": "44",
"position": "1",
"is_default": "1"
},
"price": [],
"promo": false
}

</translate>

<translate>

Location field is present in response only if [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.

Status field is present in response only if [[Custom_Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.

Price field is present in response only if [[Custom_Features#Accept_Payments|Accept payments Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a free service.


<code>additional_fields</code> field is present in response only if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a service with no intake forms.

</translate>

----

<translate>

====book response====

[[#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.

{
"require_confirm":false,
"bookings":[
{
"id":"434",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-30 13:00:00",
"end_date_time":"2015-12-30 13:30:00",
"is_confirmed":"1",
"code":"h8vc14ca",
"hash":"785cb8cce316e64765b94c05a635f4be"
},
{
"id":"435",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-31 13:00:00",
"end_date_time":"2015-12-31 13:30:00",
"is_confirmed":"1",
"code":"h8vc2pge",
"hash":"8b92d634541bfd93c0830967e56f4653"
},
{
"id":"436",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-04 13:00:00",
"end_date_time":"2016-01-04 13:30:00",
"is_confirmed":"1",
"code":"h8vc3urb",
"hash":"cd22a0bf183f7350e595988dd2486e5b"
},
{
"id":"437",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-05 13:00:00",
"end_date_time":"2016-01-05 13:30:00",
"is_confirmed":"1",
"code":"h8vc44d9",
"hash":"53f98ff4e4a0323aa907156c59c99362"
}
],
"batch_type":"batch_recurrent_booking",
"recurrent_batch_id":"1",
"batch_hash":"357178bce290381bb7235080941ec143"
}

</translate>

----

<translate>

====getCompanyInfo response====

An example of data returned by [[#getCompanyInfo|getCompanyInfo]] API method.

{
"login": "pierrecoetzee",
"name": "Pierre",
"description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"address1": "",
"address2": "Storey's Gate, ",
"city": "London",
"country_id": "GB",
"lat": "51.500435",
"lng": "-0.129811",
"email": "pierre.coe@gmail.com",
"phone": "",
"web": null,
"skip_address": null,
"logo": null,
"address": "GB, London, Storey's Gate, ",
"description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"timezone": "Europe London",
"show_in_client_timezone": false,
"timeframe": "60",
"timeline_type": "modern_week",
"allow_event_day_break": "0",
"allow_event_breaktime_break": "0"
}

<code>timeline_type</code> field can be one the following values:

* flexible
* modern
* flexible_week
* modern_week
* classic
* classes

</translate>

<translate>
Please note that <code>classic</code> timeline type is deprecated and not supported anymore.

<code>description</code> field contains raw data of company's description which can include HTML tags. <code>description_text</code> field contains only text information without HTML tags.

For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params|Company params section]].

</translate>
----

<translate>

<!--====getPluginPromoInfoByCode response====

{
"id": "1",
"title": "[service\/services] with [discount]% discount!",
"code": "yvuvugum",
"description": "We are offering [service\/services] with an amazing [discount]% discount! We are running this deal for a limited time only.",
"discount": "99.9999",
"start_date": "2015-12-23",
"expired_date": "2016-01-23",
"sheduler_start_date": "2015-12-23",
"sheduler_end_date": "2015-12-31",
"sheduler_start_time": "09:00:00",
"sheduler_end_time": "22:30:00",
"allow_usage_count": "20",
"fineprint_text": "Deal is limited for new clients only. Reward is claimable [client_claim_times_number] times per client. Deal is only claimable for the locations specified. Deal is cannot be combined with any other promotion. Must be redeemed prior to the expiration date shown on the deal.",
"redemption_text": "Present your confirmation code when you want to redeem your deal. You may either to print off your confirmation email or show your confirmation code by loggin into Simplybook on your mobile phone\/Pc.\r\n[promocode]\r\n[discount]\r\n[reward]\r\n[referal_qty]",
"headline": "[service\/services] with [discount]% discount!",
"image": null,
"allow_customer_count": "1",
"show_in_catalogue": "1",
"status": "active",
"plugin_promo_message_id": "1",
"common_promotion_id": "132",
"service_ids": ["1"]
}

<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
</translate>

Company administration service methods

2025-05-15T12:54:01Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Company administration service methods - SimplyBook.me
|description=Learn about service methods for internal company administration. Manage bookings tailored to your operations. Start here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

</translate>

<translate>

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.
</translate>

<translate>
The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.
</translate>

<translate>
Example

<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "Если Вы хотите попробовать себя в роли модели, но не определились с образом. 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>
</translate>

<translate>
Example of request with error response:

<pre>
Request
{
"jsonrpc": "2.0",
"method": "someNotExistingMethod",
"params":[],
"id":1
}

Response
{
"jsonrpc": "2.0",
"id":1,
"error": {
"code": -32601,
"message": "Method not found"
}
}
</pre>
</translate>

<translate>
All calls of public service methods should have additional HTTP header:

* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.

===Endpoint===

Use URL <code>https://user-api.simplybook.me/admin</code> for all administration service API calls.

===Authentication===

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.

== Methods ==

=== addClient ===

<code>addClient($clientData)</code>

Parameters:

* '''$clientData''' Object

Returns Integer.

</translate>

<translate>

Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id. If client record with specified data exists method will return an id of this record. Otherwise data
will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.Also email, phone number or both of them can be mandatory fields. You should call
<code>getCompanyParam('require_fields')</code> method to check which fields are required.

Method returns an error:

* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong

Example:

{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "FrancesTPerez@teleworm.us",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872
}

</translate>

<translate>
----

=== addDeviceToken ===

<code>addDeviceToken($token, $device)</code>

Parameters:

* '''$token''' String a device token string
* '''$device''' String a device type ('android' or 'apple')

Returns boolean.

Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
changes in already created bookings. Use either <code>'apple'</code> or <code>'android'</code> for <code>device</code>
parameter.

----
</translate>

<translate>

=== book ===

<code>book($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' string a date string in format 'Y-m-d'
* '''$startTime''' string a time string in format 'H:i:s'
* '''$endDate''' string a date string in format 'Y-m-d'
* '''$endTime''' string a time string in format 'H:i:s'
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.
* '''$count''' Integer bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
* '''$batchId''' Integer add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
* '''$recurringData''' Array - make booking recurrent. (optional)

Returns Object.

</translate>

<translate>

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>$clientTimeOffset</code> parameter as difference between company's time zone and
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specified). You should specify an <code>$additionalFields</code> parameter if service requires some intake forms (see [[Custom_Features#Intake_Forms|Intake Forms Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>

</translate>

<translate>

If [[Custom_Features#Multiple_Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
to check if Custom feature active and <code>[[#getLocationsList|getLocationsList()]]</code> method to get list of
available locations.

See [[#book response|example]] of <code>book</code> API method response.

See also:

* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

----
</translate>

<translate>

=== calculateEndTime ===

<code>calculateEndTime($startDateTime, $eventId, $unitId)</code>

Parameters:

* '''$startDateTime''' String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
* '''$eventId''' Integer
* '''$unitId''' Integer

Returns String|Boolean.

Returns end datetime if booking is available, else return false

----
</translate>

<translate>

=== cancelBatch ===

<code>cancelBatch($id, $bookingIds)</code>

Parameters:

* '''$id''' Integer identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
* '''$bookingIds''' Array ids of bookings included to batch.

Returns boolean.

Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in <code>$bookingIds</code> list is used for
information in notifications.

----
</translate>

<translate>

=== cancelBooking ===

<code>cancelBooking($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.

----
</translate>

<translate>

=== createBatch ===

<code>createBatch()</code>

No arguments.
Returns Integer.

Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[#book|book]]</code>
API method.

----
</translate>

<translate>

=== deleteDeviceToken ===

<code>deleteDeviceToken($token)</code>

Parameters:

* '''$token''' String - device token

Returns boolean.

Unsubscribe from push notifications service.

----
</translate>

<translate>

=== editBook ===

<code>editBook($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)</code>

Parameters:

* '''$shedulerId''' Integer an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' String - in Y-m-d format
* '''$startTime''' String - in H:i:s format
* '''$endDate''' String - in Y-m-d format
* '''$endTime''' String - in H:i:s format
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.

Returns Object.

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.

----
</translate>

<translate>

=== editClient ===

<code>editClient($clientId, $clientData)</code>

Parameters:

* '''$clientId''' Integer
* '''$clientData''' Object

Returns Integer.

Edits client's record. See <code>[[#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.

----
</translate>

<translate>

=== filterAvailableUnits ===

<code>filterAvailableUnits($eventId, $dateTime, $unitIds, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$unitIds'''
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom Feature.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>

----
</translate>

<translate>

=== getAdditionalFields ===

<code>getAdditionalFields($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Return intake forms for certain event if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.

----
</translate>

<translate>

=== getAnyUnitData ===

<code>getAnyUnitData()</code>

No arguments.
Returns Object|null.

Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}

----
</translate>

<translate>

=== getAvailableTimeIntervals ===

<code>getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: <code>{['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}</code>

----
</translate>

<translate>

=== getAvailableUnits ===

<code>getAvailableUnits($eventId, $dateTime, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: <code>[1, 2, 3]</code>

----

</translate>

<translate>

=== getBookingCancellationsInfo ===

<code>getBookingCancellationsInfo($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
* '''$dateEnd''' String a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.

Returns Array.

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. <code>"type"</code> field can be either
"create", "cancel" or "nopayment_cancel". If <code>"user_id"</code> not specified then bookings where created or
cancelled by admin or employee. Data with type <code>"nopayment_cancel"</code> represents bookings cancelled
automatically by system.Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]

----

</translate>

<translate>

=== getBookingComment ===

<code>getBookingComment($id)</code>

Parameters:

* '''$id''' Integer

Returns String.

Returns booking comment

----
</translate>

<translate>

=== getBookingDetails ===

<code>getBookingDetails($id)</code>

Parameters:

* '''$id''' integer booking id

Returns Array.

Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].

----
</translate>

<translate>

=== getBookingLimitUnavailableTimeInterval ===

<code>getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$eventId''' integer

Returns Array.

Returns time intervals not available for bookings because of configuration of [[Custom_Features#Limit_Bookings|Limit bookings]]
Custom Feature for period of time. Returns empty array if Custom Feature not available.

----
</translate>

<translate>

=== getBookingRevenue ===

<code>getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)</code>

Parameters:

* '''$dateStart''' string a date string in format 'Y-m-d'.
* '''$dateEnd''' string a date string in format 'Y-m-d'
* '''$unitGroupId''' integer
* '''$serviceId''' integer

Returns Array.

Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either
by unit or by service. Set <code>$dateStart</code> and <code>$dateEnd</code> to null to get data for current week.Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}

----
</translate>

<translate>

=== getBookingStats ===

<code>getBookingStats($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

----
</translate>

<translate>

=== getBookings ===

<code>getBookings($params)</code>

Parameters:

* '''$params'''

Returns Array.

Returns list of bookings filtered by given params. Filter params represented as object with following fields:* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking Custom Feature status.
*: If Custom Feature not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If Custom Feature active:
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}

----
</translate>

<translate>

=== getBookingsZapier ===

<code>getBookingsZapier()</code>

No arguments.
Returns Array.

Returns list of bookings filtered by given params

----
</translate>

<translate>

=== getCategoriesList ===

<code>getCategoriesList($isPublic)</code>

Parameters:

* '''$isPublic''' Boolean

Returns Array.

Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.

----

</translate>

<translate>

=== getClient ===

<code>getClient($clientId)</code>

Parameters:

* '''$clientId'''

Returns Array.

Returns client's data object. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getClientComments ===

<code>getClientComments($clientId, $shedulerId)</code>

Parameters:

* '''$clientId''' Integer
* '''$shedulerId''' Integer

Returns Array.

Returns list of all comments for given client

----

</translate>

<translate>

=== getClientList ===

<code>getClientList($searchString, $limit)</code>

Parameters:

* '''$searchString''' String
* '''$limit''' Integer

Returns Array.

Returns list of clients associated with company. You can use either phone number, email address or name as value
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
parameters to get all records. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getCompanyCurrency ===

<code>getCompanyCurrency()</code>

No arguments.
Returns String.

Returns company's currency as three chars code (ISO 4217).

----
</translate>

<translate>

=== getCompanyInfo ===

<code>getCompanyInfo()</code>

No arguments.
Returns Object.

Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].

----

</translate>

<translate>

=== getCompanyParam ===

<code>getCompanyParam($key)</code>

Parameters:

* '''$key''' String

Returns mixed.

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].

----

</translate>

<translate>

=== getCompanyParams ===

<code>getCompanyParams($keys)</code>

Parameters:

* '''$keys''' Array

Returns Array.

Returns company config values for keys. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].For non-existent and not-allowed params it will return false as result

----

</translate>

<translate>

=== getCompanyTimezoneOffset ===

<code>getCompanyTimezoneOffset()</code>

No arguments.
Returns array.

Returns company timezone offset and company timezone

----

</translate>

<translate>

=== getCountryList ===

<code>getCountryList()</code>

No arguments.
Returns Array.

Get list of all countries

----

</translate>

<translate>

=== getCountryPhoneCodes ===

<code>getCountryPhoneCodes()</code>

No arguments.
Returns Array.

Returns country phone code list

----

</translate>

<translate>

=== getCurrentTariffInfo ===

<code>getCurrentTariffInfo()</code>

No arguments.
Returns Array.

Returns all information about current tariff (subscription). For example:{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}

----

</translate>

<translate>

=== getCurrentUserDetails ===

<code>getCurrentUserDetails()</code>

No arguments. Returns Object.

Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on <code>group</code> property value. Most of API methods returns an error if user has low access
rights but not all. There are 4 roles:

* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode

<code>group</code> property can be one of the values:

* <code>shop_user</code> - "Senior Employee" access role
* <code>station_user</code> - "Junior Employee" access role
* <code>admin</code> - "Administrator" access role
* <code>viewer</code> - "Viewer" access role
* <code>reseller_company_admin</code> - reserved

Example:

{
"id": 1,
"login": admin,
"email": "admin@mycoolcompany.com";
"firstname": "Michail",
"lastname": " ",
"phone": "",
"group": "admin",
"is_blocked": 0,
"last_access_time": "2016-06-06 17:55:51",
"unit_group_id": null
}

----

</translate>

<translate>

=== getEventList ===

<code>getEventList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns company's events list. If <code>$asArray</code> is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
event's details object.

----

</translate>

<translate>

=== getFeedbacks ===

<code>getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)</code>

Parameters:

* '''$approvedOnly''' Boolean
* '''$reviewsOnly''' Boolean
* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Get list of feedbacks

----

</translate>

<translate>

=== getFirstWorkingDay ===

<code>getFirstWorkingDay($unitId)</code>

Parameters:

* '''$unitId''' Integer

Returns String.

Returns first working date for unit

----

</translate>

<translate>

=== getGoogleCalendarBusyTime ===

<code>getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in
this parameter. In this case method will use time value '23:59:59'.
* '''$unitId''' integer

Returns Array.

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
be returned. You should call <code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.Example:
<code>
[
{"from" : "2016-02-16 13:30:00",
"to" : "2016-02-16 16:00:00"},
...
]
</code>

----

</translate>

<translate>

=== getGoogleCalendarBusyTimeAvailableUnits ===

<code>getGoogleCalendarBusyTimeAvailableUnits()</code>

No arguments.
Returns Array.

Returns configured unit ids, allowed to sync busy time

----
</translate>

<translate>

=== getLastNotificationUpdate ===

<code>getLastNotificationUpdate($type)</code>

Parameters:

* '''$type''' String

Returns String.

Returns last update datetime

----

</translate>

<translate>

=== getLocationsList ===

<code>getLocationsList($isPublic, $asArray)</code>

Parameters:

* '''$isPublic''' Boolean Optional. Default value is '''false'''.
* '''$asArray''' boolean Optional. Default value is '''false'''.

Returns Array.

Returns available locations for company if Custom Feature [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.

This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.

----
</translate>

<translate>

=== getPluginList ===

<code>getPluginList()</code>

No arguments.
Returns Array.

Returns a list of all Custom Features associated with company with status.

----

</translate>

<translate>



</translate>

----

<translate>

=== getPluginStatuses ===

<code>getPluginStatuses($pluginNames)</code>

Parameters:

* '''$pluginNames''' Array

Returns Array.

Return Custom Feature status true if status active, else false. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== getRecentActions ===

<code>getRecentActions($lastOnly, $limit)</code>

Parameters:

* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Returns latest actions

</translate>

----

<translate>

=== getRecurringDatetimes ===

<code>getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData, $endDateTime)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String
* '''$time''' String
* '''$recurringData''' Array
* '''$endDateTime''' String (optional)

Returns Array.

Get list of dates for recurring booking

</translate>

----

<translate>

=== getRecurringSettings ===

<code>getRecurringSettings($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.

See also:

* [http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription]

</translate>

----

<translate>

=== getRegistrations ===

<code>getRegistrations($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getReservedTime ===

<code>getReservedTime($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$count''' Integer

Returns Object.

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom_Features#Calendar_Sync| Calendar Sync Custom Feature]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.

Example:
<pre>
{
"2016-02-05": [
{
"dd": [], // time slots from Google calendar
"events": [ // reserved time slots
{ "from": "16:00", "to": "16:30" },
{ "from": "16:30", "to": "17:00" },
... ],
"type": "reserved_time",
},
{
"events": [
{ "from": "09:00", "to": "09:30" },
{ "from": "09:30", "to": "10:00" },
... ],
"type": "not_worked_time"
}],
...
}
</pre>

</translate>

----

<translate>

=== getReservedTimeIntervals ===

<code>getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Integer|Array
* '''$count''' Integer

Returns Object.

Returns not available time
Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

</translate>

----

<translate>

=== getSocialCounterStats ===

<code>getSocialCounterStats($provider)</code>

Parameters:

* '''$provider''' String

Returns Integer.

Returns social counters value for your domain

</translate>

----

<translate>

=== getStartTimeMatrix ===

<code>getStartTimeMatrix($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available start time, taking into account breaktimes, start and end working time
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>

If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom_Features#Multiple_Locations|Multiple locations]] Custom Feature description for
more details.

</translate>

----

<translate>

=== getStatuses ===

<code>getStatuses()</code>

No arguments.
Returns Array.

Returns list of available statuses or an empty list if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== getTimeframe ===

<code>getTimeframe()</code>

No arguments.
Returns Integer.

Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need_to_change_interval_(timeframe)|here]].

</translate>

----

<translate>

=== getTimelineType ===

<code>getTimelineType()</code>

No arguments.
Returns String.

Returns company calendar layout type

</translate>

----

<translate>

=== getTopPerformers ===

<code>getTopPerformers()</code>

No arguments.
Returns Array.

Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

</translate>

----

<translate>

=== getTopServices ===

<code>getTopServices($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String
* '''$dateEnd''' String

Returns Array.

Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.

</translate>

----

<translate>

=== getUnitList ===

<code>getUnitList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns list of service performers. If <code>$asArray</code> is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
of event's details object.

</translate>

----

<translate>

=== getUnitWorkdayInfo ===

<code>getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workday info (date_start and date_end)

</translate>

----

<translate>

=== getUnitWorkingDurations ===

<code>getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return working durations

</translate>

----

<translate>

=== getVisitorStats ===

<code>getVisitorStats($groupBy)</code>

Parameters:

* '''$groupBy''' String

Returns Array.

Returns statistics about page visits if Custom Feature [[Custom_Features#Visitor_Counter|Visitor Counter Custom Feature]] enabled. Returns
an empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('counter')]]</code> API method
call to check if Custom Feature enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getWarnings ===

<code>getWarnings($lastOnly)</code>

Parameters:

* '''$lastOnly''' Boolean. Default value is '''false'''.

Returns Array.

Returns a list of objects represented system warnings. Each warning contains <code>warning_type</code> and <code>warning_text</code>
properties. <code>warning_text</code> property contains localized message. <code>warning_type</code> can be one of the values:

* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings

</translate>

----

<translate>

=== getWorkCalendar ===

<code>getWorkCalendar($year, $month, $unitId)</code>

Parameters:

* '''$year''' Integer
* '''$month''' Integer
* '''$unitId''' Integer

Returns Object.

Returns company work schedule as array
Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

</translate>

----

<translate>

=== getWorkDaysInfo ===

<code>getWorkDaysInfo($from, $to, $unitId, $eventId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$unitId''' Integer (optional)
* '''$eventId''' Integer (optional)
* '''$count''' Integer (optional)

Returns Object.

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from
service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:<pre>
{'2014-05-14' : [
{'from': '09:00:00', 'to': '13:00:00'},
{'from': '14:00:00', 'to': '19:00:00'}
] }
</pre>

Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.

</translate>

----

<translate>

=== getWorkDaysTimes ===

<code>getWorkDaysTimes($startDateTime, $endDateTime, $type = 'unit_group')</code>

Parameters:

* '''$startDateTime''' string
* '''$endDateTime''' string
* '''$type''' string. Optional. Either 'unit_group' or 'event'.

Returns Array.

Return busy time by unit id by Calendar Sync Custom Feature if enabled. Please note that this method may return not actual data because data synchronization between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.

</translate>

----

<translate>

=== getWorkload ===

<code>getWorkload($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]

</translate>

----

<translate>

=== isPluginActivated ===

<code>isPluginActivated($pluginName)</code>

Parameters:

* '''$pluginName''' String

Returns Boolean.

Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom_Features|Custom Features]] page for full Custom Features description. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== pluginApproveBookingApprove ===

<code>pluginApproveBookingApprove($id)</code>

Parameters:

* '''$id''' Integer

Returns Array.

Sets approve booking status to 'approved' if [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled and returns
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveBookingCancel ===

<code>pluginApproveBookingCancel($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Sets approve booking status to 'canceled' if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled and returns
true. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookings ===

<code>pluginApproveGetPendingBookings()</code>

No arguments.
Returns array.

Returns list of objects with information about bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]]
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookingsCount ===

<code>pluginApproveGetPendingBookingsCount()</code>

No arguments.
Returns Integer.

Returns count of bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled. Returns
0 if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
call to check if Custom Feature enabled.

</translate>

----

<translate>

=== setBookingComment ===

<code>setBookingComment($id, $comment)</code>

Parameters:

* '''$id''' Integer
* '''$comment''' String

Returns Integer.

Set booking comment

</translate>

----

<translate>

=== getBookingStatus ===

<code>getBookingStatus ($bookingId)</code>

Parameters:

* '''$bookingId''' Integer

Returns Array.

Returns an object of status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists

</translate>

----

<translate>

=== setStatus ===

<code>setStatus($bookingId, $statusId)</code>

Parameters:

* '''$bookingId''' Integer
* '''$statusId''' Integer

Returns Boolean.

Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== updateNotification ===

<code>updateNotification($type)</code>

Parameters:

* '''$type''' String

Returns .

Mark notifications as readed

</translate>

----

<translate>

=== setWorkDayInfo===

<code>setWorkDayInfo($info)</code>

Parameters:

* '''$info''' Array

Returns true on success

Set work day schedule for company|service|provider for week_day|date

Example:
<pre>
{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}

index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company
</pre>

</translate>

----

<translate>

=== deleteSpecialDay===

<code>deleteSpecialDay($date, $params = null)</code>

Parameters:

* '''$date''' String
* '''$params''' Array

Returns true on success

Delete special date if set

Example:
<pre>
'2017-08-21',
{
"unit_group_id":"",
"event_id":""
}
</pre>

</translate>

----

<translate>

=== addServiceProvider===

<code>addServiceProvider($data)</code>

Parameters:

* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Create new service provider

Example:
<pre>
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

</translate>

----

<translate>

=== editServiceProvider===

<code>editServiceProvider($id, $data)</code>

Parameters:

* '''$id''' Integer
* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Edit service provider
(there is no way to delete provider via API, in this case set is_active = 0)

Example:
<pre>
1,
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

-
</translate>

----

<translate>

== Constants ==

=== Error codes ===

See [[Errors handling]] for details.

* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32015 Passed event id is not reccuren
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Intake form values are wrong
* -32080 Appointemnt couldn't be found
* -32081 Service can't be performed when company does not work
* -32082 Service performer can't work when company does not work
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found

</translate>

----

<translate>

===Company params===

Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.

=====General params=====

Administration API inherits all [[Company public service methods#Company_params|keys]] allowed for public API and extends this list with keys:

* attach_ical
* auto_redirect
* auto_redirect_text
* blockchain_address
* blockchain_secret
* borgun_merchant_id
* borgun_payment_gateway_id
* borgun_secret_code
* client_batch_cancel_template
* client_batch_cancel_template_email
* client_batch_cancel_template_email_subject
* client_event_cancel_template
* client_event_cancel_template_email
* client_event_cancel_template_email_subject
* client_event_change_template
* client_event_change_template_email
* client_event_change_template_email_subject
* client_event_creation_template
* client_event_creation_template_email
* client_event_creation_template_email_subject
* client_event_group_creation_template
* client_event_group_creation_template_email
* client_event_group_creation_template_email_subject
* client_event_multiple_creation_template
* client_event_multiple_creation_template_email
* client_event_multiple_creation_template_email_subject
* client_group_notification_template
* client_group_notification_template_email
* client_group_notification_template_email_subject
* client_multiple_notification_template
* client_multiple_notification_template_email
* client_multiple_notification_template_email_subject
* client_notification_template
* client_notification_template_email
* client_notification_template_email_subject
* client_notification_time
* client_recurring_event_creation_template
* client_recurring_event_creation_template_email
* client_recurring_event_creation_template_email_subject
* common_limit_booking
* company_ga_tracking_id
* default_phone
* disconnect_on_timeout
* email_event_list
* email_events_list_template
* email_group_events_list_template
* event_list_style
* feed_back_interval
* feedback_invite_template_email
* feedback_invite_template_email_subject
* google_conversion_color
* google_conversion_currency
* google_conversion_format
* google_conversion_id
* google_conversion_label
* google_conversion_language
* google_conversion_value
* hide_working_hours_block
* include_cancel_link
* kortais_merchant
* kortais_secret_code
* kortais_terminal
* layout_background
* layout_background_repeat
* mobile_site_link
* mobile_site_link_title
* no_show_period
* on_success_button_link
* on_success_button_text
* recap_interval
* recap_send_after_time
* recap_send_canceled_bookings
* recap_send_new_bookings
* recap_send_upcomming_bookings
* send_cancel_to_client
* send_cancel_to_client_email
* send_cancel_to_unit
* send_cancel_to_unit_email
* send_contact_widget_email_notification
* send_contact_widget_sms_notification
* send_notify_to_client
* send_notify_to_client_email
* send_notify_to_unit
* send_notify_to_unit_email
* send_onchange_to_client
* send_onchange_to_client_email
* send_onchange_to_unit
* send_onchange_to_unit_email
* send_oncreate_to_client
* send_oncreate_to_client_email
* send_oncreate_to_unit
* send_oncreate_to_unit_email
* send_sms_if_push_enabled
* site_link
* site_link_title
* skip_limits_for_admin
* skip_show_mobile_app_ads
* skip_show_on_success_button
* sms_event_list
* sms_events_list_template
* sms_group_events_list_template
* unit_batch_cancel_template
* unit_batch_cancel_template_email
* unit_batch_cancel_template_email_subject
* unit_event_cancel_template
* unit_event_cancel_template_email
* unit_event_cancel_template_email_subject
* unit_event_change_template
* unit_event_change_template_email
* unit_event_change_template_email_subject
* unit_event_creation_template
* unit_event_creation_template_email
* unit_event_creation_template_email_subject
* unit_event_group_creation_template
* unit_event_group_creation_template_email
* unit_event_group_creation_template_email_subject
* unit_group_notification_template
* unit_group_notification_template_email
* unit_group_notification_template_email_subject
* unit_notification_template
* unit_notification_template_email
* unit_notification_template_email_subject
* unit_notification_time
* unit_recurring_event_creation_template
* unit_recurring_event_creation_template_email
* unit_recurring_event_creation_template_email_subject
* use_common_client_db
* user_confirmation
* user_public_layout
* user_public_theme
* waiting_video

</translate>

----

<translate>

=====Accept payments Custom Feature params=====

Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].

* allow_delay_payment
*: Allow delay payment option. Boolean.
* company_currency
*:
* hide_sale_tax
*: Hide sales tax option. Boolean.
* payment_timeout
*: Payment timeout option. String ("5 minutes", "1 hour", ...)
* sale_tax
*: Sales tax option. Integer. You should divide by 100 to get percent value.
* paypal_account
*: PayPal payment processor configuration. String.
* skrill_account
*: Skrill payment processor configuration parameter. String.
* skrill_secret
*: Skrill payment processor configuration parameter. String.
* zooz_app_id
*: ZooZ payment processor configuration parameter. String.
* zooz_app_key
*: ZooZ payment processor configuration parameter. String.
* dwolla_application_key
*: Dwolla payment processor configuration parameter. String.
* dwolla_id
*: Dwolla payment processor configuration parameter. String.
* dwolla_secret_key
*: Dwolla payment processor configuration parameter. String.
* liqpay_merchant_id
* liqpay_merchant_pass

</translate>

----

<translate>

=====Term & Conditions Custom Feature params=====

Read more about [[Custom_Features#Terms_and_Conditions|Terms and Conditions Custom Feature]].

* user_license_text
*: Terms and conditions text. String.

</translate>

----

<translate>

===Custom Features' identifiers===

Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[#isPluginActivated|isPluginActivated]]</code> and <code>[[#getPluginStatuses|getPluginStatuses]]</code> API methods.

* advanced_notification
*:Book Soon notification system
* any_unit
*:Any Employee selector
* api
*:API
* approve_booking
*:Approve booking
* back_to_site
*:Take me back home
* contact_widget
*:Contact widget
* counter
*:Visitor Counter
* custom_css
*:Custom CSS
* data_security
*:Clean history
* description
*:HTML description field for events
* event_category
*:Service categories
* event_field
*:Intake forms
* facebookImage
*:Facebook client info
* financial_dashboard
*:Insights
* google_analytics
*:Google Adwords and analytics
* google_calendar_export
*:Calendar sync
* group_booking
*:Group bookings
* hipaa
*:HIPAA
* limit_bookings
*:Limit bookings
* location
*:Multiple locations
* mobile_app_backend
*:Mobile application
* multiple_booking
*:Multiple bookings
* news
*:News
* paid_events
*:Accept payments

* recap
*:Daily report
* secure
*:SSL
* status
*:Status
* unit_colors
*:Providers color coding
* user_license
*:Terms and conditions
* cancelation_policy
*:Cancellation Policy

See [[Custom_Features|Custom Features]] page for description for each Custom Feature.

</translate>

<translate>

== Examples ==

====getBookingDetails response====

An example of data returned by [[#getBookingDetails|getBookingDetails]] API method.

{
"id": "321",
"event_id": "5",
"event_name": "Massage",
"unit_id": "3",
"unit_name": "John",
"client_id": "1",
"client_name": "Bob",
"start_date_time": "2015-11-25 15:00:00",
"end_date_time": "2015-11-25 16:00:00",
"is_confirmed": "1",
"code": "h8v8w5ls",
"record_date": "2015-11-19 04:06:38",
"comment": null,
"company_login": "testzt",
"company_name": "My Cool Company",
"company_phone": "+1-555-55-55",
"company_email": "into@mycoolcompany.com",
"additional_fields": [{
"value": "on",
"field_name": "201a89517de509f6b3a60858918faac3",
"field_title": "Include washing",
"field_position": "4",
"field_type": "checkbox",
"field_id": "4"
}],
"comments": [],
"history": [{
"id": "536",
"sheduler_id": "321",
"datetime": "2015-11-19 11:06:38",
"type": "create",
"user_id": "1",
"agent": "SimplyBook.me\/55 CFNetwork\/758.0.2 Darwin\/15.0.0",
"ip": "213.174.0.53, 158.69.224.50:127.0.0.1",
"referer": "",
"login": "admin",
"firstname": "Mikhail",
"lastname": ""
}],
"status": {
"id": "3",
"name": "Fancy Status",
"description": null,
"color": "4cbadb",
"is_default": "1"
},
"location": {
"id": "1",
"title": "location",
"description": null,
"picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
"address1": null,
"address2": "Saint Margaret Street",
"city": "\u041b\u043e\u043d\u0434\u043e\u043d",
"zip": null,
"country_id": "GB",
"lat": "51.50013000000000000000",
"lng": "-0.12630500000000000000",
"phone": "44",
"position": "1",
"is_default": "1"
},
"price": [],
"promo": false
}

</translate>

<translate>

Location field is present in response only if [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.

Status field is present in response only if [[Custom_Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.

Price field is present in response only if [[Custom_Features#Accept_Payments|Accept payments Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a free service.


<code>additional_fields</code> field is present in response only if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a service with no intake forms.

</translate>

----

<translate>

====book response====

[[#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.

{
"require_confirm":false,
"bookings":[
{
"id":"434",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-30 13:00:00",
"end_date_time":"2015-12-30 13:30:00",
"is_confirmed":"1",
"code":"h8vc14ca",
"hash":"785cb8cce316e64765b94c05a635f4be"
},
{
"id":"435",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-31 13:00:00",
"end_date_time":"2015-12-31 13:30:00",
"is_confirmed":"1",
"code":"h8vc2pge",
"hash":"8b92d634541bfd93c0830967e56f4653"
},
{
"id":"436",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-04 13:00:00",
"end_date_time":"2016-01-04 13:30:00",
"is_confirmed":"1",
"code":"h8vc3urb",
"hash":"cd22a0bf183f7350e595988dd2486e5b"
},
{
"id":"437",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-05 13:00:00",
"end_date_time":"2016-01-05 13:30:00",
"is_confirmed":"1",
"code":"h8vc44d9",
"hash":"53f98ff4e4a0323aa907156c59c99362"
}
],
"batch_type":"batch_recurrent_booking",
"recurrent_batch_id":"1",
"batch_hash":"357178bce290381bb7235080941ec143"
}

</translate>

----

<translate>

====getCompanyInfo response====

An example of data returned by [[#getCompanyInfo|getCompanyInfo]] API method.

{
"login": "pierrecoetzee",
"name": "Pierre",
"description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"address1": "",
"address2": "Storey's Gate, ",
"city": "London",
"country_id": "GB",
"lat": "51.500435",
"lng": "-0.129811",
"email": "pierre.coe@gmail.com",
"phone": "",
"web": null,
"skip_address": null,
"logo": null,
"address": "GB, London, Storey's Gate, ",
"description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"timezone": "Europe London",
"show_in_client_timezone": false,
"timeframe": "60",
"timeline_type": "modern_week",
"allow_event_day_break": "0",
"allow_event_breaktime_break": "0"
}

<code>timeline_type</code> field can be one the following values:

* flexible
* modern
* flexible_week
* modern_week
* classic
* classes

</translate>

<translate>
Please note that <code>classic</code> timeline type is deprecated and not supported anymore.

<code>description</code> field contains raw data of company's description which can include HTML tags. <code>description_text</code> field contains only text information without HTML tags.

For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params|Company params section]].

</translate>
----

<translate>

<!--====getPluginPromoInfoByCode response====

{
"id": "1",
"title": "[service\/services] with [discount]% discount!",
"code": "yvuvugum",
"description": "We are offering [service\/services] with an amazing [discount]% discount! We are running this deal for a limited time only.",
"discount": "99.9999",
"start_date": "2015-12-23",
"expired_date": "2016-01-23",
"sheduler_start_date": "2015-12-23",
"sheduler_end_date": "2015-12-31",
"sheduler_start_time": "09:00:00",
"sheduler_end_time": "22:30:00",
"allow_usage_count": "20",
"fineprint_text": "Deal is limited for new clients only. Reward is claimable [client_claim_times_number] times per client. Deal is only claimable for the locations specified. Deal is cannot be combined with any other promotion. Must be redeemed prior to the expiration date shown on the deal.",
"redemption_text": "Present your confirmation code when you want to redeem your deal. You may either to print off your confirmation email or show your confirmation code by loggin into Simplybook on your mobile phone\/Pc.\r\n[promocode]\r\n[discount]\r\n[reward]\r\n[referal_qty]",
"headline": "[service\/services] with [discount]% discount!",
"image": null,
"allow_customer_count": "1",
"show_in_catalogue": "1",
"status": "active",
"plugin_promo_message_id": "1",
"common_promotion_id": "132",
"service_ids": ["1"]
}

<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
</translate>

Company administration service methods

2025-05-15T12:51:45Z

Tania:

<languages/>
<translate>

{{#seo:
|title=Company administration service methods - SimplyBook.me
|description=Learn about service methods for internal company administration. Manage bookings tailored to your operations. Start here!
|titlemode=append
|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
}}
</translate>

<translate>
==General Information==

SimplyBook.me API service build on [https://en.wikipedia.org/wiki/JSON-RPC JSON-RPC] remote procedure call protocol. A remote method is invoked by sending a request to a remote service using HTTPS. All transfer types are single objects, serialized using [http://www.json.org JSON]. A request is a call to a specific method provided by a remote system. It must contain three certain properties:

</translate>

<translate>

* <code>jsonrpc</code> - a version of JSON-RPC protocol. Always <code>"2.0"</code>
* <code>method</code> - A String with the name of the method to be invoked.
* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.

</translate>

<translate>

The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

* <code>result</code> - The data returned by the invoked method. If an error occurred while invoking the method, this value must be null.
* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
* <code>id</code> - The id of the request it is responding to.

</translate>

<translate>

Example

<pre>
Request
{
"jsonrpc": "2.0",
"method": "getEventList",
"params":[],
"id":1
}

Response
{
"result": {
"1": {
"id": "1",
"name": "Часовая фотосесcия",
"duration": "60",
"hide_duration": "0",
"description": "Если Вы хотите попробовать себя в роли модели, но не определились с образом. 5-7 отретушированных и готовых к печати фотографий + отснятый материал на диске",
"picture": "a200edab10b669225e22d2b3803a38b5.jpg",
"is_public": "1",
"is_active": "1",
"position": "0",
"is_recurring": "0",
"picture_path": "/uploads/mib/event__picture/small/a200edab10b669225e22d2b3803a38b5.jpg",
"price": "300.0000",
"currency": "UAH",
"categories": ["1"]
},
...
},
"id": "1",
"jsonrpc": "2.0"
}
</pre>

</translate>

<translate>

Example of request with error response:

<pre>
Request
{
"jsonrpc": "2.0",
"method": "someNotExistingMethod",
"params":[],
"id":1
}

Response
{
"jsonrpc": "2.0",
"id":1,
"error": {
"code": -32601,
"message": "Method not found"
}
}
</pre>

</translate>

<translate>

All calls of public service methods should have additional HTTP header:

* <code>X-Token</code> an authentication token. See [[#Authentication|authentication]] section.

===Endpoint===

Use URL <code>https://user-api.simplybook.me/admin</code> for all administration service API calls.

===Authentication===

Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API|API Custom Feature]] 'Settings'.

== Methods ==

== Methods ==

=== addClient ===

<code>addClient($clientData)</code>

Parameters:

* '''$clientData''' Object

Returns Integer.

</translate>

<translate>

Adds new client with specified data. You can specify name, email, phone, address1, address2, city, zip,
country_id. If client record with specified data exists method will return an id of this record. Otherwise data
will be stored to database and method will return an id of newly created record. NOTE: name is mandatory field.Also email, phone number or both of them can be mandatory fields. You should call
<code>getCompanyParam('require_fields')</code> method to check which fields are required.

Method returns an error:

* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong

Example:

{
name: "Frances T. Perez",
phone: "+1502-810-4521",
email: "FrancesTPerez@teleworm.us",
address1: "3872 Earnhardt Drive",
address2: "Louisville, KY 40219",
city: Louisville,
zip: 3872
}

</translate>

<translate>

----

=== addDeviceToken ===

<code>addDeviceToken($token, $device)</code>

Parameters:

* '''$token''' String a device token string
* '''$device''' String a device type ('android' or 'apple')

Returns boolean.

Subscribe a mobile device to push notifications service. Device will recieve notifications about new bookings or
changes in already created bookings. Use either <code>'apple'</code> or <code>'android'</code> for <code>device</code>
parameter.

----
</translate>

<translate>

=== book ===

<code>book($eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional, $count, $batchId, $recurringData)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' string a date string in format 'Y-m-d'
* '''$startTime''' string a time string in format 'H:i:s'
* '''$endDate''' string a date string in format 'Y-m-d'
* '''$endTime''' string a time string in format 'H:i:s'
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.
* '''$count''' Integer bookings count used to make group bookings batch. This parameter can't be less than 1. (optional)
* '''$batchId''' Integer add booking to group bookings batch. You can't use $count and $batchId in one call. Please specify only one parameter. (optional)
* '''$recurringData''' Array - make booking recurrent. (optional)

Returns Object.

</translate>

<translate>

Creates new booking record. Returns an object with appointment information or throw exception if booking time not
available or any of required parameters missed. If appointment requires confirmation, in result object will be
<code>require_confirm = true</code>. <code>$startDate</code> and <code>$startTime</code> specifies a date of
booking and time slot. Time value should be multiple to 'timeframe' configuration of company (see
<code>[[#getTimeframe|getTimeframe]]</code> API method). <code>$endDate</code> and <code>$endTime</code> parameters
should be calculated according to service duration. However you can specify different values to make appointment
longer or shorter then service configuration. Note that <code>$endDate</code> and <code>$endTime</code> should be
later in time than <code>$startDate</code> and <code>$startTime</code>. If your clients located in different time
zone you should specify <code>$clientTimeOffset</code> parameter as difference between company's time zone and
client's time zone in seconds. For example if company located in city with time zone GMT+2 and customer located
in city with GMT+3 then <code>$clientTimeOffset</code> will be -3600 seconds. You can get information about company's
time zone using <code>[[#getCompanyInfo|getCompanyInfo]]</code> API method. To create batch booking you can
specify either <code>count</code> more then 1 or valid <code>batchId</code> (only one parameter can be
specified). You should specify an <code>$additionalFields</code> parameter if service requires some intake forms (see [[Custom_Features#Intake_Forms|Intake Forms Custom feature]]).To create a booking with promo code you should pass it as additional field. For example: <code>{"promocode": "some code"}</code>

</translate>

<translate>

If [[Custom_Features#Multiple_Locations| Multiple locations]] enabled you need to pass locations ID parameter as additional field
<code>location_id</code>. For example: <code>{"location_id": "1"}</code>. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
to check if Custom feature active and <code>[[#getLocationsList|getLocationsList()]]</code> method to get list of
available locations.

See [[#book response|example]] of <code>book</code> API method response.

See also:

* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

----
</translate>

<translate>

=== calculateEndTime ===

<code>calculateEndTime($startDateTime, $eventId, $unitId)</code>

Parameters:

* '''$startDateTime''' String a date and time string in format 'Y-m-d H:i:s', eg. '2001-10-02 13:30:00'.
* '''$eventId''' Integer
* '''$unitId''' Integer

Returns String|Boolean.

Returns end datetime if booking is available, else return false

----
</translate>

<translate>

=== cancelBatch ===

<code>cancelBatch($id, $bookingIds)</code>

Parameters:

* '''$id''' Integer identifier of batch. See <code>[[#createBatch|createBatch]]</code> API method.
* '''$bookingIds''' Array ids of bookings included to batch.

Returns boolean.

Cancel batch of bookings. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found)
if no booking with specified id were found. A booking with first id in <code>$bookingIds</code> list is used for
information in notifications.

----
</translate>

<translate>

=== cancelBooking ===

<code>cancelBooking($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Cancels booking. Returns true on success. Returns an error with code -32080 (Appointment couldn't be found) if
no booking with specified id were found.

----
</translate>

<translate>

=== createBatch ===

<code>createBatch()</code>

No arguments.
Returns Integer.

Creates new booking batch record. Returns newly created batch id. You can use this id in <code>[[#book|book]]</code>
API method.

----
</translate>

<translate>

=== deleteDeviceToken ===

<code>deleteDeviceToken($token)</code>

Parameters:

* '''$token''' String - device token

Returns boolean.

Unsubscribe from push notifications service.

----
</translate>

<translate>

=== editBook ===

<code>editBook($shedulerId, $eventId, $unitId, $clientId, $startDate, $startTime, $endDate, $endTime, $clientTimeOffset, $additional)</code>

Parameters:

* '''$shedulerId''' Integer an id of booking to edit. See <code>[[#book|book]]</code> or <code>[[#getBookings|getBookings]]</code> API methods.
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$clientId''' Integer
* '''$startDate''' String - in Y-m-d format
* '''$startTime''' String - in H:i:s format
* '''$endDate''' String - in Y-m-d format
* '''$endTime''' String - in H:i:s format
* '''$clientTimeOffset''' Integer
* '''$additional''' array|Object - additional params and fields.

Returns Object.

Edit existing booking record. See [[#book|book]] API method description for more details about date/time parameters,
time zone handling and additional fields. Returns null if parameters not valid.

----
</translate>

<translate>

=== editClient ===

<code>editClient($clientId, $clientData)</code>

Parameters:

* '''$clientId''' Integer
* '''$clientData''' Object

Returns Integer.

Edits client's record. See <code>[[#addClient|addClient]]</code> method description for list of available fields.Method returns an id of client's record.

----
</translate>

<translate>

=== filterAvailableUnits ===

<code>filterAvailableUnits($eventId, $dateTime, $unitIds, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$unitIds'''
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service from provided $unitIds list.You can use this method with location Custom Feature.
Returns empty array if all units are not allowed.
Eg.: <code>[1, 2, 3]</code>

----
</translate>

<translate>

=== getAdditionalFields ===

<code>getAdditionalFields($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Return intake forms for certain event if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is
activated. Returns empty array otherwise. Call <code>[[#isPluginActivated|isPluginActivated('event_field')]]</code>
API method to check if 'event_field' Custom Feature activated.

----
</translate>

<translate>

=== getAnyUnitData ===

<code>getAnyUnitData()</code>

No arguments.
Returns Object|null.

Returns information about [[Custom_Features#Any_Employee_Selector|Any Employee selector Custom Feature]] configuration. Returns
null if Custom Feature not enabled.Example:
{
"description" : "Select this option, if you want to find an available time with any of the employees",
"hide_other_units" : 1, // 1 or 0
"image" : null,
"name" : "Any employee",
"picture_path" : null,
"random_selection" : 0 // 1 or 0
}

----
</translate>

<translate>

=== getAvailableTimeIntervals ===

<code>getAvailableTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available time intervals for all service providers for given period, taking into account breaktimes, start and end working time
Eg.: <code>{['2016-03-04': ['1': [['09:00:00','09:30:00'], ['11:15:00','14:45:00']] , ...], ...]}</code>

----
</translate>

<translate>

=== getAvailableUnits ===

<code>getAvailableUnits($eventId, $dateTime, $count)</code>

Parameters:

* '''$eventId''' Integer
* '''$dateTime''' String a date and time string in format 'Y-m-d H:i:s'
* '''$count''' Integer

Returns Array.

Returns list of available unit ids for specified date and service or empty array if all units are not allowed.Eg.: <code>[1, 2, 3]</code>

----

</translate>

<translate>

=== getBookingCancellationsInfo ===

<code>getBookingCancellationsInfo($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String a date string in format 'Y-m-d'. Pass null to get data from first day of current week.
* '''$dateEnd''' String a date string in format 'Y-m-d'. Pass null to get data filtered to last day of current week.

Returns Array.

Returns statistics about created bookings and cancellations for a time period. Data presented as array of hashes for
each type of operation (created or cancelled booking) groped by clients. <code>"type"</code> field can be either
"create", "cancel" or "nopayment_cancel". If <code>"user_id"</code> not specified then bookings where created or
cancelled by admin or employee. Data with type <code>"nopayment_cancel"</code> represents bookings cancelled
automatically by system.Example:
3 bookings where created by admin or employee and 2 bookings where automatically cancelled by system.
[{
"cnt" : 3,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "create",
"user_id"" : null
}, {
"cnt" : 2,
"firstname" : null,
"lastname" : null,
"login" : null,
"type" : "nopayment_cancel",
"user_id"" : null
}]

----

</translate>

<translate>

=== getBookingComment ===

<code>getBookingComment($id)</code>

Parameters:

* '''$id''' Integer

Returns String.

Returns booking comment

----
</translate>

<translate>

=== getBookingDetails ===

<code>getBookingDetails($id)</code>

Parameters:

* '''$id''' integer booking id

Returns Array.

Returns detailed bookings object by booking id. See [[#getBookingDetails_response|response example]].

----
</translate>

<translate>

=== getBookingLimitUnavailableTimeInterval ===

<code>getBookingLimitUnavailableTimeInterval($startDateTime, $endDateTime, $eventId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$eventId''' integer

Returns Array.

Returns time intervals not available for bookings because of configuration of [[Custom_Features#Limit_Bookings|Limit bookings]]
Custom Feature for period of time. Returns empty array if Custom Feature not available.

----
</translate>

<translate>

=== getBookingRevenue ===

<code>getBookingRevenue($dateStart, $dateEnd, $unitGroupId, $serviceId)</code>

Parameters:

* '''$dateStart''' string a date string in format 'Y-m-d'.
* '''$dateEnd''' string a date string in format 'Y-m-d'
* '''$unitGroupId''' integer
* '''$serviceId''' integer

Returns Array.

Return bookings count and revenue value for each date in specified period. Data grouped by unit id and
represented as array with bookings count at index 0 and revenue amount at index 1. You can filter data either
by unit or by service. Set <code>$dateStart</code> and <code>$dateEnd</code> to null to get data for current week.Example:
['2015-11-12' : {
3 : [
11, // bookings count
128.53 // revenue
]}

----
</translate>

<translate>

=== getBookingStats ===

<code>getBookingStats($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns statistic about bookings count grouped by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

----
</translate>

<translate>

=== getBookings ===

<code>getBookings($params)</code>

Parameters:

* '''$params'''

Returns Array.

Returns list of bookings filtered by given params. Filter params represented as object with following fields:* '''date_from''' a date of booking in string format 'Y-m-d'
* '''time_from''' a time string in format 'H:i:s'
* '''date_to''' a date string in format 'Y-m-d'
* '''time_to''' a time string in format 'H:i:s'
* '''created_date_from''' a date string in format 'Y-m-d'
* '''created_date_to''' a date string in format 'Y-m-d'
* '''unit_group_id''' an integer. Use it to get bookings assigned for certain service provider.
* '''event_id''' an integer. Use it to get bookings only for certain service.
* '''is_confirmed''' 1 or 0. If [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled then method will return confirmed bookings with approve status 'new'.
* '''client_id''' an integer. Use it to get bookings only for certain client.
* '''order''' string either 'record_date', 'date_start' or 'date_start_asc'. By default used 'date_start' value.
* '''booking_type''' a string. Value of this field depends on Approve booking Custom Feature status.
*: If Custom Feature not active:
** '''all''' for all bookings (default value)
** '''cancelled''' alias to 'is_confirmed' equal to 0
** '''non_cancelled''' alias to 'is_confirmed' equal to 1
*: If Custom Feature active:
** '''all''' for all bookings (default value)
** '''cancelled''' returns bookings with 'is_confirmed' field equals to 0 and approve booking status equals to 'cancelled' (or booking does not have any approve status)
** '''non_cancelled''' returns bookings with either 'is_confirmed' field equals to 1 or approve booking status equals to 'new'
** '''cancelled_by_client''' returns bookings approved by admin but cancelled by client
** '''cancelled_by_admin''' returns bookings cancelled by admin
** '''non_approved_yet''' returns bookings with approve status 'new'
** '''approved''' returns bookings with either 'is_confirmed' field equals to 1 and approve booking status equals to 'approved' (or booking does not have any approve status)

Example:
{
"date_from":"2015-12-29",
"date_to":"2015-12-29",
"booking_type":"cancelled",
"event_id":"5",
"order":"start_date"
}

----
</translate>

<translate>

=== getBookingsZapier ===

<code>getBookingsZapier()</code>

No arguments.
Returns Array.

Returns list of bookings filtered by given params

----
</translate>

<translate>

=== getCategoriesList ===

<code>getCategoriesList($isPublic)</code>

Parameters:

* '''$isPublic''' Boolean

Returns Array.

Returns company categories list if [[Custom_Features#Service_Categories|Service Categories Custom Feature]] is activated. Returns
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('event_category')]]</code>
API method to check if Custom Feature activated.

----

</translate>

<translate>

=== getClient ===

<code>getClient($clientId)</code>

Parameters:

* '''$clientId'''

Returns Array.

Returns client's data object. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getClientComments ===

<code>getClientComments($clientId, $shedulerId)</code>

Parameters:

* '''$clientId''' Integer
* '''$shedulerId''' Integer

Returns Array.

Returns list of all comments for given client

----

</translate>

<translate>

=== getClientList ===

<code>getClientList($searchString, $limit)</code>

Parameters:

* '''$searchString''' String
* '''$limit''' Integer

Returns Array.

Returns list of clients associated with company. You can use either phone number, email address or name as value
for <code>$searchString</code>. Pass an empty string for <code>$searchString</code> and null for <code>$limit</code>
parameters to get all records. See <code>[[#addClient|addClient]]</code> API method for list of available fields
of client data object.

----

</translate>

<translate>

=== getCompanyCurrency ===

<code>getCompanyCurrency()</code>

No arguments.
Returns String.

Returns company's currency as three chars code (ISO 4217).

----
</translate>

<translate>

=== getCompanyInfo ===

<code>getCompanyInfo()</code>

No arguments.
Returns Object.

Returns an object with detailed information about company. See [[#getCompanyInfo response|example of response]].

----

</translate>

<translate>

=== getCompanyParam ===

<code>getCompanyParam($key)</code>

Parameters:

* '''$key''' String

Returns mixed.

Returns company config value for key. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].

----

</translate>

<translate>

=== getCompanyParams ===

<code>getCompanyParams($keys)</code>

Parameters:

* '''$keys''' Array

Returns Array.

Returns company config values for keys. A different set of keys available for public API and for company
administration API. Method return 'invalid params' error (code -32602) in case if access to specified key not
allowed. See [[#Company_params|list of available keys]].For non-existent and not-allowed params it will return false as result

----

</translate>

<translate>

=== getCompanyTimezoneOffset ===

<code>getCompanyTimezoneOffset()</code>

No arguments.
Returns array.

Returns company timezone offset and company timezone

----

</translate>

<translate>

=== getCountryList ===

<code>getCountryList()</code>

No arguments.
Returns Array.

Get list of all countries

----

</translate>

<translate>

=== getCountryPhoneCodes ===

<code>getCountryPhoneCodes()</code>

No arguments.
Returns Array.

Returns country phone code list

----

</translate>

<translate>

=== getCurrentTariffInfo ===

<code>getCurrentTariffInfo()</code>

No arguments.
Returns Array.

Returns all information about current tariff (subscription). For example:{
"name" : "gold",
"expire_date" : "2016-02-11 12:32:00",
"rest" : 41, // number of days until subscription expiration
"color" : "#fcb322"
}

----

</translate>

<translate>

=== getCurrentUserDetails ===

<code>getCurrentUserDetails()</code>

No arguments. Returns Object.

Returns an object with information about logged in user. Note: you are responsible for implementation of some
access rights based on <code>group</code> property value. Most of API methods returns an error if user has low access
rights but not all. There are 4 roles:

* '''Administrator''' - have full access to the system
* '''Senior Employee''' - have access to calendar, services and providers, and can modify bookings related with user
* '''Junior Employee''' - can access caledar (but only to own bookings), services associated with user
* '''Viewer''' - have only access to calendar and services in read only mode

<code>group</code> property can be one of the values:

* <code>shop_user</code> - "Senior Employee" access role
* <code>station_user</code> - "Junior Employee" access role
* <code>admin</code> - "Administrator" access role
* <code>viewer</code> - "Viewer" access role
* <code>reseller_company_admin</code> - reserved

Example:

{
"id": 1,
"login": admin,
"email": "admin@mycoolcompany.com";
"firstname": "Michail",
"lastname": " ",
"phone": "",
"group": "admin",
"is_blocked": 0,
"last_access_time": "2016-06-06 17:55:51",
"unit_group_id": null
}

----

</translate>

<translate>

=== getEventList ===

<code>getEventList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns company's events list. If <code>$asArray</code> is false then method returns a map with event id as key
and details object as value. If parameter set to true then method returns a list sorted by 'position' property of
event's details object.

----

</translate>

<translate>

=== getFeedbacks ===

<code>getFeedbacks($approvedOnly, $reviewsOnly, $lastOnly, $limit)</code>

Parameters:

* '''$approvedOnly''' Boolean
* '''$reviewsOnly''' Boolean
* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Get list of feedbacks

----

</translate>

<translate>

=== getFirstWorkingDay ===

<code>getFirstWorkingDay($unitId)</code>

Parameters:

* '''$unitId''' Integer

Returns String.

Returns first working date for unit

----

</translate>

<translate>

=== getGoogleCalendarBusyTime ===

<code>getGoogleCalendarBusyTime($startDateTime, $endDateTime, $unitId)</code>

Parameters:

* '''$startDateTime''' string a date and time string in format 'Y-m-d H:i:s'
* '''$endDateTime''' string a date and time string in format 'Y-m-d H:i:s'. You can date string avoiding time in
this parameter. In this case method will use time value '23:59:59'.
* '''$unitId''' integer

Returns Array.

Returns a list of objects represented a time intervals marked as busy in Google Calendar. Each object of result
contains <code>from</code> and <code>to</code> properties with datetime string as value. This method only actual if
[Custom_Features#Calendar_Sync|Calendar Sync Custom Feature] enabled. If Custom Feature not enabled an empty list will
be returned. You should call <code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> to
check status of the Custom Feature. Each object of result contains <code>from</code> and <code>to</code> properties with
datetime string as value. Please note that this method may return not actual data because data synchronization
between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.Example:
<code>
[
{"from" : "2016-02-16 13:30:00",
"to" : "2016-02-16 16:00:00"},
...
]
</code>

----

</translate>

<translate>

=== getGoogleCalendarBusyTimeAvailableUnits ===

<code>getGoogleCalendarBusyTimeAvailableUnits()</code>

No arguments.
Returns Array.

Returns configured unit ids, allowed to sync busy time

----
</translate>

<translate>

=== getLastNotificationUpdate ===

<code>getLastNotificationUpdate($type)</code>

Parameters:

* '''$type''' String

Returns String.

Returns last update datetime

----

</translate>

<translate>

=== getLocationsList ===

<code>getLocationsList($isPublic, $asArray)</code>

Parameters:

* '''$isPublic''' Boolean Optional. Default value is '''false'''.
* '''$asArray''' boolean Optional. Default value is '''false'''.

Returns Array.

Returns available locations for company if Custom Feature [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is activated. Return
an error with code -32001 if Custom Feature is not activated. Use <code>[[#isPluginActivated|isPluginActivated('location')]]</code>
API method to check if Custom Feature activated.

This method accepts two boolean flags as parameters. If '''isPublic''' flag is '''true''' then method returns only
public locations. If '''asArray''' flag is '''true''' method returns list of objects. Otherwise method returns
map of objects with object id as key. You can omit both parameters.

----
</translate>

<translate>

=== getPluginList ===

<code>getPluginList()</code>

No arguments.
Returns Array.

Returns a list of all Custom Features associated with company with status.

----

</translate>

<translate>



</translate>

----

<translate>

=== getPluginStatuses ===

<code>getPluginStatuses($pluginNames)</code>

Parameters:

* '''$pluginNames''' Array

Returns Array.

Return Custom Feature status true if status active, else false. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== getRecentActions ===

<code>getRecentActions($lastOnly, $limit)</code>

Parameters:

* '''$lastOnly''' Boolean
* '''$limit''' Integer

Returns Array.

Returns latest actions

</translate>

----

<translate>

=== getRecurringDatetimes ===

<code>getRecurringDatetimes($eventId, $unitId, $date, $time, $recurringData, $endDateTime)</code>

Parameters:

* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$date''' String
* '''$time''' String
* '''$recurringData''' Array
* '''$endDateTime''' String (optional)

Returns Array.

Get list of dates for recurring booking

</translate>

----

<translate>

=== getRecurringSettings ===

<code>getRecurringSettings($eventId)</code>

Parameters:

* '''$eventId''' Integer

Returns Array.

Returns an object with recurring settings for an event. Returns false if specified event does not configured as
recurring.

See also:

* [http://blog.simplybook.me/recurring-and-periodic-bookings/ Recurring services desription]

</translate>

----

<translate>

=== getRegistrations ===

<code>getRegistrations($groupBy)</code>

Parameters:

* '''$groupBy''' String either 'day', 'week' or 'month'

Returns Array.

Returns number of clients registrations by 'day', 'week' or 'month'. A time period depends on selected
grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getReservedTime ===

<code>getReservedTime($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Integer
* '''$count''' Integer

Returns Object.

Returns map of objects for each day in specified date range. The key of the result mps is a date string. The value
is an array of two objects. Both objects contains list of time slots for type <code>reserved_time</code> and type
<code>not_worked_time</code>. <code>reserved_time</code> type represents time slots working time but already booked
by clients. Nobody knows what kind of data represented by <code>not_worked_time</code> type. Please don't use it.If [[Custom_Features#Calendar_Sync| Calendar Sync Custom Feature]] enabled then object with
<code>reserved_time</code> type will contain not empty list of time slots marked as busy in Google calendar. Call
<code>[[#isPluginActivated|isPluginActivated('google_calendar_export')]]</code> API method to check if Calendar Sync Custom Feature activated.

Example:
<pre>
{
"2016-02-05": [
{
"dd": [], // time slots from Google calendar
"events": [ // reserved time slots
{ "from": "16:00", "to": "16:30" },
{ "from": "16:30", "to": "17:00" },
... ],
"type": "reserved_time",
},
{
"events": [
{ "from": "09:00", "to": "09:30" },
{ "from": "09:30", "to": "10:00" },
... ],
"type": "not_worked_time"
}],
...
}
</pre>

</translate>

----

<translate>

=== getReservedTimeIntervals ===

<code>getReservedTimeIntervals($dateFrom, $dateTo, $eventId, $unitId, $count)</code>

Parameters:

* '''$dateFrom''' String
* '''$dateTo''' String
* '''$eventId''' Integer
* '''$unitId''' Integer|Array
* '''$count''' Integer

Returns Object.

Returns not available time
Eg.: <code>{'2014-05-14': [{'reserved_time': [{'from': '14:00', 'to': '16:30'}], 'type': "reserved_time"}, ...], ...}</code>

</translate>

----

<translate>

=== getSocialCounterStats ===

<code>getSocialCounterStats($provider)</code>

Parameters:

* '''$provider''' String

Returns Integer.

Returns social counters value for your domain

</translate>

----

<translate>

=== getStartTimeMatrix ===

<code>getStartTimeMatrix($from, $to, $eventId, $unitId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$eventId''' Integer
* '''$unitId''' Mixed can be Integer or Array of Integers
* '''$count''' Integer

Returns Object.

Returns available start time, taking into account breaktimes, start and end working time
Eg.: <code>{'2014-05-14': ['09:00:00', ...], ...}</code>

If locations Custom Feature activated for company you should pass a list as $unitID parameter for filter results with
units available only for selected location. See [[Custom_Features#Multiple_Locations|Multiple locations]] Custom Feature description for
more details.

</translate>

----

<translate>

=== getStatuses ===

<code>getStatuses()</code>

No arguments.
Returns Array.

Returns list of available statuses or an empty list if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== getTimeframe ===

<code>getTimeframe()</code>

No arguments.
Returns Integer.

Returns company's timeframe configuration (in minutes). Timeframe can be either 5, 10, 15, 20, 30 or 60 minutes.You can find more details about timeframe [[Need_to_change_interval_(timeframe)|here]].

</translate>

----

<translate>

=== getTimelineType ===

<code>getTimelineType()</code>

No arguments.
Returns String.

Returns company calendar layout type

</translate>

----

<translate>

=== getTopPerformers ===

<code>getTopPerformers()</code>

No arguments.
Returns Array.

Returns a list with statistics for performers. This data contains number of bookings and revenues value for each performer.

</translate>

----

<translate>

=== getTopServices ===

<code>getTopServices($dateStart, $dateEnd)</code>

Parameters:

* '''$dateStart''' String
* '''$dateEnd''' String

Returns Array.

Returns a list with statistics for services for a period of time. This data contains number of bookings and
revenues value for each service.

</translate>

----

<translate>

=== getUnitList ===

<code>getUnitList($isVisibleOnly, $asArray)</code>

Parameters:

* '''$isVisibleOnly''' Boolean
* '''$asArray''' Boolean

Returns Array.

Returns list of service performers. If <code>$asArray</code> is false then method returns a map with event id as
key and details object as value. If parameter set to true then method returns a list sorted by 'position' property
of event's details object.

</translate>

----

<translate>

=== getUnitWorkdayInfo ===

<code>getUnitWorkdayInfo($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workday info (date_start and date_end)

</translate>

----

<translate>

=== getUnitWorkingDurations ===

<code>getUnitWorkingDurations($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return working durations

</translate>

----

<translate>

=== getVisitorStats ===

<code>getVisitorStats($groupBy)</code>

Parameters:

* '''$groupBy''' String

Returns Array.

Returns statistics about page visits if Custom Feature [[Custom_Features#Visitor_Counter|Visitor Counter Custom Feature]] enabled. Returns
an empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('counter')]]</code> API method
call to check if Custom Feature enabled. Results can be grouped by 'day', 'week' or 'month'. A time period depends on
selected grouping parameter:* for 'day' methods returns statistics for last 31 days
* for 'week' methods returns data last 10 weeks period
* for 'month' time period is last 12 months

</translate>

----

<translate>

=== getWarnings ===

<code>getWarnings($lastOnly)</code>

Parameters:

* '''$lastOnly''' Boolean. Default value is '''false'''.

Returns Array.

Returns a list of objects represented system warnings. Each warning contains <code>warning_type</code> and <code>warning_text</code>
properties. <code>warning_text</code> property contains localized message. <code>warning_type</code> can be one of the values:

* '''sms_limit''' – warning indicates low amount of SMS credits
* '''sheduler_limit''' – warning indicates low amount of available bookings

</translate>

----

<translate>

=== getWorkCalendar ===

<code>getWorkCalendar($year, $month, $unitId)</code>

Parameters:

* '''$year''' Integer
* '''$month''' Integer
* '''$unitId''' Integer

Returns Object.

Returns company work schedule as array
Eg.: <code>{'2014-05-01': {'from': '09:00:00', 'to': '21:00:00', 'is_day_off': '0'}, '2014-05-02': ...}</code>

</translate>

----

<translate>

=== getWorkDaysInfo ===

<code>getWorkDaysInfo($from, $to, $unitId, $eventId, $count)</code>

Parameters:

* '''$from''' String
* '''$to''' String
* '''$unitId''' Integer (optional)
* '''$eventId''' Integer (optional)
* '''$count''' Integer (optional)

Returns Object.

Returns an information about working hours and break times for specified service and performer for a period
between two dates. If only service specified then information about performer (or performers) will be taken from
service configuration. Method returns a list of objects for each date in specified period. Count of objects in
list depends on break times. For example if performer works from 9:00 till 19:00 with one hour break at 13:00 method
returns:<pre>
{'2014-05-14' : [
{'from': '09:00:00', 'to': '13:00:00'},
{'from': '14:00:00', 'to': '19:00:00'}
] }
</pre>

Warning! Method can return a time string '24:00:00' as right edge of time range. This happens in case if time
range finishes on midnight.

</translate>

----

<translate>

=== getWorkDaysTimes ===

<code>getWorkDaysTimes($startDateTime, $endDateTime, $type = 'unit_group')</code>

Parameters:

* '''$startDateTime''' string
* '''$endDateTime''' string
* '''$type''' string. Optional. Either 'unit_group' or 'event'.

Returns Array.

Return busy time by unit id by Calendar Sync Custom Feature if enabled. Please note that this method may return not actual data because data synchronization between server and Google/Outlook Calendar may take some time and synchronized data are cached for 15 minutes.

</translate>

----

<translate>

=== getWorkload ===

<code>getWorkload($dateStart, $dateEnd, $unitGroupId)</code>

Parameters:

* '''$dateStart''' string
* '''$dateEnd''' string
* '''$unitGroupId''' integer

Returns Array.

Return workload data for units in period of time. Workload for each unit represented as array with work hours
at index 0, confirmed booking hours as load at index 1 and cancelled bookings hours at index 2.Example:
['2015-10-21' : {
5 : [
10, // working hours
10, // load hours (confirmed bookings hours)
0 // cancelled bookings hours
] }]

</translate>

----

<translate>

=== isPluginActivated ===

<code>isPluginActivated($pluginName)</code>

Parameters:

* '''$pluginName''' String

Returns Boolean.

Return Custom Feature status true if status active, else false. <var>$pluginName</var> parameter is a Custom Feature identifier.See [[Custom_Features|Custom Features]] page for full Custom Features description. See [[Company_administration_service_methods#Custom_Features.27_identifiers|list of available plugin's names]].

</translate>

----

<translate>

=== pluginApproveBookingApprove ===

<code>pluginApproveBookingApprove($id)</code>

Parameters:

* '''$id''' Integer

Returns Array.

Sets approve booking status to 'approved' if [[Custom_Features#Approve_Bookings|Approve booking]] Custom Feature enabled and returns
list of approved booking IDs. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveBookingCancel ===

<code>pluginApproveBookingCancel($id)</code>

Parameters:

* '''$id''' Integer

Returns Boolean.

Sets approve booking status to 'canceled' if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled and returns
true. Returns false if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookings ===

<code>pluginApproveGetPendingBookings()</code>

No arguments.
Returns array.

Returns list of objects with information about bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]]
Custom Feature enabled. Returns empty list if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code>
API method call to check if Custom Feature enabled.

</translate>

----

<translate>

=== pluginApproveGetPendingBookingsCount ===

<code>pluginApproveGetPendingBookingsCount()</code>

No arguments.
Returns Integer.

Returns count of bookings pending approval if [[Custom_Features#Approve_Bookings|Approve bookings]] Custom Feature enabled. Returns
0 if Custom Feature not enabled. Use <code>[[#isPluginActivated|isPluginActivated('approve_booking')]]</code> API method
call to check if Custom Feature enabled.

</translate>

----

<translate>

=== setBookingComment ===

<code>setBookingComment($id, $comment)</code>

Parameters:

* '''$id''' Integer
* '''$comment''' String

Returns Integer.

Set booking comment

</translate>

----

<translate>

=== getBookingStatus ===

<code>getBookingStatus ($bookingId)</code>

Parameters:

* '''$bookingId''' Integer

Returns Array.

Returns an object of status of given booking (if status plugin is enabled)
default status will be returned if bookingId does not exists

</translate>

----

<translate>

=== setStatus ===

<code>setStatus($bookingId, $statusId)</code>

Parameters:

* '''$bookingId''' Integer
* '''$statusId''' Integer

Returns Boolean.

Sets specified status for booking. Returns an error with code -32020 if logged in user don't have access to edit
bookings. This method does nothing if [[Custom_Features#Status|Status Custom feature]] not enabled.

</translate>

----

<translate>

=== updateNotification ===

<code>updateNotification($type)</code>

Parameters:

* '''$type''' String

Returns .

Mark notifications as readed

</translate>

----

<translate>

=== setWorkDayInfo===

<code>setWorkDayInfo($info)</code>

Parameters:

* '''$info''' Array

Returns true on success

Set work day schedule for company|service|provider for week_day|date

Example:
<pre>
{
"start_time":"10:00",
"end_time":"18:00",
"is_day_off":0,
"breaktime":[{"start_time":"14:00","end_time":"15:00"}],
"index":"1",
"name":"Monday",
"date":"",
"unit_group_id":"",
"event_id":""
}

index is 1-7 for Monday - Sunday (used for weekly settings)
date is used to set worktime for special date
unit_group_id is provider id
event_id is service id
if unit_group_id and event_id not passed then it set data for company
</pre>

</translate>

----

<translate>

=== deleteSpecialDay===

<code>deleteSpecialDay($date, $params = null)</code>

Parameters:

* '''$date''' String
* '''$params''' Array

Returns true on success

Delete special date if set

Example:
<pre>
'2017-08-21',
{
"unit_group_id":"",
"event_id":""
}
</pre>

</translate>

----

<translate>

=== addServiceProvider===

<code>addServiceProvider($data)</code>

Parameters:

* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Create new service provider

Example:
<pre>
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

</translate>

----

<translate>

=== editServiceProvider===

<code>editServiceProvider($id, $data)</code>

Parameters:

* '''$id''' Integer
* '''$data''' Array

Returns Array with result and id of new service provider (unit_group)

Edit service provider
(there is no way to delete provider via API, in this case set is_active = 0)

Example:
<pre>
1,
{
"name" : "newtagg1 - 4",
"description" : "Description - 1",
"phone" : "1234567890",
"email" : "test@test.com",
"qty" : "2",
"is_visible" : 1,
"is_active" : 1,
"position" : 2,
"seo_url" : null,
"position_in_location" : null,
}
</pre>

-
</translate>

----

<translate>

== Constants ==

=== Error codes ===

See [[Errors handling]] for details.

* -32001 Custom Feature is not activated
* -32010 Some required params are missed
* -32011 Params is not array
* -32012 Sheduler id not found
* -32015 Passed event id is not reccuren
* -32020 Sorry, you have no permissions to perform this action
* -32030 Invalid promotion code
* -32031 Promotion has expired
* -32032 Promotion is not active yet
* -32033 This promocode is not valid for selected service
* -32034 Exceed max usage limit
* -32035 Exceed max usage per customer limit'const
* -32036 This promocode is not available for datetime range
* -32051 Selected event id is not available
* -32052 Selected unit id is not available
* -32053 Selected date start is not available
* -32054 Selected time start is not available
* -32055 One or more appointments couldn't be reserved
* -32056 Booking is not allowed at this time
* -32061 Client name value is wrong
* -32062 Client email value is wrong
* -32063 Client phone value is wrong
* -32070 Intake form values are wrong
* -32080 Appointemnt couldn't be found
* -32081 Service can't be performed when company does not work
* -32082 Service performer can't work when company does not work
* -32085 Signature error
* -32090 Confirmation with this key type is not available
* -32095 Batch not found
* -32097 Unsupported payment system
* -32099 Payment failed
* -32600
*: An error with this code can be thrown with one of the following messages:
** Access denied
** Company does not exists
* -32601 Method not found
* -32602 Invalid params
* -32603 Internal error
* -3264 Client with given id not found

</translate>

----

<translate>

===Company params===

Use these values to get configuration params for company with <code>[[#getCompanyParam|getCompanyParam]]</code> API method.

=====General params=====

Administration API inherits all [[Company public service methods#Company_params|keys]] allowed for public API and extends this list with keys:

* attach_ical
* auto_redirect
* auto_redirect_text
* blockchain_address
* blockchain_secret
* borgun_merchant_id
* borgun_payment_gateway_id
* borgun_secret_code
* client_batch_cancel_template
* client_batch_cancel_template_email
* client_batch_cancel_template_email_subject
* client_event_cancel_template
* client_event_cancel_template_email
* client_event_cancel_template_email_subject
* client_event_change_template
* client_event_change_template_email
* client_event_change_template_email_subject
* client_event_creation_template
* client_event_creation_template_email
* client_event_creation_template_email_subject
* client_event_group_creation_template
* client_event_group_creation_template_email
* client_event_group_creation_template_email_subject
* client_event_multiple_creation_template
* client_event_multiple_creation_template_email
* client_event_multiple_creation_template_email_subject
* client_group_notification_template
* client_group_notification_template_email
* client_group_notification_template_email_subject
* client_multiple_notification_template
* client_multiple_notification_template_email
* client_multiple_notification_template_email_subject
* client_notification_template
* client_notification_template_email
* client_notification_template_email_subject
* client_notification_time
* client_recurring_event_creation_template
* client_recurring_event_creation_template_email
* client_recurring_event_creation_template_email_subject
* common_limit_booking
* company_ga_tracking_id
* default_phone
* disconnect_on_timeout
* email_event_list
* email_events_list_template
* email_group_events_list_template
* event_list_style
* feed_back_interval
* feedback_invite_template_email
* feedback_invite_template_email_subject
* google_conversion_color
* google_conversion_currency
* google_conversion_format
* google_conversion_id
* google_conversion_label
* google_conversion_language
* google_conversion_value
* hide_working_hours_block
* include_cancel_link
* kortais_merchant
* kortais_secret_code
* kortais_terminal
* layout_background
* layout_background_repeat
* mobile_site_link
* mobile_site_link_title
* no_show_period
* on_success_button_link
* on_success_button_text
* recap_interval
* recap_send_after_time
* recap_send_canceled_bookings
* recap_send_new_bookings
* recap_send_upcomming_bookings
* send_cancel_to_client
* send_cancel_to_client_email
* send_cancel_to_unit
* send_cancel_to_unit_email
* send_contact_widget_email_notification
* send_contact_widget_sms_notification
* send_notify_to_client
* send_notify_to_client_email
* send_notify_to_unit
* send_notify_to_unit_email
* send_onchange_to_client
* send_onchange_to_client_email
* send_onchange_to_unit
* send_onchange_to_unit_email
* send_oncreate_to_client
* send_oncreate_to_client_email
* send_oncreate_to_unit
* send_oncreate_to_unit_email
* send_sms_if_push_enabled
* site_link
* site_link_title
* skip_limits_for_admin
* skip_show_mobile_app_ads
* skip_show_on_success_button
* sms_event_list
* sms_events_list_template
* sms_group_events_list_template
* unit_batch_cancel_template
* unit_batch_cancel_template_email
* unit_batch_cancel_template_email_subject
* unit_event_cancel_template
* unit_event_cancel_template_email
* unit_event_cancel_template_email_subject
* unit_event_change_template
* unit_event_change_template_email
* unit_event_change_template_email_subject
* unit_event_creation_template
* unit_event_creation_template_email
* unit_event_creation_template_email_subject
* unit_event_group_creation_template
* unit_event_group_creation_template_email
* unit_event_group_creation_template_email_subject
* unit_group_notification_template
* unit_group_notification_template_email
* unit_group_notification_template_email_subject
* unit_notification_template
* unit_notification_template_email
* unit_notification_template_email_subject
* unit_notification_time
* unit_recurring_event_creation_template
* unit_recurring_event_creation_template_email
* unit_recurring_event_creation_template_email_subject
* use_common_client_db
* user_confirmation
* user_public_layout
* user_public_theme
* waiting_video

</translate>

----

<translate>

=====Accept payments Custom Feature params=====

Read more about [[Custom_Features#Accept_Payments|Accept Payments Custom Feature configuration]].

* allow_delay_payment
*: Allow delay payment option. Boolean.
* company_currency
*:
* hide_sale_tax
*: Hide sales tax option. Boolean.
* payment_timeout
*: Payment timeout option. String ("5 minutes", "1 hour", ...)
* sale_tax
*: Sales tax option. Integer. You should divide by 100 to get percent value.
* paypal_account
*: PayPal payment processor configuration. String.
* skrill_account
*: Skrill payment processor configuration parameter. String.
* skrill_secret
*: Skrill payment processor configuration parameter. String.
* zooz_app_id
*: ZooZ payment processor configuration parameter. String.
* zooz_app_key
*: ZooZ payment processor configuration parameter. String.
* dwolla_application_key
*: Dwolla payment processor configuration parameter. String.
* dwolla_id
*: Dwolla payment processor configuration parameter. String.
* dwolla_secret_key
*: Dwolla payment processor configuration parameter. String.
* liqpay_merchant_id
* liqpay_merchant_pass

</translate>

----

<translate>

=====Term & Conditions Custom Feature params=====

Read more about [[Custom_Features#Terms_and_Conditions|Terms and Conditions Custom Feature]].

* user_license_text
*: Terms and conditions text. String.

</translate>

----

<translate>

===Custom Features' identifiers===

Custom Feature identifier is a string constant which represents a Custom Feature in system. These constants used in <code>[[#isPluginActivated|isPluginActivated]]</code> and <code>[[#getPluginStatuses|getPluginStatuses]]</code> API methods.

* advanced_notification
*:Book Soon notification system
* any_unit
*:Any Employee selector
* api
*:API
* approve_booking
*:Approve booking
* back_to_site
*:Take me back home
* contact_widget
*:Contact widget
* counter
*:Visitor Counter
* custom_css
*:Custom CSS
* data_security
*:Clean history
* description
*:HTML description field for events
* event_category
*:Service categories
* event_field
*:Intake forms
* facebookImage
*:Facebook client info
* financial_dashboard
*:Insights
* google_analytics
*:Google Adwords and analytics
* google_calendar_export
*:Calendar sync
* group_booking
*:Group bookings
* hipaa
*:HIPAA
* limit_bookings
*:Limit bookings
* location
*:Multiple locations
* mobile_app_backend
*:Mobile application
* multiple_booking
*:Multiple bookings
* news
*:News
* paid_events
*:Accept payments

* recap
*:Daily report
* secure
*:SSL
* status
*:Status
* unit_colors
*:Providers color coding
* user_license
*:Terms and conditions
* cancelation_policy
*:Cancellation Policy

See [[Custom_Features|Custom Features]] page for description for each Custom Feature.

</translate>

<translate>

== Examples ==

====getBookingDetails response====

An example of data returned by [[#getBookingDetails|getBookingDetails]] API method.

{
"id": "321",
"event_id": "5",
"event_name": "Massage",
"unit_id": "3",
"unit_name": "John",
"client_id": "1",
"client_name": "Bob",
"start_date_time": "2015-11-25 15:00:00",
"end_date_time": "2015-11-25 16:00:00",
"is_confirmed": "1",
"code": "h8v8w5ls",
"record_date": "2015-11-19 04:06:38",
"comment": null,
"company_login": "testzt",
"company_name": "My Cool Company",
"company_phone": "+1-555-55-55",
"company_email": "into@mycoolcompany.com",
"additional_fields": [{
"value": "on",
"field_name": "201a89517de509f6b3a60858918faac3",
"field_title": "Include washing",
"field_position": "4",
"field_type": "checkbox",
"field_id": "4"
}],
"comments": [],
"history": [{
"id": "536",
"sheduler_id": "321",
"datetime": "2015-11-19 11:06:38",
"type": "create",
"user_id": "1",
"agent": "SimplyBook.me\/55 CFNetwork\/758.0.2 Darwin\/15.0.0",
"ip": "213.174.0.53, 158.69.224.50:127.0.0.1",
"referer": "",
"login": "admin",
"firstname": "Mikhail",
"lastname": ""
}],
"status": {
"id": "3",
"name": "Fancy Status",
"description": null,
"color": "4cbadb",
"is_default": "1"
},
"location": {
"id": "1",
"title": "location",
"description": null,
"picture": "e1e9409fe9682c78b2f8f294dc151af0.jpg",
"address1": null,
"address2": "Saint Margaret Street",
"city": "\u041b\u043e\u043d\u0434\u043e\u043d",
"zip": null,
"country_id": "GB",
"lat": "51.50013000000000000000",
"lng": "-0.12630500000000000000",
"phone": "44",
"position": "1",
"is_default": "1"
},
"price": [],
"promo": false
}

</translate>

<translate>

Location field is present in response only if [[Custom_Features#Multiple_Locations|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.

Status field is present in response only if [[Custom_Features#Status|Status Custom Feature]] is enabled. Otherwise this field will be an empty array. If Custom Feature enabled but booking doesn't have any statues specified the default status returned.

Price field is present in response only if [[Custom_Features#Accept_Payments|Accept payments Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a free service.


<code>additional_fields</code> field is present in response only if [[Custom_Features#Intake_Forms|Intake Forms Custom Feature]] is enabled. Otherwise this field will be an empty array. This field contains an empty array if Custom Feature is enabled but booking was created for a service with no intake forms.

</translate>

----

<translate>

====book response====

[[#book|<code>book</code>]] API method returns an object which contains list of objects with short description of newly create bookings. Method returns only one item in 'bookings' array for regular appointment and more than one item for recurring or batch bookings.

{
"require_confirm":false,
"bookings":[
{
"id":"434",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-30 13:00:00",
"end_date_time":"2015-12-30 13:30:00",
"is_confirmed":"1",
"code":"h8vc14ca",
"hash":"785cb8cce316e64765b94c05a635f4be"
},
{
"id":"435",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2015-12-31 13:00:00",
"end_date_time":"2015-12-31 13:30:00",
"is_confirmed":"1",
"code":"h8vc2pge",
"hash":"8b92d634541bfd93c0830967e56f4653"
},
{
"id":"436",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-04 13:00:00",
"end_date_time":"2016-01-04 13:30:00",
"is_confirmed":"1",
"code":"h8vc3urb",
"hash":"cd22a0bf183f7350e595988dd2486e5b"
},
{
"id":"437",
"event_id":"7",
"unit_id":"3",
"client_id":"34",
"start_date_time":"2016-01-05 13:00:00",
"end_date_time":"2016-01-05 13:30:00",
"is_confirmed":"1",
"code":"h8vc44d9",
"hash":"53f98ff4e4a0323aa907156c59c99362"
}
],
"batch_type":"batch_recurrent_booking",
"recurrent_batch_id":"1",
"batch_hash":"357178bce290381bb7235080941ec143"
}

</translate>

----

<translate>

====getCompanyInfo response====

An example of data returned by [[#getCompanyInfo|getCompanyInfo]] API method.

{
"login": "pierrecoetzee",
"name": "Pierre",
"description": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"address1": "",
"address2": "Storey's Gate, ",
"city": "London",
"country_id": "GB",
"lat": "51.500435",
"lng": "-0.129811",
"email": "pierre.coe@gmail.com",
"phone": "",
"web": null,
"skip_address": null,
"logo": null,
"address": "GB, London, Storey's Gate, ",
"description_text": "Write a description about your company or about you as a service provider. You can add other service providers inside the system and each can have his own description.",
"timezone": "Europe London",
"show_in_client_timezone": false,
"timeframe": "60",
"timeline_type": "modern_week",
"allow_event_day_break": "0",
"allow_event_breaktime_break": "0"
}

<code>timeline_type</code> field can be one the following values:

* flexible
* modern
* flexible_week
* modern_week
* classic
* classes

</translate>

<translate>
Please note that <code>classic</code> timeline type is deprecated and not supported anymore.

<code>description</code> field contains raw data of company's description which can include HTML tags. <code>description_text</code> field contains only text information without HTML tags.

For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params|Company params section]].

</translate>
----

<translate>

<!--====getPluginPromoInfoByCode response====

{
"id": "1",
"title": "[service\/services] with [discount]% discount!",
"code": "yvuvugum",
"description": "We are offering [service\/services] with an amazing [discount]% discount! We are running this deal for a limited time only.",
"discount": "99.9999",
"start_date": "2015-12-23",
"expired_date": "2016-01-23",
"sheduler_start_date": "2015-12-23",
"sheduler_end_date": "2015-12-31",
"sheduler_start_time": "09:00:00",
"sheduler_end_time": "22:30:00",
"allow_usage_count": "20",
"fineprint_text": "Deal is limited for new clients only. Reward is claimable [client_claim_times_number] times per client. Deal is only claimable for the locations specified. Deal is cannot be combined with any other promotion. Must be redeemed prior to the expiration date shown on the deal.",
"redemption_text": "Present your confirmation code when you want to redeem your deal. You may either to print off your confirmation email or show your confirmation code by loggin into Simplybook on your mobile phone\/Pc.\r\n[promocode]\r\n[discount]\r\n[reward]\r\n[referal_qty]",
"headline": "[service\/services] with [discount]% discount!",
"image": null,
"allow_customer_count": "1",
"show_in_catalogue": "1",
"status": "active",
"plugin_promo_message_id": "1",
"common_promotion_id": "132",
"service_ids": ["1"]
}

<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
</translate>