feat(manual-payments): Add services

app/controllers/api/v1/payments_controller.rb

@@ -4,7 +4,7 @@ module Api
   module V1
     class PaymentsController < Api::BaseController
       def create
-        result = ManualPayments::CreateService.call(
+        result = Payments::ManualCreateService.call(
           organization: current_organization,
           params: create_params.to_h.deep_symbolize_keys
         )

app/graphql/types/invoices/object.rb

@@ -36,6 +36,7 @@ class Object < Types::BaseObject
       field :sub_total_including_taxes_amount_cents, GraphQL::Types::BigInt, null: false
       field :taxes_amount_cents, GraphQL::Types::BigInt, null: false
       field :total_amount_cents, GraphQL::Types::BigInt, null: false
+      field :total_due_amount_cents, GraphQL::Types::BigInt, null: false
 
       field :issuing_date, GraphQL::Types::ISO8601Date, null: false
       field :payment_due_date, GraphQL::Types::ISO8601Date, null: false

app/jobs/payments/manual_create_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payments
+  class ManualCreateJob < ApplicationJob
+    queue_as "low_priority"
+
+    def perform(organization:, params:)
+      Payments::ManualCreateService.call!(organization:, params:)
+    end
+  end
+end

app/models/invoice.rb

@@ -50,12 +50,14 @@ class Invoice < ApplicationRecord
     :sub_total_excluding_taxes_amount_cents,
     :sub_total_including_taxes_amount_cents,
     :total_amount_cents,
+    :total_paid_amount_cents,
     :taxes_amount_cents,
     with_model_currency: :currency
 
   # NOTE: Readonly fields
   monetize :charge_amount_cents,
     :subscription_amount_cents,
+    :total_due_amount_cents,
     disable_validation: true,
     allow_nil: true,
     with_model_currency: :currency
@@ -257,6 +259,10 @@ def charge_pay_in_advance_proration_range(fee, timestamp)
     }
   end
 
+  def total_due_amount_cents
+    total_amount_cents - total_paid_amount_cents
+  end
+
   # amount cents onto which we can issue a credit note
   def available_to_credit_amount_cents
     return 0 if version_number < CREDIT_NOTES_MIN_VERSION || draft?
@@ -292,7 +298,13 @@ def creditable_amount_cents
   def refundable_amount_cents
     return 0 if version_number < CREDIT_NOTES_MIN_VERSION || draft? || !payment_succeeded?
 
-    amount = available_to_credit_amount_cents -
+    # base_amount = if credit?
+    #   available_to_credit_amount_cents
+    # else
+    #   total_paid_amount_cents - credit_notes.sum("refund_amount_cents + credit_amount_cents")
+    # end
+
+    amount = total_paid_amount_cents - credit_notes.sum("refund_amount_cents + credit_amount_cents") -
       credits.where(before_taxes: false).sum(:amount_cents) -
       prepaid_credit_amount_cents
     amount = amount.negative? ? 0 : amount

app/models/organization.rb

@@ -75,6 +75,7 @@ class Organization < ApplicationRecord
     api_permissions
     revenue_share
     zero_amount_fees
+    manual_payments
   ].freeze
   PREMIUM_INTEGRATIONS = INTEGRATIONS - %w[anrok]
 

app/models/payment.rb

@@ -18,6 +18,7 @@ class Payment < ApplicationRecord
   validates :payment_type, presence: true
   validates :reference, presence: true, length: {maximum: 40}, if: -> { payment_type_manual? }
   validates :reference, absence: true, if: -> { payment_type_provider? }
+  validate :manual_payment_credit_invoice_amount_cents
   validate :max_invoice_paid_amount_cents, on: :create
   validate :payment_request_succeeded, on: :create
 
@@ -52,6 +53,13 @@ def should_sync_payment?
 
   private
 
+  def manual_payment_credit_invoice_amount_cents
+    return if !payable.is_a?(Invoice) || payment_type_provider? || !payable.credit?
+    return if amount_cents == payable.total_amount_cents
+
+    errors.add(:amount_cents, :invalid_amount)
+  end
+
   def max_invoice_paid_amount_cents
     return if !payable.is_a?(Invoice) || payment_type_provider?
     return if amount_cents + payable.total_paid_amount_cents <= payable.total_amount_cents
@@ -92,7 +100,7 @@ def payment_request_succeeded
 # Indexes
 #
 #  index_payments_on_invoice_id                    (invoice_id)
