feat(integration): Update billing entity mappings in integration payload

Author: groyoh

app/services/fees/create_pay_in_advance_service.rb

@@ -232,7 +232,7 @@ def apply_provider_taxes(fees_result)
       taxes_result
     end
 
-    FakeInvoice = Data.define(:id, :issuing_date, :currency, :customer)
+    FakeInvoice = Data.define(:id, :issuing_date, :currency, :customer, :billing_entity)
 
     def invoice
       result.invoice_id = SecureRandom.uuid
@@ -241,7 +241,8 @@ def invoice
         id: result.invoice_id,
         issuing_date: Time.current.in_time_zone(customer.applicable_timezone).to_date,
         currency: subscription.plan.amount_currency,
-        customer:
+        customer:,
+        billing_entity: customer.billing_entity
       )
     end
 

app/services/integrations/aggregator/base_payload.rb

@@ -13,52 +13,45 @@ def initialize(result, code:)
         end
       end
 
-      def initialize(integration:)
+      def initialize(integration:, billing_entity:)
         @integration = integration
+        @billing_entity = billing_entity
       end
 
       def billable_metric_item(fee)
-        integration
-          .integration_mappings
-          .find_by(mappable_type: "BillableMetric", mappable_id: fee.billable_metric.id) || fallback_item
+        lookup_mapping("BillableMetric", fee.billable_metric.id)
       end
 
       def add_on_item(fee)
-        integration
-          .integration_mappings
-          .find_by(mappable_type: "AddOn", mappable_id: fee.add_on_id) || fallback_item
+        lookup_mapping("AddOn", fee.add_on_id)
       end
 
       def account_item
-        @account_item ||= collection_mapping(:account) || fallback_item
+        lookup_collection_mapping(:account)
       end
 
       def tax_item
-        @tax_item ||= collection_mapping(:tax)
+        lookup_collection_mapping(:tax, with_fallback_item: false)
       end
 
       def commitment_item
-        @commitment_item ||= collection_mapping(:minimum_commitment) || fallback_item
+        lookup_collection_mapping(:minimum_commitment)
       end
 
       def subscription_item
-        @subscription_item ||= collection_mapping(:subscription_fee) || fallback_item
+        lookup_collection_mapping(:subscription_fee)
       end
 
       def coupon_item
-        @coupon_item ||= collection_mapping(:coupon) || fallback_item
+        lookup_collection_mapping(:coupon)
       end
 
       def credit_item
-        @credit_item ||= collection_mapping(:prepaid_credit) || fallback_item
+        lookup_collection_mapping(:prepaid_credit)
       end
 
       def credit_note_item
-        @credit_note_item ||= collection_mapping(:credit_note) || fallback_item
-      end
-
-      def fallback_item
-        @fallback_item ||= collection_mapping(:fallback_item)
+        lookup_collection_mapping(:credit_note)
       end
 
       def amount(amount_cents, resource:)
@@ -67,13 +60,46 @@ def amount(amount_cents, resource:)
         amount_cents.round.fdiv(currency.subunit_to_unit)
       end
 
-      def collection_mapping(type)
-        integration.integration_collection_mappings.where(mapping_type: type)&.first
+      private
+
+      attr_reader :integration, :billing_entity
+
+      def fallback_item(scope)
+        mappings = integration.integration_collection_mappings
+        fallback_items = mappings.filter { |mapping| mapping.mapping_type.to_sym == :fallback_item }
+        if scope == :billing_entity && billing_entity
+          return fallback_items.find { |mapping| mapping.billing_entity_id == billing_entity.id }
+        end
+
+        fallback_items.find { |mapping| mapping.billing_entity_id.nil? }
       end
 
-      private
+      def lookup_collection_mapping(mapping_type, with_fallback_item: true)
+        mappings = integration.integration_collection_mappings
+        matching_mappings = mappings.filter { |mapping| mapping.mapping_type.to_sym == mapping_type.to_sym }
+        billing_entity_mapping = matching_mappings.find { |mapping| mapping.billing_entity_id == billing_entity.id }
+        organization_mapping = matching_mappings.find { |mapping| mapping.billing_entity_id.nil? }
+        if with_fallback_item
+          return billing_entity_mapping ||
+              fallback_item(:billing_entity) ||
+              organization_mapping ||
+              fallback_item(:organization)
+        end
 
