Merged PR 2381: Adding submetrics of guest revenue

Adding submetrics of guest revenue:
- deposit fees
- checkin cover fees
- waiver payments

all of this adds up to
- guest income

and the revenue is computed by subtracting waivers paid to hosts

Related work items: #18787

models/intermediate/cross/int_mtd_guest_revenue_metrics.sql

@@ -2,19 +2,15 @@
 This model provides Month-To-Date (MTD) based on Guest Revenue metrics.
 
 */
-{% set revenue_verification_payment_type_items = "('FEE','WAIVER','CHECKINCOVER')" %}
+{% set deposit_fees_verification_payment_type_items = "('FEE')" %}
-{% set relevant_document_statuses = "('PAID', 'AUTHORISED')" %}
+{% set waiver_fees_verification_payment_type_items = "('WAIVER')" %}
-{% set waiver_items = "('DAMAGE WAVER','DAMAGE WAIVER')" %}
+{% set checkin_cover_fees_verification_payment_type_items = "('CHECKINCOVER')" %}
 
 {{ config(materialized="table", unique_key="date") }}
 with
     int_core__verification_payments as (
         select * from {{ ref("int_core__verification_payments") }}
     ),
-    int_xero__credit_note_line_items as (
-        select * from {{ ref("int_xero__credit_note_line_items") }}
-    ),
-    int_xero__credit_notes as (select * from {{ ref("int_xero__credit_notes") }}),
     int_dates_mtd as (select * from {{ ref("int_dates_mtd") }}),
 
     -- Paid Guest Revenue MTD --
@@ -26,11 +22,29 @@ with
                 case
                     when
                         upper(vp.verification_payment_type)
-                        in {{ revenue_verification_payment_type_items }}
+                        in {{ deposit_fees_verification_payment_type_items }}
                     then vp.amount_in_gbp
                     else null
                 end
-            ) as total_guest_income_in_gbp
+            ) as deposit_fees_in_gbp,
+            sum(
+                case
+                    when
+                        upper(vp.verification_payment_type)
+                        in {{ waiver_fees_verification_payment_type_items }}
+                    then vp.amount_in_gbp
+                    else null
+                end
+            ) as waiver_payments_in_gbp,
+            sum(
+                case
+                    when
+                        upper(vp.verification_payment_type)
+                        in {{ checkin_cover_fees_verification_payment_type_items }}
+                    then vp.amount_in_gbp
+                    else null
+                end
+            ) as checkin_cover_fees_in_gbp            
         from int_dates_mtd d
         inner join
             int_core__verification_payments vp
@@ -38,24 +52,6 @@ with
             and extract(day from vp.payment_paid_date_utc) <= d.day
         where upper(vp.payment_status) = {{ var("paid_payment_state") }}
         group by 1
-    ),
-    -- Waiver Credit Notes MTD --
-    -- We need to get the credited waivers for those
-    -- host-takes-waiver cases
-    waiver_credit_notes as (
-        select d.date, sum(cnli.line_amount_wo_taxes_in_gbp) as waiver_fees_credited
-        from int_dates_mtd d
-        inner join
-            int_xero__credit_notes cn
-            on date_trunc('month', cn.credit_note_issued_date_utc)::date = d.first_day_month
-            and extract(day from cn.credit_note_issued_date_utc) <= d.day
-        inner join
-            int_xero__credit_note_line_items cnli
-            on cn.id_credit_note = cnli.id_credit_note
-        where
-            upper(cn.credit_note_status) in {{ relevant_document_statuses }}
-            and upper(cnli.item_code) in {{ waiver_items }}
-        group by 1
     )
 -- Final aggregation of subqueries --
 select
@@ -65,13 +61,15 @@ select
     d.date,
     d.is_end_of_month,
     d.is_current_month,
+    nullif(gpym.deposit_fees_in_gbp, 0) as deposit_fees_in_gbp,
+    nullif(gpym.waiver_payments_in_gbp, 0) as waiver_payments_in_gbp,
+    nullif(gpym.checkin_cover_fees_in_gbp, 0) as checkin_cover_fees_in_gbp,
     nullif(gpym.total_guest_payments_in_gbp, 0) as total_guest_payments_in_gbp,
-    -- Deduct from total guest income the host-takes-waiver income
     nullif(
-        coalesce(gpym.total_guest_income_in_gbp, 0)
+        coalesce(gpym.deposit_fees_in_gbp, 0)
-        - coalesce(wcn.waiver_fees_credited, 0),
+        + coalesce(gpym.waiver_payments_in_gbp, 0)
+        + coalesce(gpym.checkin_cover_fees_in_gbp, 0),
         0
-    ) as total_guest_revenue_in_gbp
+    ) as total_guest_income_in_gbp
 from int_dates_mtd d
 left join guest_payments_year_month gpym on gpym.date = d.date