-#  index_payments_on_payable_id_and_payable_type   (payable_id,payable_type) UNIQUE WHERE (payable_payment_status = ANY (ARRAY['pending'::payment_payable_payment_status, 'processing'::payment_payable_payment_status]))
+#  index_payments_on_payable_id_and_payable_type   (payable_id,payable_type) UNIQUE WHERE ((payable_payment_status = ANY (ARRAY['pending'::payment_payable_payment_status, 'processing'::payment_payable_payment_status])) AND (payment_type = 'provider'::payment_type))
 #  index_payments_on_payable_type_and_payable_id   (payable_type,payable_id)
 #  index_payments_on_payment_provider_customer_id  (payment_provider_customer_id)
 #  index_payments_on_payment_provider_id           (payment_provider_id)

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

@@ -25,6 +25,7 @@ def create_body
                   'lago_invoice_payment_status' => invoice.payment_status,
                   'lago_invoice_currency' => invoice.currency,
                   'lago_invoice_total_amount' => total_amount,
+                  'lago_invoice_total_due_amount' => total_due_amount,
                   'lago_invoice_subtotal_excluding_taxes' => subtotal_excluding_taxes,
                   'lago_invoice_file_url' => invoice.file_url
                 }
@@ -52,6 +53,7 @@ def update_body
                   'lago_invoice_payment_status' => invoice.payment_status,
                   'lago_invoice_currency' => invoice.currency,
                   'lago_invoice_total_amount' => total_amount,
+                  'lago_invoice_total_due_amount' => total_due_amount,
                   'lago_invoice_subtotal_excluding_taxes' => subtotal_excluding_taxes,
                   'lago_invoice_file_url' => invoice.file_url
                 }
@@ -75,6 +77,10 @@ def total_amount
             amount(invoice.total_amount_cents, resource: invoice)
           end
 
+          def total_due_amount
+            amount(invoice.total_due_amount_cents, resource: invoice)
+          end
+
           def subtotal_excluding_taxes
             amount(invoice.sub_total_excluding_taxes_amount_cents, resource: invoice)
           end

app/services/integrations/hubspot/invoices/deploy_properties_service.rb

@@ -4,7 +4,7 @@ module Integrations
   module Hubspot
     module Invoices
       class DeployPropertiesService < Integrations::Aggregator::BaseService
-        VERSION = 1
+        VERSION = 2
 
         def action_path
           "v1/hubspot/properties"
@@ -46,10 +46,10 @@ def payload
             inputs: [
               {
                 groupName: "lagoinvoices_information",
-                name: "example",
-                label: "example label",
-                type: "string",
-                fieldType: "text"
+                name: "lago_invoice_total_due_amount",
+                label: "Lago Invoice Total Due Amount",
+                type: "number",
+                fieldType: "number"
               }
             ]
           }

app/services/invoices/advance_charges_service.rb

@@ -22,6 +22,7 @@ def call
 
       if invoice && !invoice.closed?
         SendWebhookJob.perform_later('invoice.created', invoice)
+        create_manual_payment(invoice)
         Invoices::GeneratePdfAndNotifyJob.perform_later(invoice:, email: false)
         Integrations::Aggregator::Invoices::CreateJob.perform_later(invoice:) if invoice.should_sync_invoice?
         Integrations::Aggregator::Invoices::Hubspot::CreateJob.perform_later(invoice:) if invoice.should_sync_hubspot_invoice?
@@ -51,6 +52,16 @@ def has_charges_with_statement?
       Charge.where(plan_id: plan_ids, pay_in_advance: true, invoiceable: false, regroup_paid_fees: :invoice).any?
     end
 
+    def create_manual_payment(invoice)
+      amount_cents = invoice.total_amount_cents
+      reference = I18n.t("invoice.charges_paid_in_advance")
+      created_at = invoice.created_at
+
+      params = {invoice_id: invoice.id, amount_cents:, reference:, created_at:}
+
+      ::Payments::ManualCreateJob.perform_later(organization:, params:)
+    end
+
     def create_group_invoice
       invoice = nil
 

app/services/invoices/payments/adyen_service.rb

@@ -72,7 +72,7 @@ def create_payment(provider_payment_id:, metadata:)
           payable: invoice,
           payment_provider_id: adyen_payment_provider.id,
           payment_provider_customer_id: customer.adyen_customer.id,
