Auto Actions: Difference between revisions

Jump to navigation Jump to search
← Older edit
Lesley (talk | contribs)
3,945 edits
Lesley (talk | contribs)
3,945 edits
 
(15 intermediate revisions by the same user not shown)
Line 184: Line 184:
For example, you have an auto action that sends a message to the guest, but only after another action has already triggered.  
For example, you have an auto action that sends a message to the guest, but only after another action has already triggered.  


Consider the auto action to add a pending payment to a booking for the Security deposit authorisation, this should only be triggered when the Booking info code = STRIPEPAYEMNT or CARDTOSTRIPE, both confirm the guest credit card is in the booking.
Consider the auto action to add a pending payment to a booking for the Security deposit authorisation, this should only be triggered when the Booking info code = STRIPEPAYMENT or CARDTOSTRIPE, both confirm the guest credit card is in the booking.


=== Invoice ===
=== Invoice ===
Line 316: Line 316:
For example a trigger that tests all bookings from booking time for 1 year will test many bookings while a trigger that tests only the 7 days before check-in will test less bookings and perform faster.
For example a trigger that tests all bookings from booking time for 1 year will test many bookings while a trigger that tests only the 7 days before check-in will test less bookings and perform faster.


The test tab of the auto action has a button that will show you how many and which bookings are being tested by the auto action.
The '''test tab''' of the auto action has a button that will show you how many and which bookings are being tested by the auto action. The list may include booking that will not trigger the auto action.  
 
To check if the booking meets all the rules, enter the booking number and test if the auto action would trigger on that booking with some diagnostics information shown to help trouble shooting.
It is also possible to specify a booking number and test if the auto action would trigger on that booking with some diagnostics information shown to help trouble shooting.
Alternatively open the booking and go to the Mail & Action tab, then search for the auto action id, check the details in the Status column.  


'''Optimising your auto actions''' You can trigger multiple actions in one auto action,  
'''Optimising your auto actions''' You can trigger multiple actions in one auto action,  
Line 437: Line 437:
=== Send Emails/Message/SMS to guests ===
=== Send Emails/Message/SMS to guests ===


<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span>  Message API messages will be shown in the message tab of the booking and in the Channel Message centre. Currently this is only available for Booking.com and Airbnb.  
<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span>  Message API messages will be shown in the message tab of the booking and in the Channel Message centre. Currently this is only available for Booking.com, Airbnb, Expedia and VRBO.  


<div class="mw-collapsible mw-collapsed">
<div class="mw-collapsible mw-collapsed">
Line 2,407: Line 2,407:


The fee/charge will be added the next time the auto actions run.  
The fee/charge will be added the next time the auto actions run.  
</div>
</div>
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >
====Add a new charge - City tax, calculated from number of nights/adults in a booking ====
</div>
<div class="mw-collapsible-content">
Some locations have set a cap on the Tourist tax based on the number of adults, upto a max 7 nights, you can use the calculation below to test the values and apply the appropriate charge or the cap.
This example will calculate the Price, testing if the 'number of nights' *'number of adults' *2 *1.03 is greater than 7 (nights) *'number of adults' *1.03
Then set the value = 7* number of adults *2 *1.03
ELSE set the value = 'number of nights' * 'number of adults' *2 *1.03
Special characters ^~ are required rather than :| as the | can be used as a separator in the Description field to set the Description|Status|Price|VAT
Trigger tab:
Time :
*Trigger Event = Booking
*Trigger Time = Immediate
*Trigger Window = 1 day
Booking Conditions:
*Status = All not Cancelled
Booking Source:
*Booking Source = Direct
Invoice tab:
*Type = Amount
*Description = Tourist Tax|Stayfee|[IF>^[NUMNIGHTS][*][NUMADULT][*]2[*]1.03^7[*][NUMADULT][*]2[*]1.03^7[*][NUMADULT][*]2[*]1.03~[NUMNIGHTS][*][NUMADULT][*]2[*]1.03]
*Amount = 0 (leave as 0 so the value is set from the calculation in the Description field)
*Per = Room
*Period = one time
*VAT = 19% (for example - enter the VAT amount if applicable)
The fee/charge will be added the next time the auto actions run.
</div>
</div>
</div>
</div>
Line 2,464: Line 2,507:
*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)
*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)


