Auto Actions: Difference between revisions

(79 intermediate revisions by the same user not shown)

Line 14:

==Summary==

An Auto Action is an action which can be used '''manually or programmed to run automatically''' at a ~~specific~~ time relative to the time of the '''booking''', to the '''check-in''' date or to the '''check-out''' date.

An Auto Action is an action which can be used '''manually or programmed to run automatically''' at a time relative to the time of the '''booking''', to the '''check-in''' date or to the '''check-out''' date.

Auto actions have one or more trigger conditions and one or more actions. They can be triggered on a number of different conditions, like property, time or booking related conditions. Auto Actions can

Line 30:

Using 'Group Keywords' you can refine the triggers in the Auto Action to include/exclude properties if the purpose/message in the Auto action needs to be different.

<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}} </span> Auto Actions are not designed as real-time actions. They are ~~sent~~ in batches ~~at times~~ so we recommend you set your triggers to allow for this.

<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}} </span> Auto Actions are not designed as real-time actions. They are processed in batches so we recommend you set your triggers to allow for this.

== Setup ==

Line 55:

'''Auto sending:'''

~~The auto action batch process runs multiple times per hour.~~

Auto Action Emails which are sent automatically by the system are sent from the EMail address of the account that created the Auto Action. This is the account set up in in {{#fas:cog}} (SETTINGS) ACCOUNT-> OUTGOING EMAIL.

Line 181:

Line 179:

=== Booking Info ===

Set up auto actions which automatically add or remove info codes. This is good practice for reporting and also to trigger/exclude bookings from other auto actions.

Booking info codes can be used to 'sequence' your auto actions.

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 = STRIPEPAYMENT or CARDTOSTRIPE, both confirm the guest credit card is in the booking.

=== Invoice ===

Line 197:

Line 201:

=== Webhook ===

Create auto actions which trigger a web hook when the trigger conditions are met.

== Same day/Near term bookings ==

With Same day/Near term bookings, consider the actions/messages you want to trigger with your auto actions.

If you have messages/emails that need to send to your guest at various points before they arrive at your property, then for Same day/Near term bookings, you should consider consolidating the information and sending one message/email.

In the Trigger tab of the auto action, 'Between booking and check-in' can be used to manage which bookings the action can be triggered on.

===Example 1 - Same day booking ===

Trigger tab:

*Trigger Event = Booking

*Trigger Time = Immediate

*Between Booking and Check in = 0 and 0 (same day).

For your other auto actions, set the Between Booking and Check in = 1 and 999, then they will not trigger on same day bookings.

===Example 2 - Near term booking ===

If your business process is to send a confirmation message at the time of booking, then the check-in instructions 2 days before arrival, then for same day bookings, you can use 1 auto action.

Trigger tab:

*Trigger Event = Booking

*Trigger Time = Immediate

*Between Booking and Check in = 0 and 2 (Near term).

Message tab: consolidate the message from your standard Confirmation message and check-in instructions.

For your other auto actions, set the Between Booking and Check in = 3 and 999, then they will not trigger on Near term bookings.

== Multiple Properties ==

Line 285:

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.

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,

Line 328:

Line 359:

If you have sub accounts and need an auto action to be used across multiple accounts/properties, then create the auto action at the Master Account Level and set Property = 'All visible in account' and ensure the Master account has access to the properties.

== ~~Examples~~ ==

== Use Cases ==

=== ~~Send Emails/Message/SMS to guests~~ ===

=== Guest Management ===

{| class="wikitable"

! scope="col"| Guest Management

! scope="col"| Link to Auto Action example

|-

~~<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.~~

|You want to send a confirmation message to bookings received from OTAs/Channels

|[[Auto_Actions#Email_confirmation_for_channel_bookings_-_Select_from_the_predefined_template|Send Confirmation message to Channel bookings]]

|-

~~<div class="mw-collapsible mw-collapsed">~~

|You want to send a booking registration form (PDF) to your guests so they can complete all guest details

~~<div class="headline-collapse" >~~

|[[Auto_Actions#Send_Email_with_Booking_Registration_Form_-_PDF_attachment|Send an email with Booking registration document (PDF)]]

~~====Send an Email~~ to ~~the guest when the status of~~ a booking ~~changes~~ to ~~"Cancelled"====~~

|-

~~</div>~~

~~<div class="mw-collapsible~~-~~content">~~

~~'''Trigger tab:'''~~

|Send a confirmation message to the guest when a payment has been received

|[[Auto_Actions#Send_an_Email_to_the_guest_when_a_payment_is_made|Send email/message to confirm receipt of a payment]]

|-

~~Time:~~

|You want to send an Invoice (PDF) to the guest after checkout

*Trigger Event = Check-in

|[[Auto_Actions#Send_invoice_after_check-out_-_PDF_attachment_-_Select_from_the_predefined_template|Send an invoice to the guest after checkout]]

*Trigger Time = -~~365~~

|-

*Trigger Window = 365

~~Booking Source~~

|You want to send an email to the guest confirming their booking has been cancelled

*Booking Source = All (for example)

|[[Auto_Actions#Send_an_Email_to_the_guest_when_the_status_of_a_booking_changes_to_.22Cancelled.22|Send Cancellation notice to the guest]]

|-

~~Booking Conditions~~

! scope="col"| Payments

*Booking Status = ~~Cancelled~~

! scope="col"| Link to Auto Action example

|-

~~'''Message tab''': For channels using the Message API, then enter the text in the Plain text box,~~ for ~~emails enter the text in the HTML box.~~

|You want to send a payment Request to your guests for all bookings

|[[Auto_Actions#Send_a_Request_for_payment_to_your_guests_for_all_bookings|Send a payment request for all bookings]]

|-

*Send Message = Booking API/Smart Email

|You want to send a Request for payment to your guests after the booking has been created

|[[Auto_Actions#Send_a_Request_for_payment_to_your_guests_XX_days_after_booking|Send a payment request after the booking]]

|-

|You want to send a Request for payment to your guests XX days BEFORE CHECK-IN

|[[Auto_Actions#Send_a_Request_for_payment_to_your_guests_XX_days_before_check-in|Send a payment request for payment before checkin]]

|-

|STRIPE - Send a Request to 'Authorise' a Security deposit from your guests before check-in

|[[Auto_Actions#Send_a_Request_to_.27Capture.27_a_Security_deposit_from_your_guests_XX_days_before_check-in_-_with_Stripe|Authorise a Security deposit on the Guest credit card]]

|-

|STRIPE - The guest payment has failed, send an email to the guest with the details.

|[[Auto_Actions#Send_an_email_to_the_guest_email_address_when_a_payment_FAILS_at_Stripe|Send an email when the guest payment has failed]]

|-

|STRIPE - The guest's credit card as it will expire before checkin, send a request so they can update their details.

|[[Auto_Actions#Send_a_Request_to_update_the_guest.27s_credit_card_as_it_will_expire_before_checkin|Send a request to update their credit card details]]

|-

! scope="col"| Check-in Details

! scope="col"| Link to Auto Action example

|-

|You want to send an Email with access instructions and a key code 1 day before check-in (Self Checkin)

|[[Auto_Actions#Send_an_Email_with_a_key_code_for_a_specific_unit_one_day_before_check-in_.28Self_Checkin.29|Send access details to your guest prior to arrival]]

|-

|You want to send Email to guests with check-in details before Check-in - Fully paid

|[[Auto_Actions#Send_Email_to_guests_with_check-in_details_2_days_before_Check-in.2C_booking_paid.2Fno_outstanding_balance|Send access details as booking is fully paid]]

|-

|You want to send Email to guests with check-in details before Check-in - Security Deposit Authorised at Stripe

|[[Auto_Actions#Send_Email_to_guests_with_check-in_details_2_days_before_Check-in.2C_Security_Deposit_Authorised_at_Stripe|Send access details as Security deposit authorised at Stripe]]

|-

|}

== Examples ==

=== 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, Airbnb, Expedia and VRBO.

====Send an Email to the guest when the status of a booking changes to "Cancelled"====

</div>

'''Trigger tab:'''

Time:

*Trigger Event = Check-in

*Trigger Time = -365

*Trigger Window = 365

Booking Source

*Booking Source = All (for example)

Booking Conditions

*Booking Status = Cancelled

'''Message tab''': For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

*Send Message = Booking API/Smart Email

If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.

Line 429:

Line 534:

Time:

*Trigger Event = ~~Check~~-in

*Trigger Event = Booking (but not after check-in)

*Trigger Time = ~~-365 days~~

*Trigger Time = Immediate

*Trigger Window = ~~355 days~~

*Trigger Window = 1 day

*Between Booking and Check in = 10 to 999

Booking Conditions:

Line 1,136:

Line 1,242:

Trigger tab:

*Trigger Event = ~~After~~ Booking

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = 365

Line 1,245:

Line 1,351:

====Send Remotelock/Lockstate, Nuki PIN or Chekin Link 2 days before Check-in (Self Checkin) - ''Select from the predefined template'' ====

====Send Remotelock/Lockstate, Nuki PIN, TTLOCK or Chekin Link 2 days before Check-in (Self Checkin) - ''Select from the predefined template'' ====

</div>

Line 1,263:

Line 1,369:

Info Codes :-

*Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL (select the appropriate Booking Info Code for the service you use)

*Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL or LOCK_PIN (select the appropriate Booking Info Code for the service you use)

'''Messaging tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.

Line 1,277:

Line 1,383:

*Plain text box - will send to channels using Message API

Message Text :- enter the text you wish to send to your guests include URL. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]

Message Text :- enter the text you wish to send to your guests include URL. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] ] or [BOOKINGINFOCODETEXT:LOCK_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]

*HTML box - Email will be sent

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]

Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] or [BOOKINGINFOCODETEXT:LOCK_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]

</div>

Line 2,007:

Line 2,113:

Trigger tab:

*Trigger Event = ~~After~~ Booking

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = 365

Line 2,040:

Line 2,146:

Trigger tab:

*Trigger Event = ~~After~~ Booking

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = 365

Line 2,073:

Line 2,179:

Trigger tab:

*Trigger Event = ~~After~~ Booking

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = 1 day

Line 2,175:

Line 2,281:

Trigger tab:

*Trigger Event = ~~After~~ Booking

*Trigger Event = Booking

*Trigger Time = immediately

*Trigger Window = 365

Line 2,189:

Line 2,295:

====Identify bookings with Custom Question ticked/unticked ====

</div>

Line 2,199:

Line 2,306:

Trigger tab:

*Trigger Event = ~~After~~ Booking

*Trigger Event = Booking

*Trigger Time = ~~immediately~~

*Trigger Time = Immediate

*Trigger Window = 365

*Booking Source = All

Line 2,220:

Line 2,327:

Trigger tab:

*Trigger Event = ~~After~~ Booking

*Trigger Event = Booking

*Trigger Time = Immediate

*Booking Source = Expedia (for example)

Line 2,303:

Line 2,410:

</div>

==~~=Modify description/values of an existing invoice item in a booking ===~~

~~<div class~~=~~"mw-collapsible mw-collapsed">~~

====Add a new charge - City tax, calculated from number of nights/adults in a booking ====

~~<div class~~=~~"headline-collapse" >~~

==~~==Update the Description field of~~ a charge/~~invoice item~~====

</div>

~~In some cases Channel bookings~~ have ~~different descriptions for~~ the ~~same~~ charge ~~item - i~~.~~e. Cleaning, update the description field in~~ the ~~invoice item so they all match~~, ~~using~~ the ~~format~~ (~~findthisinvoicedescription^replacewiththisdescription~~)

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

~~Trigger tab:~~

Then set the value = 7* number of adults *2 *1.03

*~~Trigger Event = After Booking~~

ELSE set the value = 'number of nights' * 'number of adults' *2 *1.03

*~~Trigger Time = Immediate~~

*~~Booking Source = Expedia (for example)~~

~~Invoice tab~~:

*Add Invoice Item = Update Only

*Type = Change Description

*Description = Cleaning^Cleaning Service Fee

*Invoicee = Ignore (otherwise you can ~~add~~ a ~~specific Invoicee~~ to ~~limit~~ the ~~search)~~

Trigger tab:

~~</div>~~

Time :

~~</div>~~

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = 1 day

~~<div class="mw-collapsible mw-collapsed">~~

Booking Conditions:

~~<div class~~=~~"headline-collapse" >~~

*Status = All not Cancelled

~~====Update all values of a charge/invoice item====~~

Booking Source:

*Booking Source = Direct

~~</div>~~

~~<div class="mw-collapsible-content">~~

You need to change the charges in bookings due to an update in your prices. Tourist Tax (for example), update the description field and value using the format (findthisinvoicedescription^replacewiththisdescription)

~~Trigger tab~~:

*Trigger Event = After Booking

*Trigger Time = Immediate

*Time Window = 365

*Check In From = Select the first date of the Summer Season

*Check In To = Select the last date of the Summer Season

*Booking Source = ~~Expedia (for example)~~

Invoice tab:

*Add Invoice Item = Update Only

*Type = Amount

*Type = ~~Change All~~

*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]

*Description = Tourist Tax^~~Tourist Tax - Summer season 2022 (for example)~~

*Amount = 0 (leave as 0 so the value is set from the calculation in the Description field)

*Amount = 0~~.75~~

*Per = Room

*Per = ~~Per Person~~

*Period = one time

*Period = ~~One~~ time

*VAT = 19% (for example - enter the VAT amount if applicable)

*~~Invoicee~~ = ~~Ignore~~ (~~otherwise you can add a specific Invoicee to limit~~ the ~~search~~)

The fee/charge will be added the next time the auto actions run.

</div>

===~~Payments~~/~~Pending Payments~~===

===Modify description/values of an existing invoice item in a booking ===

====~~Add~~ a ~~pending payment~~====

====Update the Description field of a charge/invoice item====

</div>

~~Trigger tab:~~

*Trigger Event = After Booking or Before Check-in

*Trigger Time = set the time you want to collect the payment

*Booking Source =All (for example, you can also set different rules for different channels)

*Group Booking Trigger = Trigger only Master (this will trigger on individual bookings and Master booking if a group)

~~Booking Info tab: Optional~~

In some cases Channel bookings have different descriptions for the same charge item - i.e. Cleaning, update the description field in the invoice item so they all match, using the format (findthisinvoicedescription^replacewiththisdescription)

~~Add a booking info tab~~ for ~~information and reporting~~

*Flag Text = PendingPayment (for example)

*Flag Colour = select the ~~colour as this will be visible~~ in the ~~Calendar/Bookings list~~

~~Booking~~ tab: ~~Optional~~

Trigger tab:

*Booking ~~Info Code~~ = ~~PENDPAY~~

*Trigger Event = Booking

*Booking ~~Info Text~~ = ~~Pending payment added~~

*Trigger Time = Immediate

*Booking Source = Expedia (for example)

Invoice tab:

*~~Payment~~ Type = ~~select on what the payment is calculated (Percent of Balance due OR Group balance if you receive Group bookings)~~

*Add Invoice Item = Update Only

*Description = ~~the text you will see in the "Charges and Payments" tab~~

*Type = Change Description

*~~Status~~ = if you ~~use the status function~~ add ~~the status you want to apply~~ to the ~~pending payment (optional~~)

*Description = Cleaning^Cleaning Service Fee

*Amount = enter the amount or percentage you want to collect

*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)

*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 Due = Set when the payment is due

~~Create a Payment Rule to collect a payments when bookings are not cancelled.~~

</div>

~~Go to Settings~~ > ~~Payments~~ > ~~Payment Rules~~

~~Payment Rule :~~

====Update all values of a charge/invoice item====

~~Name~~ = ~~Enter your title~~ - ~~Not Cancelled (for example)~~

</div>

~~Action = Auto~~

~~Payment~~ Trigger :

You need to change the charges in bookings due to an update in your prices. Tourist Tax (for example), update the description field and value using the format (findthisinvoicedescription^replacewiththisdescription)

Trigger tab:

*Trigger Event = Booking

*Trigger Time = Immediate

*Time Window = 365

*Check In From = Select the first date of the Summer Season

*Check In To = Select the last date of the Summer Season

*Booking ~~Status~~ = ~~All not cancelled~~

*Booking Source = Expedia (for example)

*Any Booking Info Code = optional

*All Booking Info Codes = optional

*Exclude Booking Info Code = optional (~~can exclude Virtual Credit cards, find the Booking info code in the booking~~)

~~Payment Action~~ :

Invoice tab:

*Add Invoice Item = Update Only

*Type = Change All

*Description = Tourist Tax^Tourist Tax - Summer season 2022 (for example)

*Amount = 0.75

*Per = Per Person

*Period = One time

*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)

*Capture = Yes - immediately charged (Capture=Yes)

*Add info code on success = add a Booking Info item to the booking on success

*Add info code on failure = add a Booking Info item to the booking on failure

</div>

Line 2,420:

Line 2,514:

====~~Add a pending payment~~ - ~~Set the Security Deposit value based on the price of the booking, using a calculation~~ ====

==== Update VAT value for Charge item - City Tax (for example) ====

</div>

~~Trigger tab:~~

*Trigger Event = After Booking or Before Check-in

*Trigger Time = set the time you want to collect the payment

*Booking Source =All (for example, you can also set different rules for different channels)

~~Booking tab: Optional~~

You need to change the VAT value for specific items (City tax) in the Charges & Payments tab of the booking.

*Flag Text = PendingPayment (~~for example~~)

*Flag Colour = select the ~~colour as this will be visible in~~ the ~~Calendar/Bookings list~~

~~Booking Info~~ tab: ~~Optional~~

Trigger tab:

~~Add a booking info tab for information and reporting~~

*Trigger Event = Booking

*~~Booking Info Code~~ = ~~PENDPAY~~

*Trigger Time = Immediate

*Booking ~~Info Text~~ = ~~Pending payment added~~

*Time Window = 365

*Booking Source = Expedia (for example)

Invoice tab:

*~~Payment~~ Type = ~~fixed value~~

*Add Invoice Item = Update Only

*Description = ~~Security Deposit||[IF<=:[INVOICEFIRSTITEMNUM]:800:200|[INVOICEFIRSTITEMNUM][/.0]4]~~

*Type = Change VAT

(~~Security Deposit is~~ the description~~, then 2 | symbol, then the calculation for the 'Amount' to be set.~~)

*Description = City Tax (this needs to be an exact match to the charge item description)

*Amount = 0

~~This calculation, tests if the first invoice item value~~ (~~usually the Accommodation value~~) ~~is greater than or~~ = ~~800 if so set the Security Deposit Amount~~ = ~~1 quarter of the first invoice item value, otherwise set~~ = ~~200.~~

*VAT = 12 (for example)

*Per = Per Person

*Period = One time

*Invoicee = Ignore

</div>

<~~span~~ class="~~" style="color: #f3e504; font~~-~~size: 150%;~~" >~~{{#fas:lightbulb}}~~ <~~/span>~~ ~~<span style~~="~~font~~-~~weight: bold;~~" >Tip</span> A price value for the invoice item can be specified after a second pipe (|) symbol, this can be used to calculate a price using template variables. If the price value in the description field is zero or absent, the numeric value from the amount field will be used.

*Status = ~~if you use~~ the ~~status function add~~ the ~~status you want to apply to the pending payment (optional~~)

==== Update VAT value for the Accommodation fee (first item in the Charges & Payments tab) ====

*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 Due = ~~Set when the payment is due~~

</div>

~~Create a Payment Rule~~ to ~~collect a payments when bookings are not cancelled~~.

You need to change the VAT value for the Accommodation fee usually the first line the Charges & Payments tab of the booking.

~~Go to Settings > Payments > Payment Rules~~

Trigger tab:

*Trigger Event = Booking

*Trigger Time = Immediate

*Time Window = 365

*Booking Source = ALL (or select a specific channel)

~~Payment Rule~~ :

Invoice tab:

*Add Invoice Item = Update Only

*Type = Change VAT

*Description = [ROOMNAME1] [FIRSTNIGHT] - [LEAVINGDAY][NOCONVERT]

~~Name = Enter your title~~ - ~~Not Cancelled (for example)~~

Check the Description in the Charges & Payments tab for the Accommodation charge usually [ROOMNAME1] [FIRSTNIGHT] - [LEAVINGDAY]

~~Action = Auto~~

~~Payment Trigger :~~

To update this value you also need [NOCONVERT] so the template variable is used rather than the value.

*~~Booking Status~~ = ~~All not cancelled~~

*Amount = 0

*~~Any Booking Info Code~~ = ~~optional~~

*VAT = 12 (for example)

*All Booking Info Codes = optional

*Per = Per Person

*Exclude Booking Info Code = optional (~~can exclude Virtual Credit cards, find the Booking info code in the booking~~)

*Period = One time

*Invoicee = Ignore

~~Payment Action :~~

*~~Capture = Yes - immediately charged (Capture~~=~~Yes)~~

*~~Add info code on success~~ = ~~add a Booking Info item to the booking on success~~

*~~Add info code on failure~~ = ~~add a Booking Info item to the booking on failure~~

</div>

===Payments/Pending Payments===

====Add a pending payment====

====~~Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)~~====

</div>

Trigger tab:

*Trigger Event = Booking or Booking (but not after Check-in)

*Trigger Time = set the time you want to collect the payment

*Booking Source =All (for example, you can also set different rules for different channels)

*Group Booking Trigger = Trigger only Master (this will trigger on individual bookings and Master booking if a group)

~~''''Create~~ a ~~Payment Rule~~ (~~Optional~~)~~''''~~

Booking Info tab: Optional

Add a booking info tab for information and reporting

*Flag Text = PendingPayment (for example)

*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

~~Standard~~ payment rules in the system are Auto & Manual, you can create additional rules for the collection of outstanding payments, you can control the collection of payments if the booking status is changed, for example the booking is cancelled before the final payment is due to be collected.

Booking tab: Optional

*Booking Info Code = PENDPAY

*Booking Info Text = Pending payment added

Go to {{#fas:cog}} (SETTINGS) PAYMENTS ~~> PAYMENT RULES~~

Invoice tab:

*Payment Type = select on what the payment is calculated (Percent of Balance due OR Group balance if you receive Group bookings)

*Description = the text you will see in the "Charges and Payments" tab

*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

*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

~~Create a Payment Rule to collect payments if bookings are not cancelled.~~

~~Click '''~~Create ~~New~~ Payment Rule~~'''~~ :

Create a Payment Rule to collect a payments when bookings are not cancelled.

Go to Settings > Payments > Payment Rules

Payment Rule :

~~Payment Rule:~~

Name = Enter your title - Not Cancelled (for example)

*Name = Enter your title - Not Cancelled (for example)

Action = Auto

*Action = Auto

Payment Trigger :

*Booking Status = All not cancelled

*Any Booking Info Code (optional)

*Any Booking Info Code = optional

*All Booking Info Codes (optional)

*All Booking Info Codes = optional

*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)

Payment Action :

*Funding Source = Guest card only

*Payment value adjustment = Limit to group booking balance

*Capture = Yes - immediately charged (Capture=Yes)

*Add info code on success = add a Booking Info item to the booking on success

*Add info code on failure = add a Booking Info item to the booking on failure

~~Prevent Auto Payment :~~

</div>

*Prevent payment if booking status = Cancelled

</div>

*Prevent payment after check-out (days) = 7 (default)

*Prevent payment action = Set Manual

~~'''Create Auto Actions '''~~

====Add a pending payment - Set the Security Deposit value based on the price of the booking, using a calculation ====

</div>

Trigger tab:

*Trigger Event = Booking or Booking (but not after Check-in)

*Trigger Time = set the time you want to collect the payment

*Booking Source =All (for example, you can also set different rules for different channels)

~~Collect~~ the ~~outstanding balance for bookings created via your booking page.~~

Booking tab: Optional

*Flag Text = PendingPayment (for example)

*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

~~Go to {{#fas~~:~~cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS~~ and ~~click '''Create New Action''' to create them.~~

Booking Info tab: Optional

Add a booking info tab for information and reporting

*Booking Info Code = PENDPAY

*Booking Info Text = Pending payment added

~~'''Collect outstanding balance~~ for ~~direct bookings'~~''

Invoice tab:

*Payment Type = fixed value

*Description = Security Deposit||[IF<=:[INVOICEFIRSTITEMNUM]:800:200|[INVOICEFIRSTITEMNUM][/.0]4]

(Security Deposit is the description, then 2 | symbol, then the calculation for the 'Amount' to be set.)

This calculation, tests if the first invoice item value (usually the Accommodation value) is greater than or = 800 if so set the Security Deposit Amount = 1 quarter of the first invoice item value, otherwise set = 200.

~~Trigger tab~~:

<span class="" style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> <span style="font-weight: bold;" >Tip</span> A price value for the invoice item can be specified after a second pipe (|) symbol, this can be used to calculate a price using template variables. If the price value in the description field is zero or absent, the numeric value from the amount field will be used.

*Time

**Trigger Event = Checkin

**Trigger Time = -~~3 days~~ (~~set the time you want to collect the payment~~)

**Time Window = 3 days (set this to the ~~same number (positive) as Trigger time~~.

*~~Booking Source~~

*Status = if you use the status function add the status you want to apply to the pending payment (optional)

**~~Booking Source~~ = ~~Direct. You can~~ have ~~different auto actions/~~rules ~~for direct bookings -v- channel bookings, then select ‘Direct’ this~~ will ~~include manually created bookings and booking page bookings.~~

*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 Due = Set when the payment is due

*Booking Conditions

**Group Booking Trigger = Trigger only Master

**Status = All not cancelled

**Invoice Balance= Not Zero (can be used to refine the auto action being triggered)

~~Booking tab: Optional~~

Create a Payment Rule to collect a payments when bookings are not cancelled.

*Flag Text = Pending payment added (for example)

*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

~~Booking Info tab: Optional, for information and reporting~~

Go to Settings > Payments > Payment Rules

*Booking Info Code = BALANCE (for example enter the value - use one word only)

*Booking Info Text = Enter the description/text to ~~show in for the Booking Info Code.~~

~~Invoice tab~~:

Payment Rule :

~~<div class~~=~~"warning">{{#fas:exclamation~~-~~triangle}} ONLY use~~ Payment ~~Type~~ =~~‘ Percent of Group balance due’ if you selected Trigger tab >~~ Booking ~~Conditions > Group~~ Booking ~~Trigger~~ = ~~Trigger Only Master.</div>~~

Name = Enter your title - Not Cancelled (for example)

Action = Auto

Payment Trigger :

*Booking Status = All not cancelled

*Any Booking Info Code = optional

*All Booking Info Codes = optional

*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)

Payment Action :

*~~Add a Pending Payment to the booking~~

*Capture = Yes - immediately charged (Capture=Yes)

**Payment Type = ~~Percent of Group Balance due~~ (~~select on what the payment is calculated~~)

*Add info code on success = add a Booking Info item to the booking on success

**Description = the text you will see in the "Charges and Payments" tab

*Add info code on failure = add a Booking Info item to the booking on failure

**Status = ~~if you use the status function~~ add ~~the status you want to apply~~ to the ~~pending payment (optional)~~

**Amount = ~~100 (this will be 100% of the outstanding group balance)~~

**Payment Rule = Not Cancelled - See Step 4 above (if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS ->PAYMENT RULES they will be available here)

**Payment Due = Trigger date

**Payment time = set the time to ~~collect payment~~

**Invoicee = If you use the ~~"invoicee" function you can select which invoicee the pending payment will be assigned to.~~

</div>

Line 2,567:

Line 2,693:

====~~'Capture' a Security Deposit when~~ Credit card is collected at time of booking. ====

====Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)====

</div>

~~Trigger tab:~~

''''Create a Payment Rule (Optional)''''

*Trigger Event = After Booking

*Trigger Time = immediate

Standard payment rules in the system are Auto & Manual, you can create additional rules for the collection of outstanding payments, you can control the collection of payments if the booking status is changed, for example the booking is cancelled before the final payment is due to be collected.

*Booking Source =All (for ~~example~~, you can ~~also set different rules~~ for ~~different channels)~~

~~Info Codes~~:

Go to {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT RULES

~~Any Booking Info Code = CARDTOSTRIPE~~

~~Invoice tab:~~

Create a Payment Rule to collect payments if bookings are not cancelled.

*Payment Type = Fixed amount

*Description = Security Deposit (the text you will see in the "Charges and Payments" tab)

*Status = if you use the status function add the status you want to apply to the pending payment (optional)

*Amount = 100 (balance is full price so 100% of the balance)

*Payment Rule = Security Deposit (Create a Payment Rule~~, see below)~~

*Payment Due = check in

Click '''Create New Payment Rule''' :

~~<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> Automatic collection is only available for customer who use [[Stripe]].~~

Payment Rule:

*Name = Enter your title - Not Cancelled (for example)

Create a Payment Rule to 'Capture' a payment only. Captured payments will only be valid for 7 days, then it will expire, if the booking is for a longer period, then you can create a second Capture, you will need to create another auto action for this.

~~Go to {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT RULES~~

Payment Rule :

*Name = Enter your title - ~~Security Deposit~~ (for example)

*Action = Auto

Payment Trigger :

*Booking Status = ~~select from the drop down list~~

*Booking Status = All not cancelled

*Any Booking Info Code = optional

*Any Booking Info Code (optional)

*All Booking Info Codes = optional

*All Booking Info Codes (optional)

*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)

Payment Action :

*Capture = Yes~~/No~~ - immediately charged (Capture=Yes~~), if you want to make sure that the amount is available for later capture (Capture=No~~)

*Funding Source = Guest card only

*Payment value adjustment = Limit to group booking balance

*Capture = Yes - immediately charged (Capture=Yes)

*Add info code on success = add a Booking Info item to the booking on success

*Add info code on failure = add a Booking Info item to the booking on failure

~~</div>~~

~~<div class~~=~~"mw~~-~~collapsible mw-collapsed">~~

Prevent Auto Payment :

~~<div class~~=~~"headline-collapse" >~~

*Prevent payment if booking status = Cancelled

*Prevent payment after check-out (days) = 7 (default)

*Prevent payment action = Set Manual

~~====Apply an info code and and/or icon when a payment was made====~~

'''Create Auto Actions '''

~~</div>~~

~~<div class="mw-collapsible-content">~~

~~Trigger tab:~~

*Trigger Event = After Booking

*Trigger Time = Immediate

*Trigger Window = 365

*Booking Source = All

*Booking Status = All but not cancelled

*Invoice Balance = Any Payment made

~~Booking Info tab:~~

Collect the outstanding balance for bookings created via your booking page.

*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

~~Process Template Variables~~ : ~~When created~~

Go to {{#fas:cog}} (SETTINGS) GUEST MANAGEMENT > AUTO ACTIONS and click '''Create New Action''' to create them.

~~</div>~~

'''Collect outstanding balance for direct bookings'''

~~</div>~~

~~<div class~~=~~"mw~~-~~collapsible mw-collapsed">~~

Trigger tab:

~~<div class~~=~~"headline-collapse" >~~

*Time

**Trigger Event = Checkin

**Trigger Time = -3 days (set the time you want to collect the payment)

**Time Window = 3 days (set this to the same number (positive) as Trigger time.

=~~===Automatically apply invoice number at check-out - ''Select from predefined templates'' ====~~

*Booking Source

</~~div>~~

**Booking Source = Direct. You can have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.

~~<div class="mw~~-~~collapsible~~-~~content">~~

~~'''Trigger tab:'''~~

*Trigger ~~Event~~ = ~~Check-out~~

*Booking Conditions

*~~Trigger Time~~ = ~~Immediate~~

**Group Booking Trigger = Trigger only Master

*~~Time window~~ = ~~1 day~~

**Status = All not cancelled

**Invoice Balance= Not Zero (can be used to refine the auto action being triggered)

Booking ~~Conditions~~:

Booking tab: Optional

*~~Status~~ = ~~Confirmed~~

*Flag Text = Pending payment added (for example)

*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

Booking Info tab: Optional, for information and reporting

*Booking Info Code = BALANCE (for example enter the value - use one word only)

*Booking Info Text = Enter the description/text to show in for the Booking Info Code.

Invoice tab:

~~Info Codes~~:

<div class="warning">{{#fas:exclamation-triangle}} ONLY use Payment Type =‘ Percent of Group balance due’ if you selected Trigger tab > Booking Conditions > Group Booking Trigger = Trigger Only Master.</div>

*Any Booking Info Code = ~~CHECKOUT (optional only~~ if you ~~use the check-out function)~~

~~'''Invoice~~ tab:~~'''~~

*Add a Pending Payment to the booking

**Payment Type = Percent of Group Balance due (select on what the payment is calculated)

**Description = the text you will see in the "Charges and Payments" tab

**Status = if you use the status function add the status you want to apply to the pending payment (optional)

**Amount = 100 (this will be 100% of the outstanding group balance)

**Payment Rule = Not Cancelled - See Step 4 above (if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS ->PAYMENT RULES they will be available here)

**Payment Due = Trigger date

**Payment time = set the time to collect payment

**Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.

*Assign Invoice Number = yes

</div>

Line 2,661:

Line 2,780:

====~~Using Pending Payments as~~ a ~~Payment Reminder~~====

===='Capture' a Security Deposit when Credit card is collected at time of booking. ====

</div>

Trigger tab:

*Trigger Event = ~~After~~ Booking ~~or Before Check-in~~

*Trigger Event = Booking

*Trigger Time = ~~set the time you want to add the pending payment to the booking~~

*Trigger Time = immediate

*Booking Source =All (for example, you can also set different rules for different channels)

~~Booking~~ Info ~~tab~~:

Info Codes:

*Optional, add a booking info tab for information and reporting

Any Booking Info Code = CARDTOSTRIPE

Booking ~~tab: Optional~~

*Flag Text = PaymentDue1 (for example), set multiple if multiple payments are required.

*Flag Colour = ~~select the colour as this will be visible in the Calendar/Bookings list~~

Invoice tab:

*Payment Type = ~~select on what the payment is calculated (Percent of Balance due)~~

*Payment Type = Fixed amount

*Description = the text you will see in the "Charges and Payments" tab

*Description = Security Deposit (the text you will see in the "Charges and Payments" tab)

*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 = 100 (balance is full price so 100% of the balance)

*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 = Security Deposit (Create a Payment Rule, see below)

*~~Payment Due~~ = ~~Set when the payment is due~~

*Payment Due = check in

<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}} </span> Automatic collection is only available for customer who use [[Stripe]].

Create a Payment Rule to 'Capture' a payment only. Captured payments will only be valid for 7 days, then it will expire, if the booking is for a longer period, then you can create a second Capture, you will need to create another auto action for this.

Go to {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT RULES

Payment Rule :

*Name = Enter your title - Security Deposit (for example)

*Action = Auto

~~The Pending~~ Payment ~~Report is available in Bookings > Pending Payments. This report~~ can ~~be used to see outstanding pending payments, this can be used to see all outstanding payments, when payment gateways other than Stripe are used~~, the ~~Pending Payments report can be used to see outstanding payments and a checklist for bank transfers.~~

Payment Trigger :

*Booking Status = select from the drop down list

*Any Booking Info Code = optional

*All Booking Info Codes = optional

*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)

Payment Action :

*Capture = Yes/No - immediately charged (Capture=Yes), if you want to make sure that the amount is available for later capture (Capture=No)

*Add info code on success = add a Booking Info item to the booking on success

*Add info code on failure = add a Booking Info item to the booking on failure

</div>

Line 2,692:

Line 2,827:

====~~Test if Stripe Authorisation has expired~~ and ~~you need to trigger~~ a ~~new authorisation~~ ====

====Apply an info code and and/or icon when a payment was made====

</div>

~~Stripe authorisations are dependent on a number of factors including your account type, credit card provider, Stripe rules and the guest bank provider.~~

Trigger tab:

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = 365

*Booking Source = All

*Booking Status = All but not cancelled

*Invoice Balance = Any Payment made

If you have ~~bookings that are longer than~~ the ~~authorisation period,~~ you ~~will need to create multiple authorisations. You can use the details below in an auto action~~ to ~~test the date/value of the text/description of the Booking info code = 'STRIPEAUTHORIZE'~~

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 Text : Enter the text you wish to sho

~~For example you have a booking that is for 14 nights, but the authorisation period is 7 days.~~

Process Template Variables : When created

~~Trigger tab:~~

</div>

*Trigger Event = ~~Checkin~~

*Trigger Time = ~~+ 7 days~~

*Trigger Window = 365

*Booking Source = All

*Booking Status = ~~All but not cancelled~~

~~Booking Conditions~~

====Automatically apply invoice number at check-out - ''Select from predefined templates'' ====

</div>

'''Trigger tab:'''

*~~Group Booking~~ Trigger = ~~Trigger only Master~~

*Trigger Event = Check-out

*~~Status = All not cancelled~~

*Trigger Time = Immediate

*Invoice Balance= Any

*Time window = 1 day

*Minimum Stay = 7

*~~Maximum Stay~~ = 14

~~Info Codes~~

Booking Conditions:

*~~Any booking info code = CARDTOSTRIPE, STRIPEAUTHORIZE~~

*Status = Confirmed

*Exclude Booking Info code = ~~BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT~~

~~<span style~~=~~"color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If~~ you ~~receive virtual credit cards from~~ the ~~channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.~~

Info Codes:

*Any Booking Info Code = CHECKOUT (optional only if you use the check-out function)

~~Booking Fields~~

'''Invoice tab:'''

*Template Variable = [IF<^[AUTHORIZEUNTIL{%Y-%m-%d}]^[CURRENTDATEYYYY-MM-DD]^yes~no] equal yes

~~The entry in the info tab of the booking will typically be~~

*Assign Invoice Number = yes

</div>

~~STRIPEAUTHORIZE Authorize 1500.00 EUR until 2024~~-08-~~14........~~

====Using Pending Payments as a Payment Reminder====

</div>

Trigger tab:

*Trigger Event = Booking or Booking (but not after Check-in)

*Trigger Time = set the time you want to add the pending payment to the booking

*Booking Source =All (for example, you can also set different rules for different channels)

~~Check the substring numbers~~ for ~~your specific bookings, the date starts on the 28th char as the amount is 1500.00~~

Booking Info tab:

*Optional, add a booking info tab for information and reporting

Booking tab: Optional

*Flag Text = ~~Security Deposit Pending Payment~~ (for example)

*Flag Text = PaymentDue1 (for example), set multiple if multiple payments are required.

*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

~~Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.~~

*Booking Info Code - REFDEPPP (for example)

*Booking Info Text - Refundable Security Deposit pending payment

Invoice tab:

*Add a Pending Payment to the booking

*Payment Type = select on what the payment is calculated (Percent of Balance due)

*Payment Type = ~~Fixed amount~~

*Description = the text you will see in the "Charges and Payments" tab

*Status = if you use the status function add the status you want to apply to the pending payment (optional)

*Amount = ~~1500 (~~enter the ~~value~~ you want to ~~authorise on the guest credit card )~~

*Amount = enter the amount or percentage you want to collect

*Payment Rule = ~~Security Deposit~~ (~~use the payment rule~~)

*Payment Rule = Manual - if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT RULES they will be available here

*Payment Due = ~~Trigger date~~

*Payment Due = Set when the payment is due

*Payment time = set the time to collect payment

*Invoicee = If you use the "invoicee" function you can select which invoicee the ~~pending~~ payment ~~will be assigned to.~~

~~<span style="color: #f3e504; font-size: 150%;"~~ >~~{{#fas:lightbulb}} </span> If you accept Virtual Credit Cards from the channels~~, ~~then you will need~~ to ~~send a~~ payment ~~link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so~~ the ~~guest~~ can ~~authorise the payment on their own credit card, it is not possible~~ to ~~take a Security deposit from~~ a ~~virtual card~~.

The Pending Payment Report is available in Bookings > Pending Payments. This report can be used to see outstanding pending payments, this can be used to see all outstanding payments, when payment gateways other than Stripe are used, the Pending Payments report can be used to see outstanding payments and a checklist for bank transfers.

</div>

==~~=Booking Flags/Colours===~~

~~<div class~~=~~"mw-collapsible mw-collapsed">~~

====Test if Stripe Authorisation has expired and you need to trigger a new authorisation ====

~~<div class~~=~~"headline-collapse" >~~

==~~==Apply a flag when~~ a ~~booking is cancelled~~====

</div>

~~Trigger tab~~

Stripe authorisations are dependent on a number of factors including your account type, credit card provider, Stripe rules and the guest bank provider.

*Trigger Event = Booking

*Trigger Time = 1 Hour

*Trigger Window = 365 days

*Booking Status = Cancelled

~~Booking tab:~~

If you have bookings that are longer than the authorisation period, you will need to create multiple authorisations. You can use the details below in an auto action to test the date/value of the text/description of the Booking info code = 'STRIPEAUTHORIZE'

*Execution = One time only

*Booking Status = No Change

*Flag text = (enter the ~~text~~ you ~~require)~~

*Flag Colour = 999999 default cancel colour - (Set as required)

</~~div>~~

~~<div class="mw-collapsible mw-collapsed">~~

For example you have a booking that is for 14 nights, but the authorisation period is 7 days.

~~<div class="headline-collapse" >~~

~~====Apply a flag for a bookings from a channel which have breakfast included====~~

~~</div>~~

~~<div class="mw-collapsible-content">~~

Trigger tab:

*Trigger Event = After Booking

*Trigger Time = Immediate

*Booking Source = Booking.com (for example)

*Booking Field Contains - select "API Message" in the next field enter: meal_plan=Breakfast (or Extra Breakfast - use the text the channel uses)

~~Booking tab:~~

*Trigger Event = Checkin

*~~Execution~~ = ~~One time only~~

*Trigger Time = + 7 days

*~~Flag Text~~ = ~~The text you want to display~~

*Trigger Window = 365

*~~Flag Colour - choose the flag colour~~

*Booking Source = All

*Booking Status = All but not cancelled

Booking ~~changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.~~

Booking Conditions

~~</div>~~

~~<div class~~=~~"mw-collapsible mw-collapsed">~~

*Group Booking Trigger = Trigger only Master

~~<div class~~=~~"headline-collapse" >~~

*Status = All not cancelled

*Invoice Balance= Any

*Minimum Stay = 7

*Maximum Stay = 14

Info Codes

*Any booking info code = CARDTOSTRIPE, STRIPEAUTHORIZE

*Exclude Booking Info code = BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT

~~====Apply a flag for a bookings which has BREAKFAST as a charge item====~~

<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you receive virtual credit cards from the channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.

<~~/div>~~

~~<div class~~="mw-~~collapsible-content~~">

~~Trigger tab~~:

*Trigger Event = After Booking

*Trigger Time = Immediate

*Booking Source = Booking.com (for example)

*Template Variable = [IF>~~:[INVOICEITEMBYDESC:Breakfast]:0:yes|no] (Text for Breakfast has to match EXACTLY what is in the booking item Uppercase/Lowercase/Proper)~~

*Select 'equal' from the ~~selection box~~

*yes (needs to be exactly the same text/upper/lowercase, ~~as in~~ the ~~equation)~~

Booking ~~tab:~~

Booking Fields

*~~Execution~~ = ~~One time only~~

*Template Variable = [IF<^[AUTHORIZEUNTIL{%Y-%m-%d}]^[CURRENTDATEYYYY-MM-DD]^yes~no] equal yes

*Flag Text = Breakfast

*Flag Colour - ~~choose the flag colour~~

~~Booking Info~~ tab:

The entry in the info tab of the booking will typically be

*Booking Info Code = BREAKFAST

*Booking Info Description = Breakfast included

~~</div>~~

~~<div class="mw~~-~~collapsible mw~~-~~collapsed">~~

STRIPEAUTHORIZE Authorize 1500.00 EUR until 2024-08-14........

~~<div class="headline-collapse" >~~

~~====Apply a flag when deposit was made prior to~~ Check~~-in====~~

Check the substring numbers for your specific bookings, the date starts on the 28th char as the amount is 1500.00

~~</div>~~

~~<div class="mw-collapsible-content">~~

~~Trigger tab:~~

*Trigger Event = Check-in

Booking tab: Optional

*~~Trigger Time~~ = ~~-365~~ (for example ~~: must be a negative value and the same as the value in Trigger window~~)

*Flag Text = Security Deposit Pending Payment (for example)

*~~Trigger Window~~ = ~~365~~

*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list

*Booking Source = All

*Booking Status = All but not cancelled

*Invoice Balance = Any Payment made

~~Message~~ tab:

Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.

*Booking Info Code - REFDEPPP (for example)

*Booking Info Text - Refundable Security Deposit pending payment

Invoice tab:

*Add a Pending Payment to the booking

*Payment Type = Fixed amount

*Description = the text you will see in the "Charges and Payments" tab

*Status = if you use the status function add the status you want to apply to the pending payment (optional)

*Amount = 1500 (enter the value you want to authorise on the guest credit card )

*Payment Rule = Security Deposit (use the payment rule)

*Payment Due = Trigger date

*Payment time = set the time to collect payment

*Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.

*Send Email : ~~select appropriate option~~

<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you accept Virtual Credit Cards from the channels, then you will need to send a payment link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so the guest can authorise the payment on their own credit card, it is not possible to take a Security deposit from a virtual card.

*Enter : ~~Subject and Email content~~

~~Booking tab: (optional)~~

</div>

*Execution = ~~One time only~~

===Booking Flags/Colours===

*Flag Text = ~~The text you want to display~~

*Flag Colour - choose the flag colour

Booking ~~info tab : (optional)~~

====Apply a flag when a booking is cancelled====

</div>

Trigger tab

*Trigger Event = Booking

*Trigger Time = 1 Hour

*Trigger Window = 365 days

*Booking Status = Cancelled

*Booking ~~Info Code~~ : ~~DEPOSITPAID (for example)~~

Booking tab:

*Booking ~~Info Text : additional~~ text ~~if required.~~

*Execution = One time only

*Booking Status = No Change

~~Setting details with~~ the ~~Booking tab and Booking info tab allows~~ you ~~to trigger additional~~ (~~follow on~~) ~~Auto Actions and Reports.~~

*Flag text = (enter the text you require)

*Flag Colour = 999999 default cancel colour - (Set as required)

</div>

====Apply a flag ~~when booking is fully paid~~====

====Apply a flag for a bookings from a channel which have breakfast included====

</div>

Trigger tab:

*Trigger Event = ~~After~~ Booking

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = 365

*Booking Source = Booking.com (for example)

*Booking Source = ~~All~~

*Booking Field Contains - select "API Message" in the next field enter: meal_plan=Breakfast (or Extra Breakfast - use the text the channel uses)

*Booking ~~Status = All not cancelled~~

*Invoice Balance = ~~ZERO~~

Booking tab:

Line 2,875:

Line 3,006:

*Flag Text = The text you want to display

*Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.

</div>

Line 2,881:

Line 3,014:

====Apply a flag~~/colour~~ for a ~~booking coming from~~ a ~~certain channel - ''Select from the predefined template''~~ ====

====Apply a flag for a bookings which has BREAKFAST as a charge item====

</div>

Trigger tab:

~~'''~~Trigger tab:~~'''~~

*Trigger Event = Booking

*Trigger Time = Immediate

*Booking Source = Booking.com (for example)

*Template Variable = [IF>:[INVOICEITEMBYDESC:Breakfast]:0:yes|no] (Text for Breakfast has to match EXACTLY what is in the booking item Uppercase/Lowercase/Proper)

*Select 'equal' from the selection box

*yes (needs to be exactly the same text/upper/lowercase, as in the equation)

~~'''~~Booking tab:~~'''~~

Booking tab:

*Execution = One time only

*Flag Text = ~~The text you want to display~~

*Flag Text = Breakfast

*Flag Colour - choose the flag colour

Booking ~~changes are applied before the mail is sent so that the flag template variable can be reflected in the email.~~

Booking Info tab:

*Booking Info Code = BREAKFAST

*Booking Info Description = Breakfast included

</div>

Line 2,904:

Line 3,039:

====Apply a flag when ~~NO payment is~~ made - ~~''Select from the predefined template''~~====

====Apply a flag when deposit was made prior to Check-in====

</div>

Trigger tab:

~~'''~~Trigger ~~tab~~:~~'''~~

*Trigger Event = Check-in

*Trigger Time = -365 (for example : must be a negative value and the same as the value in Trigger window)

*Trigger Window = 365

*Booking Source = All

*Booking Status = All but not cancelled

*Invoice Balance = Any Payment made

*Trigger Event = Booking

Message tab:

*Trigger Time = Immediate

*Trigger Window = 1 day

~~Booking Source~~:

*Send Email : select appropriate option

*~~Booking Source = All~~

*Enter : Subject and Email content

~~Booking Conditions:~~

Booking tab: (optional)

*Booking Status = All not cancelled

*Invoice Balance = No payment made

~~'''~~Booking tab:~~'''~~

*Execution = One time only

*Flag Text = ~~Not Paid~~

*Flag Text = The text you want to display

*Flag Colour ~~= fee0dd~~

*Flag Colour - choose the flag colour

Booking info tab : (optional)

*Booking Info Code : DEPOSITPAID (for example)

*Booking Info Text : additional text if required.

Setting details with the Booking tab and Booking info tab allows you to trigger additional (follow on) Auto Actions and Reports.

</div>

====Apply a flag when booking is fully paid====

====Apply a flag when ~~a payment was made~~====

</div>

~~<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span> Also see Example : " Apply a flag when deposit was made prior to Check-in AND/OR Apply a flag when booking is fully paid".~~

Trigger tab:

*Trigger Event = Booking

Line 2,943:

Line 3,082:

*Booking Source = All

*Booking Status = All not cancelled

*Invoice Balance = ~~Any Payment made~~

*Invoice Balance = ZERO

Booking tab:

Line 2,955:

Line 3,094:

====Apply a flag ~~when~~ a ~~payment FAILS at Stripe~~ - ''Select from predefined template'' ====

====Apply a flag/colour for a booking coming from a certain channel - ''Select from the predefined template'' ====

</div>

'''Trigger tab:'''

*Trigger Event = Booking ~~(but not after check-in)~~

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = 999

*Booking Source = Booking.com (for example)

~~Booking Source:~~

*Booking Source = ~~All~~

*Booking Status = All but not cancelled

*Booking ~~Info Code = STRIPEFAIL, CARDFAILSTRIPE~~

'''Booking tab:'''

*Execution = One time only

*Flag Text = ~~Stripe Payment Failed~~

*Flag Text = The text you want to display

*Flag Colour - ~~fee0dd~~

*Flag Colour - choose the flag colour

Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the email.

</div>

Line 2,981:

Line 3,117:

====Apply a flag ~~to Booking.com bookings and auto report the Credit Card~~ when a payment ~~FAILS at Stripe~~====

====Apply a flag when NO payment is made - ''Select from the predefined template''====

</div>

~~Go to Settings > Channel Manager > Preferences and set Auto report failed cards = Yes~~

'''Trigger tab:'''

*Trigger Event = Booking ~~(but not after checkout)~~

*Trigger Event = Booking

*Trigger Time = Immediate

*Trigger Window = ~~999~~

*Trigger Window = 1 day

Booking Source:

*Booking Source = ~~Booking.com~~

*Booking Source = All

Booking Conditions:

*Booking Status = All not cancelled

*~~Booking Info Code~~ = ~~BOOKINGCOMCARD~~

*Invoice Balance = No payment made

'''Booking tab:'''

*Execution = One time only

*Flag Text = ~~Failed CC reported to Booking.com~~

*Flag Text = Not Paid

*Flag Colour ~~- choose the flag colour~~

*Flag Colour = fee0dd

</div>

~~===Status changes===~~

==== ~~Change the status of all "Request" bookings to "Cancelled" after three days~~ ====

====Apply a flag when a payment was made====

</div>

Trigger tab

<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span> Also see Example : " Apply a flag when deposit was made prior to Check-in AND/OR Apply a flag when booking is fully paid".

Trigger tab:

*Trigger Event = Booking

*Trigger Time = ~~3 days~~

*Trigger Time = Immediate

*Booking Status = ~~Request~~

*Trigger Window = 365

*Booking Source = All

*Booking Status = All not cancelled

*Invoice Balance = Any Payment made

Booking tab:

*Execution = One time only

*~~Booking Status~~ = ~~Cancelled~~

*Flag Text = The text you want to display

*Flag Colour - choose the flag colour

</div>

Line 3,028:

Line 3,168:

==== ~~Change the status of Airbnb "Inquiry" bookings to "Cancelled" after three days~~ ====

====Apply a flag when a payment FAILS at Stripe - ''Select from predefined template'' ====

</div>

Trigger tab

*Trigger Event = Booking

'''Trigger tab:'''

*Trigger Time = ~~3 days~~

*Booking Status = ~~Inquiry~~

*Trigger Event = Booking (but not after check-in)

*Booking ~~Source~~ = ~~Airbnb~~

*Trigger Time = Immediate

*Trigger Window = 999

Booking Source:

*Booking Source = All

*Booking Status = All but not cancelled

*Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE

'''Booking tab:'''

~~Booking tab:~~

*Execution = One time only

*~~Booking Status~~ = ~~Cancelled~~

*Flag Text = Stripe Payment Failed

*Flag Colour - fee0dd

</div>

Line 3,047:

Line 3,194:

==== ~~Change~~ the ~~status of all bookings which have been imported from Ical to "Request"~~ ====

====Apply a flag to Booking.com bookings and auto report the Credit Card when a payment FAILS at Stripe====

</div>

Trigger tab:

*Trigger Event = ~~After~~ Booking

Go to Settings > Channel Manager > Preferences and set Auto report failed cards = Yes

'''Trigger tab:'''

*Trigger Event = Booking (but not after checkout)

*Trigger Time = Immediate

*~~Booking Source~~ = ~~Ical Import (1, 2, 3)~~

*Trigger Window = 999

Booking ~~tab~~:

Booking Source:

*~~Execution~~ = ~~One time only~~

*Booking Source = Booking.com

*Booking Status = ~~Request~~

Booking Conditions:

*Booking Status = All not cancelled

*Booking Info Code = BOOKINGCOMCARD

'''Booking tab:'''

Booking ~~changes are applied before~~ the ~~mail is sent.~~

*Execution = One time only

*Flag Text = Failed CC reported to Booking.com

*Flag Colour - choose the flag colour

</div>

Line 3,066:

Line 3,224:

==== ~~Change Room Unit Status~~ when ~~guest checks out~~ ====

====Apply a flag when booking has been Checked-in====

</div>

Trigger tab

Trigger tab:

*Trigger Event = Check-~~out~~

*Trigger Event = Check-in

*Trigger Time = Immediate

*Trigger Window = 1 day

*Booking Source = All

*Booking Status = All but not cancelled

*Any Booking ~~Info Code = CHECKOUT~~

*Any booking info code = CHECKIN

Booking tab:

~~Booking tab:~~

*Execution = One time only

*~~Change Room Unit Status~~ = ~~Select~~ the ~~option~~

*Flag Text = Guest checked in (or any text you want to see)

*Flag Colour - choose the flag colour

It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.

</div>

===~~API/Webhook~~===

===Status changes===

====~~Use API/Webhook~~ to ~~write to the field 'Message'~~====

==== Change the status of all "Request" bookings to "Cancelled" after three days ====

</div>

Trigger tab

*Trigger Event = Booking

*Trigger Time = 3 days

*Booking Status = Request

~~You can use a webhook in conjunction with the API JSON function '''setBooking''' to write to any field in the booking. First you have to configure access to the API:~~

Booking tab:

*Execution = One time only

~~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>~~

*Booking Status = Cancelled

~~'''API key~~:~~'''~~

*{{#fas:cog}} (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS "API Key 1"

*API Key = my_very_secret_api_key

*API Key Access = allow any IP

*IP Whitelist = [leave empty]

*~~Allow Writes~~ = ~~Yes~~

*Property Access = Owned by this account only

*~~'''Property key:'''~~

*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX

~~Set the triggers you need, for example:~~

Booking ~~Field Contains: Message~~ = ~~XXX~~

~~Set the webhook like this:~~

* URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>

* Custom Header = [leave empty]

~~Body Data:~~

:{

~~::"authentication":~~

~~::{~~

~~:::"apiKey": "my_very_secret_api_key",~~

~~:::"propKey": "secret_key_for_prop_XXXXXX"~~

~~::},~~

~~::"bookId": "[BOOKID]",~~

~~::"message": "[MESSAGE] - Append this message"~~

:}

</div>

Line 3,129:

Line 3,265:

====~~Use API/Webhook to write~~ the ~~value~~ of ~~the 'commission' field~~ to ~~a new invoice item~~====

==== Change the status of Airbnb "Inquiry" bookings to "Cancelled" after three days ====

</div>

You can create a new invoice item that contains the price of the channel's commission as a negative value to subtract it from the room price. You use the API JSON function '''setBooking''' for this. First you need to configure access to the API:

Trigger tab

*Trigger Event = Booking

~~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>~~

*Trigger Time = 3 days

~~'''API key:'''~~

*Booking Status = Inquiry

*~~{{#fas:cog}} (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS "API Key 1"~~

*Booking Source = Airbnb

*~~API Key~~ = ~~my_very_secret_api_key~~

*~~API Key Access~~ = ~~allow any IP~~

Booking tab:

*~~IP Whitelist~~ = ~~[leave empty]~~

*Execution = One time only

*Allow Writes = Yes

*Booking Status = Cancelled

*~~Property Access~~ = ~~Owned by this account~~ only

*~~'''Property key:'''~~

*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS> propKey = ~~secret_key_for_prop_XXXXXX~~

~~Set the triggers you need, for example:~~

</div>

~~Booking Source~~ = ~~Booking.com~~

~~Set~~ the ~~webhook like this:~~

==== Change the booking status from Inquiry to Confirmed when the payment is made ====

</div>

Trigger tab

*Trigger Event = Booking

*Trigger Time = 365 days

*Booking Status = Inquiry

*Booking Source = ALL

*Invoice Balance = Any payment Made

*~~URL~~ = ~~<nowiki>https://api.beds24.com/json/setBooking</nowiki>~~

Booking tab:

*~~Custom Header~~ = ~~[leave empty]~~

*Execution = One time only

*Booking Status = Cancelled

*Body Data =

</div>

:{

</div>

~~::"authentication":~~

~~::{~~

~~:::"apiKey": "my_very_secret_api_key",~~

~~:::"propKey": "secret_key_for_prop_XXXXXX"~~

~~::},~~

~~::"bookId": "[BOOKID]",~~

~~::"invoice":~~

~~::[~~

~~:::{~~

~~::::"description": "Booking.com Commission",~~

~~::::"status": "",~~

~~::::"qty": "1",~~

~~::::"price": "-[COMMISSIONNUM]",~~

~~::::"vatRate": "7.00",~~

~~::::"type": "0",~~

~~::::"invoiceeId": ""~~

~~:::}~~

~~::]~~

:}

</div>

====~~Use Auto Action/Webhook~~ to ~~write to send data to Integromat~~====

==== Change the status of all bookings which have been imported from Ical to "Request" ====

</div>

Trigger tab:

*Trigger Event = Booking

*Trigger Time = Immediate

*Booking Source = Ical Import (1, 2, 3)

~~You can use this option to send data to your Integromat account.~~

Booking tab:

*Execution = One time only

*Booking Status = Request

~~Set~~ the ~~rules in the Trigger tab, when you need to send the data to Integromat~~.

Booking changes are applied before the mail is sent.

</div>

~~Go to Webhook tab:~~

~~URL~~ = ~~https:~~/~~/hook.integromat.com/ followed by your integromat account key.~~

==== Change Room Unit Status when guest checks out ====

</div>

Trigger tab

*Trigger Event = Check-out

*Trigger Time = Immediate

*Trigger Window = 1 day

*Booking Status = All but not cancelled

*Any Booking Info Code = CHECKOUT

~~Body Data~~ = ~~you can use the template variables allows in~~ the ~~list for Integromat [[https://wiki.beds24.com/index.php/Make#Data_Fields Data fields]]~~

Booking tab:

*Execution = One time only

*Change Room Unit Status = Select the option

~~For example :-~~

It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.

</div>

~~bookingData~~={

===API/Webhook===

====Use API/Webhook to write to the field 'Message'====

</div>

~~"bookId"~~:~~"[BOOKID]",~~

You can use a webhook in conjunction with the API JSON function '''setBooking''' to write to any field in the booking. First you have to configure access to the API:

"~~guestMobileNum":~~"[~~GUESTMOBILENUM~~]",

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:'''

*{{#fas:cog}} (SETTINGS) ACCOUNT > ACCOUNT >ACCESS "API Key 1"

*API Key = my_very_secret_api_key

*API Key Access = allow any IP

*IP Whitelist = [leave empty]

*Allow Writes = Yes

*Property Access = Owned by this account only

*'''Property key:'''

*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX

~~"guestMobile"~~:~~"[GUESTMOBILE]",~~

Set the triggers you need, for example:

~~"guestSMS"~~:~~"[GUESTSMS:44]",~~

Booking Field Contains: Message = XXX

"~~guestFirstName~~":"[~~REPLACE|&|and|~~[~~GUESTFIRSTNAME]~~]",

Set the webhook like this:

* URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>

* Custom Header = [leave empty]

Body Data:

:{

::"authentication":

::{

:::"apiKey": "my_very_secret_api_key",

:::"propKey": "secret_key_for_prop_XXXXXX"

::},

::"bookId": "[BOOKID]",

::"message": "[MESSAGE] - Append this message"

:}

</div>

"~~propertyName~~":"~~[PROPERTYNAME]~~",

"~~propertyId~~":~~"[PROPERTYID]",~~

====Use API/Webhook to write the value of the 'commission' field to a new invoice item====

</div>

You can create a new invoice item that contains the price of the channel's commission as a negative value to subtract it from the room price. You use the API JSON function '''setBooking''' for this. First you need to configure access to the API:

"~~firstNight":~~"[~~FIRSTNIGHTSHORT~~]",

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:'''

*{{#fas:cog}} (SETTINGS) ACCOUNT > ACCOUNT > ACCESS "API Key 1"

*API Key = my_very_secret_api_key

*API Key Access = allow any IP

*IP Whitelist = [leave empty]

*Allow Writes = Yes

*Property Access = Owned by this account only

*'''Property key:'''

*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX

"lastNight":"[LEAVINGDAYSHORT]"

Set the triggers you need, for example:

Booking Source = Booking.com

Set the webhook like this:

*URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>

*Custom Header = [leave empty]

*Body Data =

:{

::"authentication":

::{

:::"apiKey": "my_very_secret_api_key",

:::"propKey": "secret_key_for_prop_XXXXXX"

::},

::"bookId": "[BOOKID]",

::"invoice":

::[

:::{

::::"description": "Booking.com Commission",

::::"status": "",

::::"qty": "1",

::::"price": "-[COMMISSIONNUM]",

::::"vatRate": "7.00",

::::"type": "0",

::::"invoiceeId": ""

:::}

::]

:}

</div>

====Use Auto Action/Webhook to write to send data to Integromat====

</div>

You can use this option to send data to your Integromat account.

Set the rules in the Trigger tab, when you need to send the data to Integromat.

Go to Webhook tab:

URL = https://hook.integromat.com/ followed by your integromat account key.

Body Data = you can use the template variables allows in the list for Integromat [[https://wiki.beds24.com/index.php/Make#Data_Fields Data fields]]

For example :-

bookingData={

"bookId":"[BOOKID]",

"guestMobileNum":"[GUESTMOBILENUM]",

"guestMobile":"[GUESTMOBILE]",

"guestSMS":"[GUESTSMS:44]",

"guestFirstName":"[REPLACE|&|and|[GUESTFIRSTNAME]]",

"propertyName":"[PROPERTYNAME]",

"propertyId":"[PROPERTYID]",

"firstNight":"[FIRSTNIGHTSHORT]",

"lastNight":"[LEAVINGDAYSHORT]"

}

</div>

====Use webhook to switch a Shelly on====

</div>

Here is a simple PHP script with which you can switch a Shelly via an autoaction in beds24.

You can use this to switch on a string of lights on the day of arrival or to charge the night storage heating if a certain info code is set in the booking on the day before arrival.

Create an auto action and enter the PHP script ‘beds24-shelly-steuern.php’ under ‘Webhook’. The parameters for the control are transferred under ‘Data in body’:

id:b0b21c1xxxxx

shelly_server:shelly-123-eu.shelly.cloud

auth_key:ABCDEFGHIJKLMNPQRSTUVWXYZABCDEFGHIJKLMNPQRSTUVWXYZABCDEFGHIJKLMNPQRSTUVWXYZ

shelly_url:device/relay/control

parameter:channel=0&turn=on

email_result:[email protected]

remarks:Text, z.B. mit Template Variablen [GUESTFULLNAME] und [BOOKID]

</div>

====V2 version of the code for Shelly ====

</div>

Here is the second version v2 of the PHP script to switch on a Shelly device via an autoaction.

Now you can also store the device IDs in the script instead of adding them to the body parameters. This makes it possible to switch a Shelly device with a single autoaction. The device ID is then determined via the template variable [INTERNALROOMNAME].

Code: Select all

<?php

/*

* - Anschalten der Lichterkette aus beds24 mit einem PHP Skript über die Shelly Cloud -

* Version 2 vom 10.12.2024 - mehrere Devices im Array im Skript möglich

*

* https://domainname.de/scripte/beds24-shelly-steuern-v2.php

*

* curl -X POST https://shelly-123-eu.shelly.cloud/device/relay/control -d "channel=0&turn=on&id=b0b21c123456&auth_key=abcdefghijklmnopqrstuvwxyz1234567890"

* Einstellungen in beds24

* - in einer Autoaction unter 'Webhook' das Script eintragen: https://domainname.de/pfad_zum_script/beds24-shelly-steuern-v2.php

* - alternativ wenn Geräte-Id überINTERNALROOMNAME im Skript selbst: https://domainname.de/pfad_zum_script/beds24-shelly-steuern-v2?roomname=[INTERNALROOMNAME]

* - unter 'Daten im Body' die Parameter zur Steuerung eintragen:

* - id:<Shelly Geräte-Id> ===> alternativ mehrere Geräte-Id im Skript selbst

* - shelly_server:<Shelly Cloud Server>

* - auth_key:<Shelly Cloud-Autorisierungs-Schlüssel>

* - parameter:<Shelly Befehle>

* - email_result:<*optional* e-mail für Empfänger des Schaltergebnisses>

* - remarks:<*optional* beliebige Anmerkungen für E-Mail>

*

* Beispiel:

* id:b0b21c123456

* shelly_server:shelly-123-eu.shelly.cloud

* auth_key:abcdefghijklmnopqrstuvwxyz1234567890

* shelly_url:device/relay/control

* parameter:channel=0&turn=on

* email_result:[email protected]

* remarks:Text, auch mit Template Variablen [GUESTFULLNAME] und [BOOKID]/[INTERNALROOMNAME] möglich

*/

/* ----------------------------------------------------------- */

/* Parameter & Einstellungen */

/* ----------------------------------------------------------- */

/* Shelly Geräte-ID entweder beim Aufruf in beds24 über die 'Daten im Body' übergeben oder hier im Skript eintragen. Wenn im Script, dann beim Aufruf die Templatevariable [INTERNALROOMNAME] mitgeben, über die erfolgt dann die Auswahl hier im Array */

$p_geraete_ids = array (

"chalet" => "e465b8123456",

"fewo" => "b0b21c123456",

"linx" => "e465b8123456"

);

$p_test = false; /* im Testmodus kommen die Parameter direkt aus dem Script statt über beds24 */

/* Body Daten zum direkten Testen d.h. Direktaufruf des Scripts ohne Autoaction */

$test_body = array( /* zum direkten Aufruf des Scripts die Parameter hier testweise eintragen */

/* https://shelly-api-docs.shelly.cloud/cloud-control-api/communication */

"id" => "xxx", /* rausnehmen, wenn ids über Array kommen sollen */

"shelly_server" => "shelly-123-eu.shelly.cloud",

"auth_key" => "abcdefghijklmnopqrstuvwxyz1234567890",

"shelly_url" => "device/relay/control",

"parameter" => "channel=0&turn=on",

"email_result" => "[email protected]",

"remarks" => "Text, z.B. mit Template Variablen [GUESTFULLNAME] und [BOOKID]"

);

/* ----------------------------------------------------------- */

/* ab hier normalerweise keine Änderungen mehr vornehmen

/* ----------------------------------------------------------- */

$hf_internalroomname = filter_var($_GET["roomname"], FILTER_SANITIZE_STRING); /* wenn über ?roomname=[INTERNALROOMNAME] übergeben

/* Body aus Post message lesen und in Variablen $body[keyname] einlesen */

if ($p_test == false ) {

$hf_body = explode( "\n", file_get_contents('php://input') );

$body = array();

foreach ($hf_body as $v) {

list($body_key,$body_value) = explode( ':', $v );

$body[$body_key] = $body_value;

}

else {

$body = $test_body; /* im Testmodus Parameter direkt aus dem Script nehmen */

}

ob_start(); /* Bildschirmausgabe buffern */

/* wenn übergeben, dann Geräte-ID aus den body-parametern übernehmen, ansonsten über [INTERNALROOMNAME] ermitteln */

if ( $body["id"]) { /* in Body Parameter gesetzt */

$hf_geraete_id = $body["id"];

} else {

$hf_geraete_id = $p_geraete_ids[$hf_internalroomname]; /* Geräte-Id aus Skript Array nehmen */

}

/* Prüfen ob wichtige Argumente übergeben */

if ( isset($body["shelly_server"]) == false ) { echo("Argument shelly_server fehlt, z.B.: shelly_server:servername<br>"); $body["shelly_server"] = "fehlt";}

if ( isset($body["shelly_url"]) == false ) { echo("Argument shelly_url fehlt, z.B. : shelly_url:device/relay/control<br>"); $body["shelly_url"] = "fehlt";}

if ( isset($body["parameter"]) == false ) { echo("Argument parameter fehlt, z.B.: parameter:channel=0&turn=on><br>"); $body["parameter"] = "fehlt";}

if ( isset($body["auth_key"]) == false ) { echo("Argument auth_key fehlt, z.B.: auth_key:abcdefghijklmnopqrstuvwxyz1234567890<br>"); $body["auth_key"] = "fehlt";}

$url = 'https://'.$body["shelly_server"].'/'.trim($body["shelly_url"], " /");

$ch=curl_init();

curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);

curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); /* Zertifikatswarnung übergehen */

curl_setopt($ch, CURLOPT_SSL_VERIFYSTATUS, false);

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

curl_setopt($ch, CURLOPT_PROXY_SSL_VERIFYPEER, false);

curl_setopt($ch, CURLOPT_POST, true);

curl_setopt($ch, CURLOPT_POSTFIELDS,

$body["parameter"]."&id=".$hf_geraete_id."&auth_key=".$body["auth_key"]);

curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));

curl_setopt($ch, CURLOPT_URL, $url);

$result = curl_exec($ch);

curl_close ($ch);

if ( $body["remarks"] ) { /* Anmerkungen fürs Protokoll/E-Mail ausgeben */

echo ("<br>".$body["remarks"]."<br>");

};

$output = ob_get_contents(); /* Bildschirmausgabe aus Buffer lesen */

ob_end_clean();

echo $output;

if ( $body["email_result"] ) {

mail($body["email_result"], 'Ergebnis Shelly Skript - Device: '.$hf_geraete_id, $output, 'From: beds24 Shelly Script <'.$body["email_result"].'>');

echo ("<br>Mail an: ".$body["email_result"]);

}

?>

</div>

@@ Line 14: / Line 14: @@
 ==Summary==
 <div class="summarybox">
-An Auto Action is an action which can be used '''manually or programmed to run automatically''' at a specific time relative to the time of the '''booking''', to the '''check-in''' date or to the '''check-out''' date.
+An Auto Action is an action which can be used '''manually or programmed to run automatically''' at a time relative to the time of the '''booking''', to the '''check-in''' date or to the '''check-out''' date.
 Auto actions have one or more trigger conditions and one or more actions. They can be triggered on a number of different conditions, like property, time or booking related conditions. Auto Actions can
@@ Line 30: / Line 30: @@
 Using 'Group Keywords' you can refine the triggers in the Auto Action to include/exclude properties if the purpose/message in the Auto action needs to be different.
-<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span>  Auto Actions are  not designed as real-time actions. They are sent in batches at times so we recommend you set your triggers to allow for this.
+<span style="color:#019cde; font-size: 150%;“ >{{#fas:info-circle}}  </span>  Auto Actions are  not designed as real-time actions. They are processed in batches so we recommend you set your triggers to allow for this.
 == Setup ==
@@ Line 55: / Line 55: @@
 '''Auto sending:'''
-The auto action batch process runs multiple times per hour.
 Auto Action Emails which are sent automatically by the system are sent from the EMail address of the account that created the Auto Action. This is the account set up in in {{#fas:cog}} (SETTINGS) ACCOUNT-> OUTGOING EMAIL.
@@ Line 181: / Line 179: @@
 === Booking Info ===
 Set up auto actions which automatically add or remove info codes. This is good practice for reporting and also to trigger/exclude bookings from other auto actions.
+Booking info codes can be used to 'sequence' your auto actions.
+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 = STRIPEPAYMENT or CARDTOSTRIPE, both confirm the guest credit card is in the booking.
 === Invoice ===
@@ Line 197: / Line 201: @@
 === Webhook ===
 Create auto actions which trigger a web hook when the trigger conditions are met.
+== Same day/Near term bookings ==
+With Same day/Near term bookings, consider the actions/messages you want to trigger with your auto actions.
+If you have messages/emails that need to send to your guest at various points before they arrive at your property, then for Same day/Near term bookings, you should consider consolidating the information and sending one message/email.
+In the Trigger tab of the auto action, 'Between booking and check-in' can be used to manage which bookings the action can be triggered on.
+===Example 1 - Same day booking ===
+Trigger tab:
+*Trigger Event = Booking
+*Trigger Time = Immediate
+*Between Booking and Check in = 0 and 0 (same day).
+For your other auto actions, set the Between Booking and Check in = 1 and 999, then they will not trigger on same day bookings.
+===Example 2 - Near term booking ===
+If your business process is to send a confirmation message at the time of booking, then the check-in instructions 2 days before arrival, then for same day bookings, you can use 1 auto action.
+Trigger tab:
+*Trigger Event = Booking
+*Trigger Time = Immediate
+*Between Booking and Check in = 0 and 2 (Near term).
+Message tab: consolidate the message from your standard Confirmation message and check-in instructions.
+For your other auto actions, set the Between Booking and Check in = 3 and 999, then they will not trigger on Near term bookings.
 == Multiple Properties ==
@@ Line 285: / 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.
-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,
@@ Line 328: / Line 359: @@
   If you have sub accounts and need an auto action to be used across multiple accounts/properties, then create the auto action at the Master Account Level and set Property = 'All visible in account' and ensure the Master account has access to the properties.
-== Examples ==
+== Use Cases ==
-=== Send Emails/Message/SMS to guests ===
+=== Guest Management ===
+{| class="wikitable"
+! scope="col"| Guest Management
+! scope="col"| Link to Auto Action example
+|-
-<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.
+|You want to send a confirmation message to bookings received from OTAs/Channels
+|[[Auto_Actions#Email_confirmation_for_channel_bookings_-_Select_from_the_predefined_template|Send Confirmation message to Channel bookings]]
+|-
-<div class="mw-collapsible mw-collapsed">
+|You want to send a booking registration form (PDF) to your guests so they can complete all guest details
-<div  class="headline-collapse" >
+|[[Auto_Actions#Send_Email_with_Booking_Registration_Form_-_PDF_attachment|Send an email with Booking registration document (PDF)]]
-====Send an Email to the guest when the status of a booking changes to  "Cancelled"====
+|-
-</div>
-<div class="mw-collapsible-content">
-'''Trigger tab:'''
+|Send a confirmation message to the guest when a payment has been received
+|[[Auto_Actions#Send_an_Email_to_the_guest_when_a_payment_is_made|Send email/message to confirm receipt of a payment]]
+|-
-Time:
+|You want to send an Invoice (PDF) to the guest after checkout
-*Trigger Event = Check-in
+|[[Auto_Actions#Send_invoice_after_check-out_-_PDF_attachment_-_Select_from_the_predefined_template|Send an invoice to the guest after checkout]]
-*Trigger Time = -365
+|-
-*Trigger Window = 365
-Booking Source
+|You want to send an email to the guest confirming their booking has been cancelled
-*Booking Source = All (for example)
+|[[Auto_Actions#Send_an_Email_to_the_guest_when_the_status_of_a_booking_changes_to_.22Cancelled.22|Send Cancellation notice to the guest]]
+|-
-Booking Conditions
+! scope="col"| Payments
-*Booking Status = Cancelled
+! scope="col"| Link to Auto Action example
+|-
-'''Message tab''': For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
+|You want to send a payment Request to your guests for all bookings
+|[[Auto_Actions#Send_a_Request_for_payment_to_your_guests_for_all_bookings|Send a payment request for all bookings]]
+|-
-*Send Message = Booking API/Smart Email
+|You want to send a Request for payment to your guests after the booking has been created
+|[[Auto_Actions#Send_a_Request_for_payment_to_your_guests_XX_days_after_booking|Send a payment request after the booking]]
+|-
+|You want to send a Request for payment to your guests XX days BEFORE CHECK-IN
+|[[Auto_Actions#Send_a_Request_for_payment_to_your_guests_XX_days_before_check-in|Send a payment request for payment before checkin]]
+|-
+|STRIPE - Send a Request to 'Authorise' a Security deposit from your guests before check-in
+|[[Auto_Actions#Send_a_Request_to_.27Capture.27_a_Security_deposit_from_your_guests_XX_days_before_check-in_-_with_Stripe|Authorise a Security deposit on the Guest credit card]]
+|-
+|STRIPE - The guest payment has failed, send an email to the guest with the details.
+|[[Auto_Actions#Send_an_email_to_the_guest_email_address_when_a_payment_FAILS_at_Stripe|Send an email when the guest payment has failed]]
+|-
+|STRIPE - The guest's credit card as it will expire before checkin, send a request so they can update their details.
+|[[Auto_Actions#Send_a_Request_to_update_the_guest.27s_credit_card_as_it_will_expire_before_checkin|Send a request to update their credit card details]]
+|-
+! scope="col"| Check-in Details
+! scope="col"| Link to Auto Action example
+|-
+|You want to send an Email with access instructions and a key code 1 day before check-in (Self Checkin)
+|[[Auto_Actions#Send_an_Email_with_a_key_code_for_a_specific_unit_one_day_before_check-in_.28Self_Checkin.29|Send access details to your guest prior to arrival]]
+|-
+|You want to send Email to guests with check-in details before Check-in - Fully paid
+|[[Auto_Actions#Send_Email_to_guests_with_check-in_details_2_days_before_Check-in.2C_booking_paid.2Fno_outstanding_balance|Send access details as booking is fully paid]]
+|-
+|You want to send Email to guests with check-in details before Check-in - Security Deposit Authorised at Stripe
+|[[Auto_Actions#Send_Email_to_guests_with_check-in_details_2_days_before_Check-in.2C_Security_Deposit_Authorised_at_Stripe|Send access details as Security deposit authorised at Stripe]]
+|-
+|}
+== Examples ==
+=== 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, Airbnb, Expedia and VRBO.
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
+====Send an Email to the guest when the status of a booking changes to  "Cancelled"====
+</div>
+<div class="mw-collapsible-content">
+'''Trigger tab:'''
+Time:
+*Trigger Event = Check-in
+*Trigger Time = -365
+*Trigger Window = 365
+Booking Source
+*Booking Source = All (for example)
+Booking Conditions
+*Booking Status = Cancelled
+'''Message tab''': For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
+*Send Message = Booking API/Smart Email
 If the "Mail & Actions" tab contains a "real" Email address the message is sent to the guests Email address. If only a masked Email address is available the message sends via the channels API messaging systems if possible.
@@ Line 429: / Line 534: @@
 Time:
-*Trigger Event = Check-in
+*Trigger Event = Booking (but not after check-in)
-*Trigger Time = -365 days
+*Trigger Time = Immediate
-*Trigger Window = 355 days
+*Trigger Window = 1 day
+*Between Booking and Check in = 10 to 999
 Booking Conditions:
@@ Line 1,136: / Line 1,242: @@
 Trigger tab:
-*Trigger Event = After Booking
+*Trigger Event = Booking
 *Trigger Time = Immediate
 *Trigger Window = 365
@@ Line 1,245: / Line 1,351: @@
 <div  class="headline-collapse" >
-====Send Remotelock/Lockstate,  Nuki PIN or Chekin Link 2 days before Check-in (Self Checkin) - ''Select from the predefined template'' ====
+====Send Remotelock/Lockstate,  Nuki PIN, TTLOCK or Chekin Link 2 days before Check-in (Self Checkin) - ''Select from the predefined template'' ====
 </div>
 <div class="mw-collapsible-content">
@@ Line 1,263: / Line 1,369: @@
 Info Codes :-
-*Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL (select the appropriate Booking Info Code for the service you use)
+*Info Code = LOCKSTATE_PIN or NUKI_PIN or CHEKIN_URL or LOCK_PIN (select the appropriate Booking Info Code for the service you use)
 '''Messaging tab:''' For channels using the Message API, then enter the text in the Plain text box, for emails enter the text in the HTML box.
@@ Line 1,277: / Line 1,383: @@
 *Plain text box - will send to channels using Message API
-Message Text :- enter the text you wish to send to your guests include URL. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]
+Message Text :- enter the text you wish to send to your guests include URL. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] ] or [BOOKINGINFOCODETEXT:LOCK_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]
 *HTML box - Email will be sent
-Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]
+Email Text :- It is possible to use the same details (URL) as in the Plain Text box above. Include these template variables - [BOOKINGINFOCODETEXT:LOCKSTATE_PIN] or [BOOKINGINFOCODETEXT:NUKI_PIN] or [BOOKINGINFOCODETEXT:CHEKIN_PIN] or [BOOKINGINFOCODETEXT:LOCK_PIN] see the list of ALL template variables that can be used [[Template_Variables| see here]]
 </div>
@@ Line 2,007: / Line 2,113: @@
 Trigger tab:
-*Trigger Event = After Booking
+*Trigger Event = Booking
 *Trigger Time = Immediate
 *Trigger Window = 365
@@ Line 2,040: / Line 2,146: @@
 Trigger tab:
-*Trigger Event = After Booking
+*Trigger Event = Booking
 *Trigger Time = Immediate
 *Trigger Window = 365
@@ Line 2,073: / Line 2,179: @@
 Trigger tab:
-*Trigger Event = After Booking
+*Trigger Event = Booking
 *Trigger Time = Immediate
 *Trigger Window = 1 day
@@ Line 2,175: / Line 2,281: @@
 Trigger tab:
-*Trigger Event = After Booking
+*Trigger Event = Booking
 *Trigger Time =  immediately
 *Trigger Window = 365
@@ Line 2,189: / Line 2,295: @@
 <div class="mw-collapsible mw-collapsed">
 <div  class="headline-collapse" >
 ====Identify bookings with Custom Question ticked/unticked ====
 </div>
@@ Line 2,199: / Line 2,306: @@
 Trigger tab:
-*Trigger Event = After Booking
+*Trigger Event = Booking
-*Trigger Time =  immediately
+*Trigger Time =  Immediate
 *Trigger Window = 365
 *Booking Source = All
@@ Line 2,220: / Line 2,327: @@
 <div class="mw-collapsible-content">
 Trigger tab:
-*Trigger Event = After Booking
+*Trigger Event = Booking
 *Trigger Time = Immediate
 *Booking Source = Expedia (for example)
@@ Line 2,303: / Line 2,410: @@
 </div>
-===Modify description/values of an existing invoice item in a booking ===
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-<div class="mw-collapsible mw-collapsed">
+====Add a new charge - City tax, calculated from number of nights/adults in a booking ====
-<div  class="headline-collapse" >
-====Update the Description field of a charge/invoice item====
 </div>
 <div class="mw-collapsible-content">
-In some cases Channel bookings have different descriptions for the same charge item - i.e. Cleaning, update the description field in the invoice item so they all match, using the format (findthisinvoicedescription^replacewiththisdescription)
+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
-Trigger tab:
+Then set the value = 7* number of adults *2 *1.03
-*Trigger Event = After Booking
+ELSE set the value = 'number of nights' * 'number of adults' *2 *1.03
-*Trigger Time = Immediate
-*Booking Source = Expedia (for example)
-Invoice tab:
+ 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
-*Add Invoice Item = Update Only
-*Type = Change Description
-*Description = Cleaning^Cleaning Service Fee
-*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)
+Trigger tab:
-</div>
+Time :
-</div>
+*Trigger Event = Booking
+*Trigger Time = Immediate
+*Trigger Window = 1 day
-<div class="mw-collapsible mw-collapsed">
+Booking Conditions:
-<div  class="headline-collapse" >
+*Status = All not Cancelled
-====Update all values of a charge/invoice item====
+Booking Source:
+*Booking Source = Direct
-</div>
-<div class="mw-collapsible-content">
-You need to change the charges in bookings due to an update in your prices. Tourist Tax (for example), update the description field and value  using the format (findthisinvoicedescription^replacewiththisdescription)
-Trigger tab:
-*Trigger Event = After Booking
-*Trigger Time = Immediate
-*Time Window = 365
-*Check In From = Select the first date of the Summer Season
-*Check In To = Select the last date of the Summer Season
-*Booking Source = Expedia (for example)
 Invoice tab:
-*Add Invoice Item = Update Only
+*Type = Amount
-*Type = Change All
+*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]
-*Description = Tourist Tax^Tourist Tax - Summer season 2022 (for example)
+*Amount = 0 (leave as 0 so the value is set from the calculation in the Description field)
-*Amount = 0.75
+*Per = Room
-*Per = Per Person
+*Period = one time
-*Period = One time
+*VAT = 19% (for example - enter the VAT amount if applicable)
-*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)
+The fee/charge will be added the next time the auto actions run.
 </div>
 </div>
-===Payments/Pending Payments===
+===Modify description/values of an existing invoice item in a booking ===
 <div class="mw-collapsible mw-collapsed">
 <div  class="headline-collapse" >
-====Add a pending payment====
+====Update the Description field of a charge/invoice item====
 </div>
 <div class="mw-collapsible-content">
-Trigger tab:
-*Trigger Event = After Booking or Before Check-in
-*Trigger Time = set the time you want to collect the payment
-*Booking Source =All (for example, you can also set different rules for different channels)
-*Group Booking Trigger = Trigger only Master (this will trigger on individual bookings and Master booking if a group)
-Booking Info tab: Optional
+In some cases Channel bookings have different descriptions for the same charge item - i.e. Cleaning, update the description field in the invoice item so they all match, using the format (findthisinvoicedescription^replacewiththisdescription)
-Add a booking info tab for information and reporting
-*Flag Text = PendingPayment (for example)
-*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
-Booking tab: Optional
+Trigger tab:
-*Booking Info Code = PENDPAY
+*Trigger Event = Booking
-*Booking Info Text = Pending payment added
+*Trigger Time = Immediate
+*Booking Source = Expedia (for example)
 Invoice tab:
-*Payment Type = select on what the payment is calculated (Percent of Balance due OR Group balance if you receive Group bookings)
+*Add Invoice Item = Update Only
-*Description = the text you will see in the "Charges and Payments" tab
+*Type = Change Description
-*Status = if you use the status function add the status you want to apply to the pending payment (optional)
+*Description = Cleaning^Cleaning Service Fee
-*Amount = enter the amount or percentage you want to collect
+*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)
-*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 Due = Set when the payment is due
-Create a Payment Rule to collect a payments when bookings are not cancelled.
+</div>
+</div>
-Go to Settings > Payments > Payment Rules
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-Payment Rule :
+====Update all values of a charge/invoice item====
-Name = Enter your title - Not Cancelled (for example)
+</div>
-Action = Auto
+<div class="mw-collapsible-content">
-Payment Trigger :
+You need to change the charges in bookings due to an update in your prices. Tourist Tax (for example), update the description field and value  using the format (findthisinvoicedescription^replacewiththisdescription)
+Trigger tab:
+*Trigger Event = Booking
+*Trigger Time = Immediate
+*Time Window = 365
+*Check In From = Select the first date of the Summer Season
+*Check In To = Select the last date of the Summer Season
-*Booking Status = All not cancelled
+*Booking Source = Expedia (for example)
-*Any Booking Info Code = optional
-*All Booking Info Codes = optional
-*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
-Payment Action :
+Invoice tab:
+*Add Invoice Item = Update Only
+*Type = Change All
+*Description = Tourist Tax^Tourist Tax - Summer season 2022 (for example)
+*Amount = 0.75
+*Per = Per Person
+*Period = One time
+*Invoicee = Ignore (otherwise you can add a specific Invoicee to limit the search)
-*Capture = Yes - immediately charged (Capture=Yes)
-*Add info code on success = add a Booking Info item to the booking on success
-*Add info code on failure = add a Booking Info item to the booking on failure
 </div>
@@ Line 2,420: / Line 2,514: @@
 <div  class="headline-collapse" >
-====Add a pending payment - Set the Security Deposit value based on the price of the booking, using a calculation ====
+==== Update VAT value for Charge item - City Tax (for example) ====
 </div>
 <div class="mw-collapsible-content">
-Trigger tab:
-*Trigger Event = After Booking or Before Check-in
-*Trigger Time = set the time you want to collect the payment
-*Booking Source =All (for example, you can also set different rules for different channels)
-Booking tab: Optional
+You need to change the VAT value for specific items (City tax) in the Charges & Payments tab of the booking.
-*Flag Text = PendingPayment (for example)
-*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
-Booking Info tab: Optional
+Trigger tab:
-Add a booking info tab for information and reporting
+*Trigger Event = Booking
-*Booking Info Code = PENDPAY
+*Trigger Time = Immediate
-*Booking Info Text = Pending payment added
+*Time Window = 365
+*Booking Source = Expedia (for example)
 Invoice tab:
-*Payment Type = fixed value
+*Add Invoice Item = Update Only
-*Description = Security Deposit||[IF<=:[INVOICEFIRSTITEMNUM]:800:200|[INVOICEFIRSTITEMNUM][/.0]4]
+*Type = Change VAT
-(Security Deposit is the description, then 2 | symbol, then the calculation for the 'Amount' to be set.)
+*Description = City Tax (this needs to be an exact match to the charge item description)
+*Amount = 0
-This calculation, tests if the first invoice item value (usually the Accommodation value) is greater than or = 800 if so set the Security Deposit Amount = 1 quarter of the first invoice item value, otherwise set = 200.
+*VAT = 12 (for example)
+*Per = Per Person
+*Period = One time
+*Invoicee = Ignore
+</div>
+</div>
-<span class="" style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span>  <span style="font-weight: bold;" >Tip</span> A price value for the invoice item can be specified after a second pipe (|) symbol, this can be used to calculate a price using template variables. If the price value in the description field is zero or absent, the numeric value from the amount field will be used.
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-*Status = if you use the status function add the status you want to apply to the pending payment (optional)
+==== Update VAT value for the Accommodation fee (first item in the Charges & Payments tab) ====
-*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 Due = Set when the payment is due
+</div>
+<div class="mw-collapsible-content">
-Create a Payment Rule to collect a payments when bookings are not cancelled.
+You need to change the VAT value for the Accommodation fee usually the first line the Charges & Payments tab of the booking.
-Go to Settings > Payments > Payment Rules
+Trigger tab:
+*Trigger Event = Booking
+*Trigger Time = Immediate
+*Time Window = 365
+*Booking Source = ALL (or select a specific channel)
-Payment Rule :
+Invoice tab:
+*Add Invoice Item = Update Only
+*Type = Change VAT
+*Description = [ROOMNAME1] [FIRSTNIGHT] - [LEAVINGDAY][NOCONVERT]
-Name = Enter your title - Not Cancelled (for example)
+Check the Description in the Charges & Payments tab for the Accommodation charge usually [ROOMNAME1] [FIRSTNIGHT] - [LEAVINGDAY]
-Action = Auto
-Payment Trigger :
+To update this value you also need [NOCONVERT] so the template variable is used rather than the value.
-*Booking Status = All not cancelled
+*Amount = 0
-*Any Booking Info Code = optional
+*VAT = 12 (for example)
-*All Booking Info Codes = optional
+*Per = Per Person
-*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
+*Period = One time
+*Invoicee = Ignore
-Payment Action :
-*Capture = Yes - immediately charged (Capture=Yes)
-*Add info code on success = add a Booking Info item to the booking on success
-*Add info code on failure = add a Booking Info item to the booking on failure
 </div>
 </div>
+===Payments/Pending Payments===
 <div class="mw-collapsible mw-collapsed">
 <div  class="headline-collapse" >
+====Add a pending payment====
-====Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)====
 </div>
 <div class="mw-collapsible-content">
+Trigger tab:
+*Trigger Event = Booking or Booking (but not after Check-in)
+*Trigger Time = set the time you want to collect the payment
+*Booking Source =All (for example, you can also set different rules for different channels)
+*Group Booking Trigger = Trigger only Master (this will trigger on individual bookings and Master booking if a group)
-''''Create a Payment Rule  (Optional)''''
+Booking Info tab: Optional
+Add a booking info tab for information and reporting
+*Flag Text = PendingPayment (for example)
+*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
-Standard payment rules in the system are Auto & Manual, you can create additional rules for the collection of outstanding payments, you can control the collection of payments if the booking status is changed, for example the booking is cancelled before the final payment is due to be collected.
+Booking tab: Optional
+*Booking Info Code = PENDPAY
+*Booking Info Text = Pending payment added
-Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
+Invoice tab:
+*Payment Type = select on what the payment is calculated (Percent of Balance due OR Group balance if you receive Group bookings)
+*Description = the text you will see in the "Charges and Payments" tab
+*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
+*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
-Create a Payment Rule to collect payments if bookings are not cancelled.
-Click '''Create New Payment Rule''' :
+Create a Payment Rule to collect a payments when bookings are not cancelled.
+Go to Settings > Payments > Payment Rules
+Payment Rule :
-Payment Rule:
+Name = Enter your title - Not Cancelled (for example)
-*Name = Enter your title - Not Cancelled (for example)
+Action = Auto
-*Action = Auto
 Payment Trigger :
 *Booking Status = All not cancelled
-*Any Booking Info Code (optional)
+*Any Booking Info Code = optional
-*All Booking Info Codes (optional)
+*All Booking Info Codes = optional
 *Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 Payment Action :
-*Funding Source = Guest card only
-*Payment value adjustment = Limit to group booking balance
 *Capture = Yes - immediately charged (Capture=Yes)
 *Add info code on success = add a Booking Info item to the booking on success
 *Add info code on failure = add a Booking Info item to the booking on failure
-Prevent Auto Payment :
+</div>
-*Prevent payment if booking status = Cancelled
+</div>
-*Prevent payment after check-out (days) = 7 (default)
-*Prevent payment action = Set Manual
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-'''Create Auto Actions '''
+====Add a pending payment - Set the Security Deposit value based on the price of the booking, using a calculation ====
+</div>
+<div class="mw-collapsible-content">
+Trigger tab:
+*Trigger Event = Booking or Booking (but not after Check-in)
+*Trigger Time = set the time you want to collect the payment
+*Booking Source =All (for example, you can also set different rules for different channels)
-Collect the outstanding balance for bookings created via your booking page.
+Booking tab: Optional
+*Flag Text = PendingPayment (for example)
+*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
-Go to {{#fas:cog}} (SETTINGS)  GUEST MANAGEMENT > AUTO ACTIONS and click '''Create New Action''' to create them.
+Booking Info tab: Optional
+Add a booking info tab for information and reporting
+*Booking Info Code = PENDPAY
+*Booking Info Text = Pending payment added
-'''Collect outstanding balance for direct bookings'''
+Invoice tab:
+*Payment Type = fixed value
+*Description = Security Deposit||[IF<=:[INVOICEFIRSTITEMNUM]:800:200|[INVOICEFIRSTITEMNUM][/.0]4]
+(Security Deposit is the description, then 2 | symbol, then the calculation for the 'Amount' to be set.)
+This calculation, tests if the first invoice item value (usually the Accommodation value) is greater than or = 800 if so set the Security Deposit Amount = 1 quarter of the first invoice item value, otherwise set = 200.
-Trigger tab:
+<span class="" style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span>  <span style="font-weight: bold;" >Tip</span> A price value for the invoice item can be specified after a second pipe (|) symbol, this can be used to calculate a price using template variables. If the price value in the description field is zero or absent, the numeric value from the amount field will be used.
-*Time
-**Trigger Event = Checkin
-**Trigger Time = -3 days (set the time you want to collect the payment)
-**Time Window = 3 days (set this to the same number (positive) as Trigger time.
-*Booking Source
+*Status = if you use the status function add the status you want to apply to the pending payment (optional)
-**Booking Source = Direct. You can have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.
+*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 Due = Set when the payment is due
-*Booking Conditions
-**Group Booking Trigger = Trigger only Master
-**Status = All not cancelled
-**Invoice Balance= Not Zero (can be used to refine the auto action being triggered)
-Booking tab: Optional
+Create a Payment Rule to collect a payments when bookings are not cancelled.
-*Flag Text = Pending payment added (for example)
-*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
-Booking Info tab: Optional, for information and reporting
+Go to Settings > Payments > Payment Rules
-*Booking Info Code = BALANCE (for example enter the value - use one word only)
-*Booking Info Text = Enter the description/text to show in for the Booking Info Code.
-Invoice tab:
+Payment Rule :
-<div class="warning">{{#fas:exclamation-triangle}} ONLY use Payment Type =‘ Percent of Group balance due’ if you selected Trigger tab > Booking Conditions > Group Booking Trigger = Trigger Only  Master.</div>
+Name = Enter your title - Not Cancelled (for example)
+Action = Auto
+Payment Trigger :
+*Booking Status = All not cancelled
+*Any Booking Info Code = optional
+*All Booking Info Codes = optional
+*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
+Payment Action :
-*Add a Pending Payment to the booking
+*Capture = Yes - immediately charged (Capture=Yes)
-**Payment Type = Percent of Group Balance due (select on what the payment is calculated)
+*Add info code on success = add a Booking Info item to the booking on success
-**Description = the text you will see in the "Charges and Payments" tab
+*Add info code on failure = add a Booking Info item to the booking on failure
-**Status = if you use the status function add the status you want to apply to the pending payment (optional)
-**Amount = 100 (this will be 100% of the outstanding group balance)
-**Payment Rule = Not Cancelled - See Step 4 above (if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS ->PAYMENT RULES they will be available here)
-**Payment Due = Trigger date
-**Payment time = set the time to collect payment
-**Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
 </div>
@@ Line 2,567: / Line 2,693: @@
 <div  class="headline-collapse" >
-===='Capture' a Security Deposit when Credit card is collected at time of booking. ====
+====Collect outstanding booking balance 3 days prior to arrival( Credit card details were collected at time of booking)====
 </div>
 <div class="mw-collapsible-content">
-Trigger tab:
+''''Create a Payment Rule  (Optional)''''
-*Trigger Event = After Booking
-*Trigger Time = immediate
+Standard payment rules in the system are Auto & Manual, you can create additional rules for the collection of outstanding payments, you can control the collection of payments if the booking status is changed, for example the booking is cancelled before the final payment is due to be collected.
-*Booking Source =All (for example, you can also set different rules for different channels)
-Info Codes:
+Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
-Any Booking Info Code = CARDTOSTRIPE
-Invoice tab:
+Create a Payment Rule to collect payments if bookings are not cancelled.
-*Payment Type = Fixed amount
-*Description =  Security Deposit (the text you will see in the "Charges and Payments" tab)
-*Status = if you use the status function add the status you want to apply to the pending payment (optional)
-*Amount = 100 (balance is full price so 100% of the balance)
-*Payment Rule = Security Deposit (Create a Payment Rule, see below)
-*Payment Due = check in
+Click '''Create New Payment Rule''' :
-<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> Automatic collection is only available for customer who use [[Stripe]].
+Payment Rule:
+*Name = Enter your title - Not Cancelled (for example)
-Create a Payment Rule to 'Capture' a payment only. Captured payments will only be valid for 7 days, then it will expire, if the booking is for a longer period, then you can create a second Capture, you will need to create another auto action for this.
-Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
-Payment Rule :
-*Name = Enter your title - Security Deposit (for example)
 *Action = Auto
 Payment Trigger :
-*Booking Status = select from the drop down list
+*Booking Status = All not cancelled
-*Any Booking Info Code = optional
+*Any Booking Info Code (optional)
-*All Booking Info Codes = optional
+*All Booking Info Codes (optional)
 *Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
 Payment Action :
-*Capture = Yes/No - immediately charged (Capture=Yes), if you want to make sure that the amount is available for later capture (Capture=No)
+*Funding Source = Guest card only
+*Payment value adjustment = Limit to group booking balance
+*Capture = Yes - immediately charged (Capture=Yes)
 *Add info code on success = add a Booking Info item to the booking on success
 *Add info code on failure = add a Booking Info item to the booking on failure
-</div>
-</div>
-<div class="mw-collapsible mw-collapsed">
+Prevent Auto Payment :
-<div  class="headline-collapse" >
+*Prevent payment if booking status = Cancelled
+*Prevent payment after check-out (days) = 7 (default)
+*Prevent payment action = Set Manual
-====Apply an info code and and/or icon when a payment was made====
+'''Create Auto Actions '''
-</div>
-<div class="mw-collapsible-content">
-Trigger tab:
-*Trigger Event = After Booking
-*Trigger Time = Immediate
-*Trigger Window = 365
-*Booking Source = All
-*Booking Status = All but not cancelled
-*Invoice Balance = Any Payment made
-Booking Info tab:
+Collect the outstanding balance for bookings created via your booking page.
-*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
-Process Template Variables : When created
+Go to {{#fas:cog}} (SETTINGS)  GUEST MANAGEMENT > AUTO ACTIONS and click '''Create New Action''' to create them.
-</div>
+'''Collect outstanding balance for direct bookings'''
-</div>
-<div class="mw-collapsible mw-collapsed">
+Trigger tab:
-<div  class="headline-collapse" >
+*Time
+**Trigger Event = Checkin
+**Trigger Time = -3 days (set the time you want to collect the payment)
+**Time Window = 3 days (set this to the same number (positive) as Trigger time.
-====Automatically apply invoice number at check-out - ''Select from predefined templates'' ====
+*Booking Source
-</div>
+**Booking Source = Direct. You can have different auto actions/rules for direct bookings -v- channel bookings, then select ‘Direct’ this will include manually created bookings and booking page bookings.
-<div class="mw-collapsible-content">
-'''Trigger tab:'''
-*Trigger Event = Check-out
+*Booking Conditions
-*Trigger Time = Immediate
+**Group Booking Trigger = Trigger only Master
-*Time window = 1 day
+**Status = All not cancelled
+**Invoice Balance= Not Zero (can be used to refine the auto action being triggered)
-Booking Conditions:
+Booking tab: Optional
-*Status = Confirmed
+*Flag Text = Pending payment added (for example)
+*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
+Booking Info tab: Optional, for information and reporting
+*Booking Info Code = BALANCE (for example enter the value - use one word only)
+*Booking Info Text = Enter the description/text to show in for the Booking Info Code.
+Invoice tab:
-Info Codes:
+<div class="warning">{{#fas:exclamation-triangle}} ONLY use Payment Type =‘ Percent of Group balance due’ if you selected Trigger tab > Booking Conditions > Group Booking Trigger = Trigger Only  Master.</div>
-*Any Booking Info Code = CHECKOUT (optional only if you use the check-out function)
-'''Invoice tab:'''
+*Add a Pending Payment to the booking
+**Payment Type = Percent of Group Balance due (select on what the payment is calculated)
+**Description = the text you will see in the "Charges and Payments" tab
+**Status = if you use the status function add the status you want to apply to the pending payment (optional)
+**Amount = 100 (this will be 100% of the outstanding group balance)
+**Payment Rule = Not Cancelled - See Step 4 above (if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS ->PAYMENT RULES they will be available here)
+**Payment Due = Trigger date
+**Payment time = set the time to collect payment
+**Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
-*Assign Invoice Number = yes
 </div>
 </div>
@@ Line 2,661: / Line 2,780: @@
 <div  class="headline-collapse" >
-====Using Pending Payments as a Payment Reminder====
+===='Capture' a Security Deposit when Credit card is collected at time of booking. ====
 </div>
 <div class="mw-collapsible-content">
 Trigger tab:
-*Trigger Event = After Booking or Before Check-in
+*Trigger Event = Booking
-*Trigger Time = set the time you want to add the pending payment to the booking
+*Trigger Time = immediate
 *Booking Source =All (for example, you can also set different rules for different channels)
-Booking Info tab:
+Info Codes:
-*Optional, add a booking info tab for information and reporting
+Any Booking Info Code = CARDTOSTRIPE
-Booking tab: Optional
-*Flag Text = PaymentDue1 (for example), set multiple if multiple payments are required.
-*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
 Invoice tab:
-*Payment Type = select on what the payment is calculated (Percent of Balance due)
+*Payment Type = Fixed amount
-*Description = the text you will see in the "Charges and Payments" tab
+*Description =  Security Deposit (the text you will see in the "Charges and Payments" tab)
 *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 = 100 (balance is full price so 100% of the balance)
-*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 = Security Deposit (Create a Payment Rule, see below)
-*Payment Due = Set when the payment is due
+*Payment Due = check in
+<span style="color:#fe746c;“ >{{#fas:exclamation-triangle}}  </span> Automatic collection is only available for customer who use [[Stripe]].
+Create a Payment Rule to 'Capture' a payment only. Captured payments will only be valid for 7 days, then it will expire, if the booking is for a longer period, then you can create a second Capture, you will need to create another auto action for this.
+Go to {{#fas:cog}} (SETTINGS)  PAYMENTS > PAYMENT RULES
+Payment Rule :
+*Name = Enter your title - Security Deposit (for example)
+*Action = Auto
-The Pending Payment Report is available in Bookings > Pending Payments. This report can be used to see outstanding pending payments, this can be used to see all outstanding payments, when payment gateways other than Stripe are used, the Pending Payments report can be used to see outstanding payments and a checklist for bank transfers.
+Payment Trigger :
+*Booking Status = select from the drop down list
+*Any Booking Info Code = optional
+*All Booking Info Codes = optional
+*Exclude Booking Info Code = optional (can exclude Virtual Credit cards, find the Booking info code in the booking)
+Payment Action :
+*Capture = Yes/No - immediately charged (Capture=Yes), if you want to make sure that the amount is available for later capture (Capture=No)
+*Add info code on success = add a Booking Info item to the booking on success
+*Add info code on failure = add a Booking Info item to the booking on failure
 </div>
 </div>
@@ Line 2,692: / Line 2,827: @@
 <div  class="headline-collapse" >
-====Test if Stripe Authorisation has expired and you need to trigger a new authorisation ====
+====Apply an info code and and/or icon when a payment was made====
 </div>
 <div class="mw-collapsible-content">
-Stripe authorisations are dependent on a number of factors including your account type, credit card provider, Stripe rules and the guest bank provider.
+Trigger tab:
+*Trigger Event = Booking
+*Trigger Time = Immediate
+*Trigger Window = 365
+*Booking Source = All
+*Booking Status = All but not cancelled
+*Invoice Balance = Any Payment made
-If you have bookings that are longer than the authorisation period, you will need to create multiple authorisations. You can use the details below in an auto action to test the date/value of the text/description of the Booking info code = 'STRIPEAUTHORIZE'
+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 Text : Enter the text you wish to sho
-For example you have a booking that is for 14 nights, but the authorisation period is 7 days.
+Process Template Variables : When created
-Trigger tab:
+</div>
+</div>
-*Trigger Event = Checkin
+<div class="mw-collapsible mw-collapsed">
-*Trigger Time =  + 7 days
+<div  class="headline-collapse" >
-*Trigger Window = 365
-*Booking Source = All
-*Booking Status = All but not cancelled
-Booking Conditions
+====Automatically apply invoice number at check-out - ''Select from predefined templates'' ====
+</div>
+<div class="mw-collapsible-content">
+'''Trigger tab:'''
-*Group Booking Trigger = Trigger only Master
+*Trigger Event = Check-out
-*Status = All not cancelled
+*Trigger Time = Immediate
-*Invoice Balance= Any
+*Time window = 1 day
-*Minimum Stay = 7
-*Maximum Stay = 14
-Info Codes
+Booking Conditions:
-*Any booking info code = CARDTOSTRIPE, STRIPEAUTHORIZE
+*Status = Confirmed
-*Exclude Booking Info code = BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT
-<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you receive virtual credit cards from the channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.
+Info Codes:
+*Any Booking Info Code = CHECKOUT (optional only if you use the check-out function)
-Booking Fields
+'''Invoice tab:'''
-*Template Variable = [IF<^[AUTHORIZEUNTIL{%Y-%m-%d}]^[CURRENTDATEYYYY-MM-DD]^yes~no] equal yes
-The entry in the info tab of the booking will typically be
+*Assign Invoice Number = yes
+</div>
+</div>
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-STRIPEAUTHORIZE Authorize 1500.00 EUR until 2024-08-14........
+====Using Pending Payments as a Payment Reminder====
+</div>
+<div class="mw-collapsible-content">
+Trigger tab:
+*Trigger Event = Booking or Booking (but not after Check-in)
+*Trigger Time = set the time you want to add the pending payment to the booking
+*Booking Source =All (for example, you can also set different rules for different channels)
-Check the substring numbers for your specific bookings, the date starts on the 28th char as the amount is 1500.00
+Booking Info tab:
+*Optional, add a booking info tab for information and reporting
 Booking tab: Optional
-*Flag Text = Security Deposit Pending Payment (for example)
+*Flag Text = PaymentDue1 (for example), set multiple if multiple payments are required.
 *Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
-Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.
-*Booking Info Code - REFDEPPP (for example)
-*Booking Info Text - Refundable Security Deposit pending payment
 Invoice tab:
-*Add a Pending Payment to the booking
+*Payment Type = select on what the payment is calculated (Percent of Balance due)
-*Payment Type = Fixed amount
 *Description = the text you will see in the "Charges and Payments" tab
 *Status = if you use the status function add the status you want to apply to the pending payment (optional)
-*Amount = 1500 (enter the value you want to authorise on the guest credit card )
+*Amount = enter the amount or percentage you want to collect
-*Payment Rule = Security Deposit (use the payment rule)
+*Payment Rule = Manual  - if you have set up payment rules in {{#fas:cog}} (SETTINGS) PAYMENTS > PAYMENT RULES they will be available here
-*Payment Due = Trigger date
+*Payment Due = Set when the payment is due
-*Payment time = set the time to collect payment
-*Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
-<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you accept Virtual Credit Cards from the channels, then you will need to send a payment link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so the guest can authorise the payment on their own credit card, it is not possible to take a Security deposit from a virtual card.
+The Pending Payment Report is available in Bookings > Pending Payments. This report can be used to see outstanding pending payments, this can be used to see all outstanding payments, when payment gateways other than Stripe are used, the Pending Payments report can be used to see outstanding payments and a checklist for bank transfers.
 </div>
 </div>
-===Booking Flags/Colours===
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-<div class="mw-collapsible mw-collapsed">
+====Test if Stripe Authorisation has expired and you need to trigger a new authorisation ====
-<div  class="headline-collapse" >
-====Apply a flag when a booking is cancelled====
 </div>
 <div class="mw-collapsible-content">
-Trigger tab
+Stripe authorisations are dependent on a number of factors including your account type, credit card provider, Stripe rules and the guest bank provider.
-*Trigger Event = Booking
-*Trigger Time = 1 Hour
-*Trigger Window = 365 days
-*Booking Status = Cancelled
-Booking tab:
+If you have bookings that are longer than the authorisation period, you will need to create multiple authorisations. You can use the details below in an auto action to test the date/value of the text/description of the Booking info code = 'STRIPEAUTHORIZE'
-*Execution = One time only
-*Booking Status = No Change
-*Flag text = (enter the text you require)
-*Flag Colour = 999999 default cancel colour - (Set as required)
-</div>
-</div>
-<div class="mw-collapsible mw-collapsed">
+For example you have a booking that is for 14 nights, but the authorisation period is 7 days.
-<div  class="headline-collapse" >
-====Apply a flag for a bookings from a channel which have breakfast included====
-</div>
-<div class="mw-collapsible-content">
 Trigger tab:
-*Trigger Event = After Booking
-*Trigger Time = Immediate
-*Booking Source = Booking.com (for example)
-*Booking Field Contains  - select "API Message" in the next field enter: meal_plan=Breakfast  (or Extra Breakfast - use the text the channel uses)
-Booking tab:
+*Trigger Event = Checkin
-*Execution = One time only
+*Trigger Time =  + 7 days
-*Flag Text = The text you want to display
+*Trigger Window = 365
-*Flag Colour - choose the flag colour
+*Booking Source = All
+*Booking Status = All but not cancelled
-Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
+Booking Conditions
-</div>
-</div>
-<div class="mw-collapsible mw-collapsed">
+*Group Booking Trigger = Trigger only Master
-<div  class="headline-collapse" >
+*Status = All not cancelled
+*Invoice Balance= Any
+*Minimum Stay = 7
+*Maximum Stay = 14
+Info Codes
+*Any booking info code = CARDTOSTRIPE, STRIPEAUTHORIZE
+*Exclude Booking Info code = BOOKINGVIRTCARD, EXPEDIACOLLECT, AGODACOLLECT
-====Apply a flag for a bookings which has BREAKFAST as a charge item====
+<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you receive virtual credit cards from the channels, then enter the Booking Info codes to prevent additional pending payments being added to bookings.
-</div>
-<div class="mw-collapsible-content">
-Trigger tab:
-*Trigger Event = After Booking
-*Trigger Time = Immediate
-*Booking Source = Booking.com (for example)
-*Template Variable = [IF>:[INVOICEITEMBYDESC:Breakfast]:0:yes|no] (Text for Breakfast has to match EXACTLY what is in the booking item Uppercase/Lowercase/Proper)
-*Select 'equal' from the selection box
-*yes (needs to be exactly the same text/upper/lowercase, as in the equation)
-Booking tab:
+Booking Fields
-*Execution = One time only
+*Template Variable = [IF<^[AUTHORIZEUNTIL{%Y-%m-%d}]^[CURRENTDATEYYYY-MM-DD]^yes~no] equal yes
-*Flag Text = Breakfast
-*Flag Colour - choose the flag colour
-Booking Info tab:
+The entry in the info tab of the booking will typically be
-*Booking Info Code = BREAKFAST
-*Booking Info Description = Breakfast included
-</div>
-</div>
-<div class="mw-collapsible mw-collapsed">
+STRIPEAUTHORIZE Authorize 1500.00 EUR until 2024-08-14........
-<div  class="headline-collapse" >
-====Apply a flag when deposit was made prior to Check-in====
+Check the substring numbers for your specific bookings, the date starts on the 28th char as the amount is 1500.00
-</div>
-<div class="mw-collapsible-content">
-Trigger tab:
-*Trigger Event = Check-in
+Booking tab: Optional
-*Trigger Time = -365 (for example : must be a negative value and the same as the value in Trigger window)
+*Flag Text = Security Deposit Pending Payment (for example)
-*Trigger Window = 365
+*Flag Colour = select the colour as this will be visible in the Calendar/Bookings list
-*Booking Source = All
-*Booking Status = All but not cancelled
-*Invoice Balance = Any Payment made
-Message tab:
+Booking Info tab: If you do not require an auto action to send a payment link to the guest for payment/authorisation, then this is optional.
+*Booking Info Code - REFDEPPP (for example)
+*Booking Info Text - Refundable Security Deposit pending payment
+Invoice tab:
+*Add a Pending Payment to the booking
+*Payment Type = Fixed amount
+*Description = the text you will see in the "Charges and Payments" tab
+*Status = if you use the status function add the status you want to apply to the pending payment (optional)
+*Amount = 1500 (enter the value you want to authorise on the guest credit card )
+*Payment Rule = Security Deposit (use the payment rule)
+*Payment Due = Trigger date
+*Payment time = set the time to collect payment
+*Invoicee = If you use the "invoicee" function you can select which invoicee the pending payment will be assigned to.
-*Send Email : select appropriate option
+<span style="color: #f3e504; font-size: 150%;" >{{#fas:lightbulb}} </span> If you accept Virtual Credit Cards from the channels, then you will need to send a payment link to either collect the guest credit card to then authorise the Security Deposit on their personnel card OR send a payment link so the guest can authorise the payment on their own credit card, it is not possible to take a Security deposit from a virtual card.
-*Enter : Subject and Email content
-Booking tab: (optional)
+</div>
+</div>
-*Execution = One time only
+===Booking Flags/Colours===
-*Flag Text = The text you want to display
-*Flag Colour - choose the flag colour
-Booking info tab : (optional)
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
+====Apply a flag when a booking is cancelled====
+</div>
+<div class="mw-collapsible-content">
+Trigger tab
+*Trigger Event = Booking
+*Trigger Time = 1 Hour
+*Trigger Window = 365 days
+*Booking Status = Cancelled
-*Booking Info Code : DEPOSITPAID (for example)
+Booking tab:
-*Booking Info Text : additional text if required.
+*Execution = One time only
+*Booking Status = No Change
-Setting details with the Booking tab and Booking info tab allows you to trigger additional (follow on) Auto Actions and Reports.
+*Flag text = (enter the text you require)
+*Flag Colour = 999999 default cancel colour - (Set as required)
 </div>
 </div>
 <div class="mw-collapsible mw-collapsed">
 <div  class="headline-collapse" >
-====Apply a flag when booking is fully paid====
+====Apply a flag for a bookings from a channel which have breakfast included====
 </div>
 <div class="mw-collapsible-content">
 Trigger tab:
-*Trigger Event = After Booking
+*Trigger Event = Booking
 *Trigger Time = Immediate
-*Trigger Window = 365
+*Booking Source = Booking.com (for example)
-*Booking Source = All
+*Booking Field Contains  - select "API Message" in the next field enter: meal_plan=Breakfast  (or Extra Breakfast - use the text the channel uses)
-*Booking Status = All not cancelled
-*Invoice Balance = ZERO
 Booking tab:
@@ Line 2,875: / Line 3,006: @@
 *Flag Text = The text you want to display
 *Flag Colour - choose the flag colour
+Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the Email.
 </div>
 </div>
@@ Line 2,881: / Line 3,014: @@
 <div  class="headline-collapse" >
-====Apply a flag/colour for a booking coming from a certain channel - ''Select from the predefined template'' ====
+====Apply a flag for a bookings which has BREAKFAST as a charge item====
 </div>
 <div class="mw-collapsible-content">
+Trigger tab:
-'''Trigger tab:'''
 *Trigger Event = Booking
 *Trigger Time = Immediate
 *Booking Source = Booking.com (for example)
+*Template Variable = [IF>:[INVOICEITEMBYDESC:Breakfast]:0:yes|no] (Text for Breakfast has to match EXACTLY what is in the booking item Uppercase/Lowercase/Proper)
+*Select 'equal' from the selection box
+*yes (needs to be exactly the same text/upper/lowercase, as in the equation)
-'''Booking tab:'''
+Booking tab:
 *Execution = One time only
-*Flag Text = The text you want to display
+*Flag Text = Breakfast
 *Flag Colour - choose the flag colour
-Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the email.
+Booking Info tab:
+*Booking Info Code = BREAKFAST
+*Booking Info Description = Breakfast included
 </div>
 </div>
@@ Line 2,904: / Line 3,039: @@
 <div  class="headline-collapse" >
-====Apply a flag when NO payment is made - ''Select from the predefined template''====
+====Apply a flag when deposit was made prior to Check-in====
 </div>
 <div class="mw-collapsible-content">
+Trigger tab:
-'''Trigger tab:'''
+*Trigger Event = Check-in
+*Trigger Time = -365 (for example : must be a negative value and the same as the value in Trigger window)
+*Trigger Window = 365
+*Booking Source = All
+*Booking Status = All but not cancelled
+*Invoice Balance = Any Payment made
-*Trigger Event = Booking
+Message tab:
-*Trigger Time = Immediate
-*Trigger Window = 1 day
-Booking Source:
+*Send Email : select appropriate option
-*Booking Source = All
+*Enter : Subject and Email content
-Booking Conditions:
+Booking tab: (optional)
-*Booking Status = All not cancelled
-*Invoice Balance = No payment made
-'''Booking tab:'''
 *Execution = One time only
-*Flag Text = Not Paid
+*Flag Text = The text you want to display
-*Flag Colour = fee0dd
+*Flag Colour - choose the flag colour
+Booking info tab : (optional)
+*Booking Info Code : DEPOSITPAID (for example)
+*Booking Info Text : additional text if required.
+Setting details with the Booking tab and Booking info tab allows you to trigger additional (follow on) Auto Actions and Reports.
 </div>
 </div>
 <div class="mw-collapsible mw-collapsed">
 <div  class="headline-collapse" >
+====Apply a flag when booking is fully paid====
-====Apply a flag when a payment was made====
 </div>
 <div class="mw-collapsible-content">
-<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span>  Also see Example : " Apply a flag when deposit was made prior to Check-in AND/OR Apply a flag when booking is fully paid".
 Trigger tab:
 *Trigger Event = Booking
@@ Line 2,943: / Line 3,082: @@
 *Booking Source = All
 *Booking Status = All not cancelled
-*Invoice Balance = Any Payment made
+*Invoice Balance = ZERO
 Booking tab:
@@ Line 2,955: / Line 3,094: @@
 <div  class="headline-collapse" >
-====Apply a flag when a payment FAILS at Stripe - ''Select from predefined template'' ====
+====Apply a flag/colour for a booking coming from a certain channel - ''Select from the predefined template'' ====
 </div>
 <div class="mw-collapsible-content">
 '''Trigger tab:'''
-*Trigger Event = Booking (but not after check-in)
+*Trigger Event = Booking
 *Trigger Time = Immediate
-*Trigger Window = 999
+*Booking Source = Booking.com (for example)
-Booking Source:
-*Booking Source = All
-*Booking Status = All but not cancelled
-*Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE
 '''Booking tab:'''
 *Execution = One time only
-*Flag Text = Stripe Payment Failed
+*Flag Text = The text you want to display
-*Flag Colour - fee0dd
+*Flag Colour - choose the flag colour
+Booking changes are applied before the mail is sent so that the flag template variable can be reflected in the email.
 </div>
 </div>
@@ Line 2,981: / Line 3,117: @@
 <div  class="headline-collapse" >
-====Apply a flag to Booking.com bookings and auto report the Credit Card when a payment FAILS at Stripe====
+====Apply a flag when NO payment is made - ''Select from the predefined template''====
 </div>
 <div class="mw-collapsible-content">
-Go to Settings > Channel Manager > Preferences and set Auto report failed cards = Yes
 '''Trigger tab:'''
-*Trigger Event = Booking (but not after checkout)
+*Trigger Event = Booking
 *Trigger Time = Immediate
-*Trigger Window = 999
+*Trigger Window = 1 day
 Booking Source:
-*Booking Source = Booking.com
+*Booking Source = All
 Booking Conditions:
 *Booking Status = All not cancelled
-*Booking Info Code = BOOKINGCOMCARD
+*Invoice Balance = No payment made
 '''Booking tab:'''
 *Execution = One time only
-*Flag Text = Failed CC reported to Booking.com
+*Flag Text = Not Paid
-*Flag Colour - choose the flag colour
+*Flag Colour = fee0dd
 </div>
 </div>
-===Status changes===
 <div class="mw-collapsible mw-collapsed">
 <div  class="headline-collapse" >
-==== Change the status of all "Request" bookings to "Cancelled" after three days ====
+====Apply a flag when a payment was made====
 </div>
 <div class="mw-collapsible-content">
-Trigger tab
+<span style="color: #f3e504; font-size: 250%;" >{{#fas:lightbulb}} </span>  Also see Example : " Apply a flag when deposit was made prior to Check-in AND/OR Apply a flag when booking is fully paid".
+Trigger tab:
 *Trigger Event = Booking
-*Trigger Time = 3 days
+*Trigger Time = Immediate
-*Booking Status = Request
+*Trigger Window = 365
+*Booking Source = All
+*Booking Status = All not cancelled
+*Invoice Balance = Any Payment made
 Booking tab:
 *Execution = One time only
-*Booking Status = Cancelled
+*Flag Text = The text you want to display
+*Flag Colour - choose the flag colour
 </div>
 </div>
@@ Line 3,028: / Line 3,168: @@
 <div  class="headline-collapse" >
-==== Change the status of Airbnb "Inquiry" bookings to "Cancelled" after three days ====
+====Apply a flag when a payment FAILS at Stripe - ''Select from predefined template'' ====
 </div>
 <div class="mw-collapsible-content">
-Trigger tab
-*Trigger Event = Booking
+'''Trigger tab:'''
-*Trigger Time = 3 days
-*Booking Status = Inquiry
+*Trigger Event = Booking (but not after check-in)
-*Booking Source = Airbnb
+*Trigger Time = Immediate
+*Trigger Window = 999
+Booking Source:
+*Booking Source = All
+*Booking Status = All but not cancelled
+*Booking Info Code = STRIPEFAIL, CARDFAILSTRIPE
+'''Booking tab:'''
-Booking tab:
 *Execution = One time only
-*Booking Status = Cancelled
+*Flag Text = Stripe Payment Failed
+*Flag Colour - fee0dd
 </div>
 </div>
@@ Line 3,047: / Line 3,194: @@
 <div  class="headline-collapse" >
-==== Change the status of all bookings which have been imported from Ical to "Request" ====
+====Apply a flag to Booking.com bookings and auto report the Credit Card when a payment FAILS at Stripe====
 </div>
 <div class="mw-collapsible-content">
-Trigger tab:
-*Trigger Event = After Booking
+Go to Settings > Channel Manager > Preferences and set Auto report failed cards = Yes
+'''Trigger tab:'''
+*Trigger Event = Booking (but not after checkout)
 *Trigger Time = Immediate
-*Booking Source = Ical Import (1, 2, 3)
+*Trigger Window = 999
-Booking tab:
+Booking Source:
-*Execution = One time only
+*Booking Source = Booking.com
-*Booking Status = Request
+Booking Conditions:
+*Booking Status = All not cancelled
+*Booking Info Code = BOOKINGCOMCARD
+'''Booking tab:'''
-Booking changes are applied before the mail is sent.
+*Execution = One time only
+*Flag Text = Failed CC reported to Booking.com
+*Flag Colour - choose the flag colour
 </div>
 </div>
@@ Line 3,066: / Line 3,224: @@
 <div  class="headline-collapse" >
-==== Change Room Unit Status when guest checks out ====
+====Apply a flag when booking has been Checked-in====
 </div>
 <div class="mw-collapsible-content">
-Trigger tab
+Trigger tab:
-*Trigger Event = Check-out
+*Trigger Event = Check-in
 *Trigger Time = Immediate
 *Trigger Window = 1 day
+*Booking Source = All
 *Booking Status = All but not cancelled
-*Any Booking Info Code = CHECKOUT
+*Any booking info code = CHECKIN
+Booking tab:
-Booking tab:
 *Execution = One time only
-*Change Room Unit Status = Select the option
+*Flag Text = Guest checked in (or any text you want to see)
+*Flag Colour - choose the flag colour
-It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
 </div>
 </div>
-===API/Webhook===
+===Status changes===
 <div class="mw-collapsible mw-collapsed">
 <div  class="headline-collapse" >
-====Use API/Webhook to write to the field 'Message'====
+==== Change the status of all "Request" bookings to "Cancelled" after three days ====
 </div>
 <div class="mw-collapsible-content">
+Trigger tab
+*Trigger Event = Booking
+*Trigger Time = 3 days
+*Booking Status = Request
-You can use a webhook in conjunction with the API JSON function '''setBooking''' to write to any field in the booking. First you have to configure access to the API:
+Booking tab:
+*Execution = One time only
- 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>
+*Booking Status = Cancelled
- '''API key:'''
-*{{#fas:cog}} (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS  "API Key 1"
-*API Key = my_very_secret_api_key
-*API Key Access = allow any IP
-*IP Whitelist = [leave empty]
-*Allow Writes = Yes
-*Property Access = Owned by this account only
-*'''Property key:'''
-*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX
-Set the triggers you need, for example:
-Booking Field Contains: Message = XXX
-Set the webhook like this:
-* URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>
-* Custom Header = [leave empty]
-Body Data:
-:{
-::"authentication":
-::{
-:::"apiKey": "my_very_secret_api_key",
-:::"propKey": "secret_key_for_prop_XXXXXX"
-::},
-::"bookId": "[BOOKID]",
-::"message": "[MESSAGE] - Append this message"
-:}
 </div>
 </div>
@@ Line 3,129: / Line 3,265: @@
 <div  class="headline-collapse" >
-====Use API/Webhook to write the value of the 'commission' field to a new invoice item====
+==== Change the status of Airbnb "Inquiry" bookings to "Cancelled" after three days ====
 </div>
 <div class="mw-collapsible-content">
-You can create a new invoice item that contains the price of the channel's commission as a negative value to subtract it from the room price. You use the API JSON function '''setBooking''' for this. First you need to configure access to the API:
+Trigger tab
+*Trigger Event = Booking
-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>
+*Trigger Time = 3 days
-'''API key:'''
+*Booking Status = Inquiry
-*{{#fas:cog}} (SETTINGS) ACCOUNT -> ACCOUNT->ACCESS  "API Key 1"
+*Booking Source = Airbnb
-*API Key = my_very_secret_api_key
-*API Key Access = allow any IP
+Booking tab:
-*IP Whitelist = [leave empty]
+*Execution = One time only
-*Allow Writes = Yes
+*Booking Status = Cancelled
-*Property Access = Owned by this account only
-*'''Property key:'''
-*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS> propKey = secret_key_for_prop_XXXXXX
-Set the triggers you need, for example:
+</div>
+</div>
-Booking Source = Booking.com
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-Set the webhook like this:
+==== Change the booking status from Inquiry to Confirmed when the payment is made ====
+</div>
+<div class="mw-collapsible-content">
+Trigger tab
+*Trigger Event = Booking
+*Trigger Time = 365 days
+*Booking Status = Inquiry
+*Booking Source = ALL
+*Invoice Balance = Any payment Made
-*URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>
+Booking tab:
-*Custom Header = [leave empty]
+*Execution = One time only
+*Booking Status = Cancelled
-*Body Data =
+</div>
-:{
+</div>
-::"authentication":
-::{
-:::"apiKey": "my_very_secret_api_key",
-:::"propKey": "secret_key_for_prop_XXXXXX"
-::},
-::"bookId": "[BOOKID]",
-::"invoice":
-::[
-:::{
-::::"description": "Booking.com Commission",
-::::"status": "",
-::::"qty": "1",
-::::"price": "-[COMMISSIONNUM]",
-::::"vatRate": "7.00",
-::::"type": "0",
-::::"invoiceeId": ""
-:::}
-::]
-:}
-</div>
-</div>
 <div class="mw-collapsible mw-collapsed">
 <div  class="headline-collapse" >
-====Use Auto Action/Webhook to write to send data to Integromat====
+==== Change the status of all bookings which have been imported from Ical to "Request" ====
 </div>
 <div class="mw-collapsible-content">
+Trigger tab:
+*Trigger Event = Booking
+*Trigger Time = Immediate
+*Booking Source = Ical Import (1, 2, 3)
-You can use this option to send data to your Integromat account.
+Booking tab:
+*Execution = One time only
+*Booking Status = Request
-Set the rules in the Trigger tab, when you need to send the data to Integromat.
+Booking changes are applied before the mail is sent.
+</div>
+</div>
-Go to Webhook tab:
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-URL = https://hook.integromat.com/ followed by your integromat account key.
+==== Change Room Unit Status when guest checks out ====
+</div>
+<div class="mw-collapsible-content">
+Trigger tab
+*Trigger Event = Check-out
+*Trigger Time = Immediate
+*Trigger Window = 1 day
+*Booking Status = All but not cancelled
+*Any Booking Info Code = CHECKOUT
-Body Data = you can use the template variables allows in the list for Integromat [[https://wiki.beds24.com/index.php/Make#Data_Fields Data fields]]
+Booking tab:
+*Execution = One time only
+*Change Room Unit Status = Select the option
-For example :-
+It is assumed you use the Checkin/Checkout feature in the Dashboard, if not you can either manually add Checkin to your bookings (Booking info tab) or create an auto action to add the Booking Info Codes to the bookings.
+</div>
+</div>
-bookingData={
+===API/Webhook===
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
+====Use API/Webhook to write to the field 'Message'====
+</div>
+<div class="mw-collapsible-content">
-"bookId":"[BOOKID]",
+You can use a webhook in conjunction with the API JSON function '''setBooking''' to write to any field in the booking. First you have to configure access to the API:
-"guestMobileNum":"[GUESTMOBILENUM]",
+ 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:'''
+*{{#fas:cog}} (SETTINGS) ACCOUNT > ACCOUNT >ACCESS  "API Key 1"
+*API Key = my_very_secret_api_key
+*API Key Access = allow any IP
+*IP Whitelist = [leave empty]
+*Allow Writes = Yes
+*Property Access = Owned by this account only
+*'''Property key:'''
+*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX
-"guestMobile":"[GUESTMOBILE]",
+Set the triggers you need, for example:
-"guestSMS":"[GUESTSMS:44]",
+Booking Field Contains: Message = XXX
-"guestFirstName":"[REPLACE|&|and|[GUESTFIRSTNAME]]",
+Set the webhook like this:
+* URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>
+* Custom Header = [leave empty]
+Body Data:
+:{
+::"authentication":
+::{
+:::"apiKey": "my_very_secret_api_key",
+:::"propKey": "secret_key_for_prop_XXXXXX"
+::},
+::"bookId": "[BOOKID]",
+::"message": "[MESSAGE] - Append this message"
+:}
+</div>
+</div>
-"propertyName":"[PROPERTYNAME]",
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
-"propertyId":"[PROPERTYID]",
+====Use API/Webhook to write the value of the 'commission' field to a new invoice item====
+</div>
+<div class="mw-collapsible-content">
+You can create a new invoice item that contains the price of the channel's commission as a negative value to subtract it from the room price. You use the API JSON function '''setBooking''' for this. First you need to configure access to the API:
-"firstNight":"[FIRSTNIGHTSHORT]",
+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:'''
+*{{#fas:cog}} (SETTINGS) ACCOUNT > ACCOUNT > ACCESS  "API Key 1"
+*API Key = my_very_secret_api_key
+*API Key Access = allow any IP
+*IP Whitelist = [leave empty]
+*Allow Writes = Yes
+*Property Access = Owned by this account only
+*'''Property key:'''
+*{{#fas:cog}} (SETTINGS) PROPERTIES > ACCESS > propKey = secret_key_for_prop_XXXXXX
-"lastNight":"[LEAVINGDAYSHORT]"
+Set the triggers you need, for example:
+Booking Source = Booking.com
+Set the webhook like this:
+*URL = <nowiki>https://api.beds24.com/json/setBooking</nowiki>
+*Custom Header = [leave empty]
+*Body Data =
+:{
+::"authentication":
+::{
+:::"apiKey": "my_very_secret_api_key",
+:::"propKey": "secret_key_for_prop_XXXXXX"
+::},
+::"bookId": "[BOOKID]",
+::"invoice":
+::[
+:::{
+::::"description": "Booking.com Commission",
+::::"status": "",
+::::"qty": "1",
+::::"price": "-[COMMISSIONNUM]",
+::::"vatRate": "7.00",
+::::"type": "0",
+::::"invoiceeId": ""
+:::}
+::]
+:}
+</div>
+</div>
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
+====Use Auto Action/Webhook to write to send data to Integromat====
+</div>
+<div class="mw-collapsible-content">
+You can use this option to send data to your Integromat account.
+Set the rules in the Trigger tab, when you need to send the data to Integromat.
+Go to Webhook tab:
+URL = https://hook.integromat.com/ followed by your integromat account key.
+Body Data = you can use the template variables allows in the list for Integromat [[https://wiki.beds24.com/index.php/Make#Data_Fields Data fields]]
+For example :-
+bookingData={
+"bookId":"[BOOKID]",
+"guestMobileNum":"[GUESTMOBILENUM]",
+"guestMobile":"[GUESTMOBILE]",
+"guestSMS":"[GUESTSMS:44]",
+"guestFirstName":"[REPLACE|&|and|[GUESTFIRSTNAME]]",
+"propertyName":"[PROPERTYNAME]",
+"propertyId":"[PROPERTYID]",
+"firstNight":"[FIRSTNIGHTSHORT]",
+"lastNight":"[LEAVINGDAYSHORT]"
 }
+</div>
+</div>
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
+====Use webhook to switch a Shelly on====
+</div>
+<div class="mw-collapsible-content">
+Here is a simple PHP script with which you can switch a Shelly via an autoaction in beds24.
+You can use this to switch on a string of lights on the day of arrival or to charge the night storage heating if a certain info code is set in the booking on the day before arrival.
+Create an auto action and enter the PHP script ‘beds24-shelly-steuern.php’ under ‘Webhook’. The parameters for the control are transferred under ‘Data in body’:
+ id:b0b21c1xxxxx
+ shelly_server:shelly-123-eu.shelly.cloud
+ auth_key:ABCDEFGHIJKLMNPQRSTUVWXYZABCDEFGHIJKLMNPQRSTUVWXYZABCDEFGHIJKLMNPQRSTUVWXYZ
+ shelly_url:device/relay/control
+ parameter:channel=0&turn=on
+ email_result:[email protected]
+ remarks:Text, z.B. mit Template Variablen [GUESTFULLNAME] und [BOOKID]
+</div>
+</div>
+<div class="mw-collapsible mw-collapsed">
+<div  class="headline-collapse" >
+====V2 version of the code for Shelly ====
+</div>
+<div class="mw-collapsible-content">
+Here is the second version v2 of the PHP script to switch on a Shelly device via an autoaction.
+Now you can also store the device IDs in the script instead of adding them to the body parameters. This makes it possible to switch a Shelly device with a single autoaction. The device ID is then determined via the template variable [INTERNALROOMNAME].
+Code: Select all
+<?php
+/*
+* - Anschalten der Lichterkette aus beds24 mit einem PHP Skript über die Shelly Cloud -
+* Version 2 vom 10.12.2024 - mehrere Devices im Array im Skript möglich
+*
+* https://domainname.de/scripte/beds24-shelly-steuern-v2.php
+*
+* curl -X POST https://shelly-123-eu.shelly.cloud/device/relay/control -d "channel=0&turn=on&id=b0b21c123456&auth_key=abcdefghijklmnopqrstuvwxyz1234567890"
+* Einstellungen in beds24
+* - in einer Autoaction unter 'Webhook' das Script eintragen: https://domainname.de/pfad_zum_script/beds24-shelly-steuern-v2.php
+* - alternativ wenn Geräte-Id überINTERNALROOMNAME im Skript selbst: https://domainname.de/pfad_zum_script/beds24-shelly-steuern-v2?roomname=[INTERNALROOMNAME]
+* - unter 'Daten im Body' die Parameter zur Steuerung eintragen:
+* - id:<Shelly Geräte-Id>     ===> alternativ mehrere Geräte-Id im Skript selbst
+* - shelly_server:<Shelly Cloud Server>
+* - auth_key:<Shelly Cloud-Autorisierungs-Schlüssel>
+* - parameter:<Shelly Befehle>
+* - email_result:<*optional* e-mail für Empfänger des Schaltergebnisses>
+* - remarks:<*optional* beliebige Anmerkungen für E-Mail>
+*
+* Beispiel:
+* id:b0b21c123456
+* shelly_server:shelly-123-eu.shelly.cloud
+* auth_key:abcdefghijklmnopqrstuvwxyz1234567890
+* shelly_url:device/relay/control
+* parameter:channel=0&turn=on
+* email_result:[email protected]
+* remarks:Text, auch mit Template Variablen [GUESTFULLNAME] und [BOOKID]/[INTERNALROOMNAME] möglich
+*/
+/* ----------------------------------------------------------- */
+/* Parameter & Einstellungen */
+/* ----------------------------------------------------------- */
+/* Shelly Geräte-ID entweder beim Aufruf in beds24 über die 'Daten im Body' übergeben oder hier im Skript eintragen. Wenn im Script, dann beim Aufruf die Templatevariable [INTERNALROOMNAME] mitgeben, über die erfolgt dann die Auswahl hier im Array */
+$p_geraete_ids = array (
+	"chalet" => "e465b8123456",
+	"fewo" => "b0b21c123456",
+	"linx" => "e465b8123456"
+	);
+$p_test = false; /* im Testmodus kommen die Parameter direkt aus dem Script statt über beds24 */
+/* Body Daten zum direkten Testen d.h. Direktaufruf des Scripts ohne Autoaction */
+$test_body = array(  /* zum direkten Aufruf des Scripts die Parameter hier testweise eintragen */
+/* https://shelly-api-docs.shelly.cloud/cloud-control-api/communication */
+	"id" => "xxx",    /* rausnehmen, wenn ids über Array kommen sollen */
+	"shelly_server" => "shelly-123-eu.shelly.cloud",
+	"auth_key" => "abcdefghijklmnopqrstuvwxyz1234567890",
+	"shelly_url" => "device/relay/control",
+	"parameter" => "channel=0&turn=on",
+	"email_result" => "[email protected]",
+	"remarks" => "Text, z.B. mit Template Variablen [GUESTFULLNAME] und [BOOKID]"
+	);
+/* ----------------------------------------------------------- */
+/* ab hier normalerweise keine Änderungen mehr vornehmen
+/* ----------------------------------------------------------- */
+$hf_internalroomname = filter_var($_GET["roomname"], FILTER_SANITIZE_STRING);   /* wenn über ?roomname=[INTERNALROOMNAME] übergeben
+/* Body aus Post message lesen und in Variablen $body[keyname] einlesen */
+if ($p_test == false ) {
+	$hf_body = explode( "\n", file_get_contents('php://input') );
+	$body = array();
+		foreach ($hf_body as $v) {
+			list($body_key,$body_value) = explode( ':', $v );
+			$body[$body_key] = $body_value;
+		}
+}
+else {
+	$body = $test_body; /* im Testmodus Parameter direkt aus dem Script nehmen */
+}
+ob_start(); /* Bildschirmausgabe buffern */
+/* wenn übergeben, dann Geräte-ID aus den body-parametern übernehmen, ansonsten über [INTERNALROOMNAME] ermitteln */
+if ( $body["id"]) {                       /* in Body Parameter gesetzt */
+	$hf_geraete_id = $body["id"];
+} else {
+	$hf_geraete_id = $p_geraete_ids[$hf_internalroomname];    /* Geräte-Id aus Skript Array nehmen */
+}
+/* Prüfen ob wichtige Argumente übergeben */
+if ( isset($body["shelly_server"]) == false ) { echo("Argument shelly_server fehlt, z.B.: shelly_server:servername<br>"); $body["shelly_server"] = "fehlt";}
+if ( isset($body["shelly_url"]) == false ) { echo("Argument shelly_url fehlt, z.B. : shelly_url:device/relay/control<br>"); $body["shelly_url"] = "fehlt";}
+if ( isset($body["parameter"]) == false ) { echo("Argument parameter fehlt, z.B.: parameter:channel=0&turn=on><br>"); $body["parameter"] = "fehlt";}
+if ( isset($body["auth_key"]) == false ) { echo("Argument auth_key fehlt, z.B.: auth_key:abcdefghijklmnopqrstuvwxyz1234567890<br>"); $body["auth_key"] = "fehlt";}
+$url = 'https://'.$body["shelly_server"].'/'.trim($body["shelly_url"], " /");
+$ch=curl_init();
+curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
+curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); /* Zertifikatswarnung übergehen */
+curl_setopt($ch, CURLOPT_SSL_VERIFYSTATUS, false);
+curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
+curl_setopt($ch, CURLOPT_PROXY_SSL_VERIFYPEER, false);
+curl_setopt($ch, CURLOPT_POST, true);
+curl_setopt($ch, CURLOPT_POSTFIELDS,
+            $body["parameter"]."&id=".$hf_geraete_id."&auth_key=".$body["auth_key"]);
+curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
+curl_setopt($ch, CURLOPT_URL, $url);
+$result = curl_exec($ch);
+curl_close ($ch);
+if ( $body["remarks"] ) {   /* Anmerkungen fürs Protokoll/E-Mail ausgeben */
+	echo ("<br>".$body["remarks"]."<br>");
+	};
+$output = ob_get_contents(); /* Bildschirmausgabe aus Buffer lesen */
+ob_end_clean();
+echo $output;
+if ( $body["email_result"] ) {
+	mail($body["email_result"], 'Ergebnis Shelly Skript - Device: '.$hf_geraete_id, $output, 'From: beds24 Shelly Script <'.$body["email_result"].'>');
+    echo ("<br>Mail an: ".$body["email_result"]);
+}
+?>
 </div>

Auto Actions: Difference between revisions

Navigation menu

Search