-          amount_cents: invoice.total_amount_cents,
+          amount_cents: invoice.total_due_amount_cents,
           amount_currency: invoice.currency.upcase,
           provider_payment_id:
         )
@@ -177,12 +177,19 @@ def payment_url_params
       end
 
       def update_invoice_payment_status(payment_status:, deliver_webhook: true)
+        params = {
+          payment_status:,
+          ready_for_payment_processing: payment_status.to_sym != :succeeded
+        }
+
+        if payment_status.to_sym == :succeeded
+          total_paid_amount_cents = invoice.payments.where(payable_payment_status: :succeeded).sum(:amount_cents)
+          params[:total_paid_amount_cents] = total_paid_amount_cents
+        end
+
         result = Invoices::UpdateService.call(
           invoice:,
-          params: {
-            payment_status:,
-            ready_for_payment_processing: payment_status.to_sym != :succeeded
-          },
+          params:,
           webhook_notification: deliver_webhook
         )
         result.raise_if_error!

app/services/invoices/payments/cashfree_service.rb

@@ -66,7 +66,7 @@ def create_payment(cashfree_payment)
           payable: @invoice,
           payment_provider_id: cashfree_payment_provider.id,
           payment_provider_customer_id: customer.cashfree_customer.id,
-          amount_cents: @invoice.total_amount_cents,
+          amount_cents: @invoice.total_due_amount_cents,
           amount_currency: @invoice.currency,
           provider_payment_id: cashfree_payment.id
         )
@@ -138,12 +138,20 @@ def payment_url_params
 
       def update_invoice_payment_status(payment_status:, deliver_webhook: true)
         @invoice = result.invoice
+
+        params = {
+          payment_status:,
+          ready_for_payment_processing: payment_status.to_sym != :succeeded
+        }
+
+        if payment_status.to_sym == :succeeded
+          total_paid_amount_cents = invoice.payments.where(payable_payment_status: :succeeded).sum(:amount_cents)
+          params[:total_paid_amount_cents] = total_paid_amount_cents
+        end
+
         result = Invoices::UpdateService.call(
           invoice:,
-          params: {
-            payment_status:,
-            ready_for_payment_processing: payment_status.to_sym != :succeeded
-          },
+          params:,
           webhook_notification: deliver_webhook
         )
         result.raise_if_error!

app/services/invoices/payments/create_service.rb

@@ -33,7 +33,7 @@ def call
         payment ||= Payment.create_with(
           payment_provider_id: current_payment_provider.id,
           payment_provider_customer_id: current_payment_provider_customer.id,
-          amount_cents: invoice.total_amount_cents,
+          amount_cents: invoice.total_due_amount_cents,
           amount_currency: invoice.currency,
           status: "pending"
         ).find_or_create_by!(
@@ -114,13 +114,20 @@ def current_payment_provider_customer
       end
 
       def update_invoice_payment_status(payment_status:)
+        params = {
+          # NOTE: A proper `processing` payment status should be introduced for invoices
+          payment_status: (payment_status.to_s == "processing") ? :pending : payment_status,
+          ready_for_payment_processing: %w[pending failed].include?(payment_status.to_s)
+        }
+
+        if payment_status.to_s == "succeeded"
+          total_paid_amount_cents = invoice.payments.where(payable_payment_status: :succeeded).sum(:amount_cents)
+          params[:total_paid_amount_cents] = total_paid_amount_cents
+        end
+
         Invoices::UpdateService.call!(
-          invoice: invoice,
-          params: {
-            # NOTE: A proper `processing` payment status should be introduced for invoices
-            payment_status: (payment_status.to_s == "processing") ? :pending : payment_status,
-            ready_for_payment_processing: %w[pending failed].include?(payment_status.to_s)
-          },
+          invoice:,
+          params:,
           webhook_notification: payment_status.to_sym == :succeeded
         )
       end

app/services/invoices/payments/gocardless_service.rb

@@ -41,12 +41,19 @@ def update_payment_status(provider_payment_id:, status:)
       delegate :organization, :customer, to: :invoice
 
       def update_invoice_payment_status(payment_status:, deliver_webhook: true)
+        params = {
+          payment_status:,
+          ready_for_payment_processing: payment_status.to_sym != :succeeded
+        }
+
+        if payment_status.to_sym == :succeeded
+          total_paid_amount_cents = result.invoice.payments.where(payable_payment_status: :succeeded).sum(:amount_cents)
+          params[:total_paid_amount_cents] = total_paid_amount_cents
+        end
+
         update_invoice_result = Invoices::UpdateService.call(
           invoice: result.invoice,
-          params: {
-            payment_status:,
-            ready_for_payment_processing: payment_status.to_sym != :succeeded
-          },
+          params:,
           webhook_notification: deliver_webhook
         )
         update_invoice_result.raise_if_error!

app/services/invoices/payments/stripe_service.rb

@@ -85,7 +85,7 @@ def create_payment(stripe_payment, invoice: nil)
           payable: @invoice,
           payment_provider_id: stripe_payment_provider.id,
           payment_provider_customer_id: customer.stripe_customer.id,
-          amount_cents: @invoice.total_amount_cents,
+          amount_cents: @invoice.total_due_amount_cents,
           amount_currency: @invoice.currency,
           status: "pending"
         )