-      attr_reader :integration
+        billing_entity_mapping ||
+          organization_mapping
+      end
+
+      def lookup_mapping(mappable_type, mappable_id)
+        mappings = integration.integration_mappings
+        matching_mappings = mappings.filter { |mapping| mapping.mappable_type == mappable_type && mapping.mappable_id == mappable_id }
+        billing_entity_mapping = matching_mappings.find { |mapping| mapping.billing_entity_id == billing_entity.id }
+        organization_mapping = matching_mappings.find { |mapping| mapping.billing_entity_id.nil? }
+        billing_entity_mapping ||
+          fallback_item(:billing_entity) ||
+          organization_mapping ||
+          fallback_item(:organization)
+      end
 
       def tax_item_complete?
         tax_item&.tax_nexus.present? && tax_item&.tax_type.present? && tax_item&.tax_code.present?

app/services/integrations/aggregator/contacts/payloads/base_payload.rb

@@ -6,7 +6,7 @@ module Contacts
       module Payloads
         class BasePayload < Integrations::Aggregator::BasePayload
           def initialize(integration:, customer:, integration_customer: nil, subsidiary_id: nil)
-            super(integration:)
+            super(integration:, billing_entity: customer.billing_entity)
 
             @customer = customer
             @integration_customer = integration_customer

app/services/integrations/aggregator/credit_notes/payloads/base_payload.rb

@@ -6,7 +6,7 @@ module CreditNotes
       module Payloads
         class BasePayload < Integrations::Aggregator::BasePayload
           def initialize(integration_customer:, credit_note:)
-            super(integration: integration_customer.integration)
+            super(integration: integration_customer.integration, billing_entity: credit_note.customer.billing_entity)
 
             @credit_note = credit_note
             @integration_customer = integration_customer

app/services/integrations/aggregator/invoices/payloads/base_payload.rb

@@ -6,7 +6,7 @@ module Invoices
       module Payloads
         class BasePayload < Integrations::Aggregator::BasePayload
           def initialize(integration_customer:, invoice:)
-            super(integration: integration_customer.integration)
+            super(integration: integration_customer.integration, billing_entity: integration_customer.customer.billing_entity)
 
             @invoice = invoice
             @integration_customer = integration_customer

app/services/integrations/aggregator/payments/payloads/base_payload.rb

@@ -6,7 +6,7 @@ module Payments
       module Payloads
         class BasePayload < Integrations::Aggregator::BasePayload
           def initialize(integration:, payment:)
-            super(integration:)
+            super(integration:, billing_entity: payment.payable.customer.billing_entity)
 
             @payment = payment
           end

app/services/integrations/aggregator/subscriptions/payloads/base_payload.rb

@@ -6,7 +6,7 @@ module Subscriptions
       module Payloads
         class BasePayload < Integrations::Aggregator::BasePayload
           def initialize(integration_customer:, subscription:)
-            super(integration: integration_customer.integration)
+            super(integration: integration_customer.integration, billing_entity: subscription.customer.billing_entity)
 
             @subscription = subscription
             @integration_customer = integration_customer

app/services/integrations/aggregator/taxes/credit_notes/payloads/anrok.rb

@@ -7,7 +7,7 @@ module CreditNotes
         module Payloads
           class Anrok < BasePayload
             def initialize(integration:, customer:, integration_customer:, credit_note:)
-              super(integration:)
+              super(integration:, billing_entity: customer.billing_entity)
 
               @customer = customer
               @integration_customer = integration_customer

app/services/integrations/aggregator/taxes/credit_notes/payloads/avalara.rb

@@ -7,7 +7,7 @@ module CreditNotes
         module Payloads
           class Avalara < BasePayload
             def initialize(integration:, customer:, integration_customer:, credit_note:)
-              super(integration:)
+              super(integration:, billing_entity: customer.billing_entity)
 
               @customer = customer
               @integration_customer = integration_customer

app/services/integrations/aggregator/taxes/invoices/payloads/anrok.rb

@@ -7,7 +7,7 @@ module Invoices
         module Payloads
           class Anrok < BasePayload
             def initialize(integration:, customer:, invoice:, integration_customer:, fees: [])
-              super(integration:)
+              super(integration:, billing_entity: customer.billing_entity)
 
               @customer = customer
               @integration_customer = integration_customer