-left join waiver_credit_notes wcn on wcn.date = d.date

models/intermediate/cross/int_mtd_vs_previous_year_metrics.sql

@@ -92,12 +92,21 @@ with
             invoicing.xero_host_resolution_payment_count,
 
             -- GUEST REVENUE AND PAYMENTS --
+            guest_revenue.deposit_fees_in_gbp,
+            guest_revenue.waiver_payments_in_gbp,
+            guest_revenue.checkin_cover_fees_in_gbp,
             guest_revenue.total_guest_payments_in_gbp,
-            guest_revenue.total_guest_revenue_in_gbp,
+            guest_revenue.total_guest_income_in_gbp,
+            nullif(
+                coalesce(guest_revenue.total_guest_income_in_gbp, 0)
+                + coalesce(invoicing.xero_waiver_net_fees_in_gbp, 0),
+                0
+            ) as total_guest_revenue_in_gbp,
 
             -- TOTAL REVENUE --
             nullif(
-                coalesce(guest_revenue.total_guest_revenue_in_gbp, 0)
+                coalesce(guest_revenue.total_guest_income_in_gbp, 0)
+                + coalesce(invoicing.xero_waiver_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_operator_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_apis_net_fees_in_gbp, 0),
                 0
@@ -110,36 +119,48 @@ with
             guest_revenue.total_guest_payments_in_gbp / nullif(
                 guest_journeys.paid_guest_journeys, 0
             ) as guest_payments_per_paid_guest_journey,
-            guest_revenue.total_guest_revenue_in_gbp / nullif(
+            nullif(
+                coalesce(guest_revenue.total_guest_income_in_gbp, 0)
+                + coalesce(invoicing.xero_waiver_net_fees_in_gbp, 0),
+                0
+            ) / nullif(
                 guest_journeys.completed_guest_journeys, 0
             ) as guest_revenue_per_completed_guest_journey,
-            guest_revenue.total_guest_revenue_in_gbp / nullif(
+            nullif(
+                coalesce(guest_revenue.total_guest_income_in_gbp, 0)
+                + coalesce(invoicing.xero_waiver_net_fees_in_gbp, 0),
+                0
+            ) / nullif(
                 guest_journeys.paid_guest_journeys, 0
             ) as guest_revenue_per_paid_guest_journey,
 
             -- TOTAL REVENUE WEIGHTED METRICS --
             (
-                coalesce(guest_revenue.total_guest_revenue_in_gbp, 0)
+                coalesce(guest_revenue.total_guest_income_in_gbp, 0)
+                + coalesce(invoicing.xero_waiver_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_operator_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_apis_net_fees_in_gbp, 0)
             )
             / nullif(bookings.created_bookings, 0) as total_revenue_per_created_booking,
             (
-                coalesce(guest_revenue.total_guest_revenue_in_gbp, 0)
+                coalesce(guest_revenue.total_guest_income_in_gbp, 0)
+                + coalesce(invoicing.xero_waiver_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_operator_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_apis_net_fees_in_gbp, 0)
             ) / nullif(
                 guest_journeys.created_guest_journeys, 0
             ) as total_revenue_per_created_guest_journey,
             (
-                coalesce(guest_revenue.total_guest_revenue_in_gbp, 0)
+                coalesce(guest_revenue.total_guest_income_in_gbp, 0)
+                + coalesce(invoicing.xero_waiver_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_operator_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_apis_net_fees_in_gbp, 0)
             ) / nullif(
                 deals.deals_booked_in_month, 0
             ) as total_revenue_per_deals_booked_in_month,
             (
-                coalesce(guest_revenue.total_guest_revenue_in_gbp, 0)
+                coalesce(guest_revenue.total_guest_income_in_gbp, 0)
+                + coalesce(invoicing.xero_waiver_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_operator_net_fees_in_gbp, 0)
                 + coalesce(invoicing.xero_apis_net_fees_in_gbp, 0)
             ) / nullif(
@@ -226,7 +247,11 @@ select
     {{ calculate_safe_relative_increment("xero_host_resolution_payment_count") }},
 
     -- GUEST REVENUE AND PAYMENTS --
+    {{ calculate_safe_relative_increment("deposit_fees_in_gbp") }},
+    {{ calculate_safe_relative_increment("waiver_payments_in_gbp") }},
+    {{ calculate_safe_relative_increment("checkin_cover_fees_in_gbp") }},
     {{ calculate_safe_relative_increment("total_guest_payments_in_gbp") }},
+    {{ calculate_safe_relative_increment("total_guest_income_in_gbp") }},
     {{ calculate_safe_relative_increment("total_guest_revenue_in_gbp") }},
 
     -- TOTAL REVENUE --