@@ -153,13 +153,20 @@ def description
       end
 
       def update_invoice_payment_status(payment_status:, deliver_webhook: true, processing: false)
+        params = {
+          payment_status:,
+          # NOTE: A proper `processing` payment status should be introduced for invoices
+          ready_for_payment_processing: !processing && payment_status.to_sym != :succeeded
+        }
+
+        if payment_status.to_sym == :succeeded
+          total_paid_amount_cents = (invoice.presence || @result.invoice).payments.where(payable_payment_status: :succeeded).sum(:amount_cents)
+          params[:total_paid_amount_cents] = total_paid_amount_cents
+        end
+
         result = Invoices::UpdateService.call(
           invoice: invoice.presence || @result.invoice,
-          params: {
-            payment_status:,
-            # NOTE: A proper `processing` payment status should be introduced for invoices
-            ready_for_payment_processing: !processing && payment_status.to_sym != :succeeded
-          },
+          params:,
           webhook_notification: deliver_webhook
         )
         result.raise_if_error!

app/services/invoices/update_service.rb

@@ -39,6 +39,10 @@ def call
         invoice.ready_for_payment_processing = params[:ready_for_payment_processing]
       end
 
+      if params.key?(:total_paid_amount_cents) && params[:total_paid_amount_cents].present?
+        invoice.total_paid_amount_cents = params[:total_paid_amount_cents]
+      end
+
       ActiveRecord::Base.transaction do
         if invoice.payment_overdue? && invoice.payment_succeeded?
           invoice.payment_overdue = false

app/services/payment_requests/create_service.rb

@@ -18,7 +18,7 @@ def call
         customer.payment_requests.create!(
           organization:,
           dunning_campaign:,
-          amount_cents: invoices.sum(:total_amount_cents),
+          amount_cents: invoices.sum('total_amount_cents - total_paid_amount_cents'),
           amount_currency: currency,
           email:,
           invoices:

app/services/payment_requests/payments/adyen_service.rb

@@ -5,6 +5,7 @@ module Payments
     class AdyenService < BaseService
       include Lago::Adyen::ErrorHandlable
       include Customers::PaymentProviderFinder
+      include Updatable
 
       def initialize(payable = nil)
         @payable = payable
@@ -51,6 +52,7 @@ def update_payment_status(provider_payment_id:, status:, metadata: {})
 
         update_payable_payment_status(payment_status: payable_payment_status)
         update_invoices_payment_status(payment_status: payable_payment_status)
+        update_invoices_paid_amount_cents(payment_status: payable_payment_status)
         reset_customer_dunning_campaign_status(payable_payment_status)
 
         PaymentRequestMailer.with(payment_request: payment.payable).requested.deliver_later if result.payable.payment_failed?

app/services/payment_requests/payments/cashfree_service.rb

@@ -4,6 +4,7 @@ module PaymentRequests
   module Payments
     class CashfreeService < BaseService
       include Customers::PaymentProviderFinder
+      include Updatable
 
       PENDING_STATUSES = %w[PARTIALLY_PAID].freeze
       SUCCESS_STATUSES = %w[PAID].freeze
@@ -47,6 +48,7 @@ def update_payment_status(organization_id:, status:, cashfree_payment:)
 
         update_payable_payment_status(payment_status: payable_payment_status)
         update_invoices_payment_status(payment_status: payable_payment_status)
+        update_invoices_paid_amount_cents(payment_status: payable_payment_status)
         reset_customer_dunning_campaign_status(payable_payment_status)
 
         PaymentRequestMailer.with(payment_request: payment.payable).requested.deliver_later if result.payable.payment_failed?