</div>
</div>
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >
==== Update VAT value for Charge item - City Tax (for example) ====
</div>
<div class="mw-collapsible-content">
You need to change the VAT value for specific items (City tax) in the Charges & Payments tab of the booking.
Trigger tab:
*Trigger Event = Booking
*Trigger Time = Immediate
*Time Window = 365
*Booking Source = Expedia (for example)
Invoice tab:
*Add Invoice Item = Update Only
*Type = Change VAT
*Description = City Tax (this needs to be an exact match to the charge item description)
*Amount = 0
*VAT = 12 (for example)
*Per = Per Person
*Period = One time
*Invoicee = Ignore
</div>
</div>
<div class="mw-collapsible mw-collapsed">
<div  class="headline-collapse" >
==== Update VAT value for the Accommodation fee (first item in the Charges & Payments tab) ====
</div>
<div class="mw-collapsible-content">
You need to change the VAT value for the Accommodation fee usually the first line the Charges & Payments tab of the booking.
Trigger tab:
*Trigger Event = Booking
*Trigger Time = Immediate
*Time Window = 365
*Booking Source = ALL (or select a specific channel)
Invoice tab:
*Add Invoice Item = Update Only
*Type = Change VAT
*Description = [ROOMNAME1] [FIRSTNIGHT] - [LEAVINGDAY][NOCONVERT]
Check the Description in the Charges & Payments tab for the Accommodation charge usually [ROOMNAME1] [FIRSTNIGHT] - [LEAVINGDAY]
To update this value you also need [NOCONVERT] so the template variable is used rather than the value.
*Amount = 0
*VAT = 12 (for example)
*Per = Per Person
*Period = One time
*Invoicee = Ignore


</div>
</div>
Line 2,495: Line 2,601:
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
*Amount = enter the amount or percentage you want to collect
*Amount = enter the amount or percentage you want to collect
*Payment Rule = use auto or manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT->PAYMENT COLLECTION they will be available here  
*Payment Rule = use auto or manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT> PAYMENTS they will be available here  
*Payment Due = Set when the payment is due
*Payment Due = Set when the payment is due


Line 2,555: Line 2,661:
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
*Amount = 0
*Amount = 0
*Payment Rule = use auto or manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) Payments > Payment Rules they will be available here  
*Payment Rule = use auto or manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT RULES they will be available here  
*Payment Due = Set when the payment is due
*Payment Due = Set when the payment is due


Line 2,733: Line 2,839:


Booking Info tab:
Booking Info tab:
*Booking Info Code : Enter the preset code for the icon or info code which you have created in {{#fas:cog}} (SETTINGS) ACCOUNT->PREFERENCES.
*Booking Info Code : Enter the preset code for the icon or info code which you have created in {{#fas:cog}} (SETTINGS) ACCOUNT > PREFERENCES.
*Booking Info Text : Enter the text you wish to show
*Booking Info Text : Enter the text you wish to sho


Process Template Variables : When created
Process Template Variables : When created
Line 2,788: Line 2,894:
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
*Status = if you use the status function add the status you want to apply to the pending payment (optional)
*Amount = enter the amount or percentage you want to collect
*Amount = enter the amount or percentage you want to collect
*Payment Rule = Manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT->PAYMENT COLLECTION they will be available here  
*Payment Rule = Manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT RULES they will be available here  
*Payment Due = Set when the payment is due
*Payment Due = Set when the payment is due


Line 3,246: Line 3,352:
  You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br>
  You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br>
  '''API key:'''
  '''API key:'''
*{{#fas:cog}} (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS  "API Key 1"
*{{#fas:cog}} (SETTINGS) ACCOUNT > ACCOUNT >ACCESS  "API Key 1"
*API Key = my_very_secret_api_key
*API Key = my_very_secret_api_key
*API Key Access = allow any IP
*API Key Access = allow any IP
Line 3,287: Line 3,393:
You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br>
You need two keys to use our API JSON functions - one for the API itself and one for the property. The keys have to consist of 16 characters of your choosing.<br>
'''API key:'''
'''API key:'''
*{{#fas:cog}} (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS  "API Key 1"
*{{#fas:cog}} (SETTINGS) ACCOUNT > ACCOUNT > ACCESS  "API Key 1"
*API Key = my_very_secret_api_key
*API Key = my_very_secret_api_key
*API Key Access = allow any IP
*API Key Access = allow any IP
Line 3,294: Line 3,400:
*Property Access = Owned by this account only
*Property Access = Owned by this account only
*'''Property key:'''
*'''Property key:'''
*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS> propKey = secret_key_for_prop_XXXXXX
*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX


Set the triggers you need, for example:
Set the triggers you need, for example:
Retrieved from "https://wiki.beds24.com/index.php/Auto_Actions"