feat: Add payment type and reference

app/models/invoice.rb

@@ -483,6 +483,7 @@ def status_changed_to_finalized?
 #  taxes_rate                              :float            default(0.0), not null
 #  timezone                                :string           default("UTC"), not null
 #  total_amount_cents                      :bigint           default(0), not null
+#  total_paid_amount_cents                 :bigint           default(0), not null
 #  version_number                          :integer          default(4), not null
 #  voided_at                               :datetime
 #  created_at                              :datetime         not null

app/models/payment.rb

@@ -32,7 +32,9 @@ def should_sync_payment?
 #  amount_currency              :string           not null
 #  payable_payment_status       :enum
 #  payable_type                 :string           default("Invoice"), not null
+#  payment_type                 :enum             default("provider"), not null
 #  provider_payment_data        :jsonb
+#  reference                    :string
 #  status                       :string           not null
 #  created_at                   :datetime         not null
 #  updated_at                   :datetime         not null

db/migrate/20241224141116_add_payment_type_and_reference_to_payments.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class AddPaymentTypeAndReferenceToPayments < ActiveRecord::Migration[7.1]
+  disable_ddl_transaction!
+
+  def up
+    create_enum :payment_type, %w[provider manual]
+
+    safety_assured do
+      change_table :payments, bulk: true do |t|
+        t.column :payment_type, :enum, enum_type: 'payment_type', null: true
+        t.column :reference, :string, default: nil
+      end
+    end
+
+    # Backfill existing records
+    Payment.in_batches(of: 10_000).update_all(payment_type: 'provider') # rubocop:disable Rails/SkipsModelValidations
+
+    safety_assured do
+      execute <<~SQL
+        ALTER TABLE payments ALTER COLUMN payment_type SET DEFAULT 'provider';
+      SQL
+      execute <<~SQL
+        ALTER TABLE payments ALTER COLUMN payment_type SET NOT NULL;
+      SQL
+    end
+  end
+
+  def down
+    change_table :payments, bulk: true do |t|
+      t.remove :payment_type
+      t.remove :reference
+    end
+
+    drop_enum :payment_type
+  end
+end

db/migrate/20241224142141_add_total_paid_amount_cents_to_invoices.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class AddTotalPaidAmountCentsToInvoices < ActiveRecord::Migration[7.1]
+  disable_ddl_transaction!
+
+  def up
+    add_column :invoices, :total_paid_amount_cents, :bigint, null: true, default: 0
+    # Backfill
+    Invoice.in_batches(of: 10_000).each do |batch|
+      batch.update_all(total_paid_amount_cents: 0) # rubocop:disable Rails/SkipsModelValidations
+    end
+
+    safety_assured do
+      execute <<~SQL
+        ALTER TABLE invoices ALTER COLUMN total_paid_amount_cents SET DEFAULT 0;
+      SQL
+      execute <<~SQL
+        ALTER TABLE invoices ALTER COLUMN total_paid_amount_cents SET NOT NULL;
+      SQL
+    end
+  end
+
+  def down
+    # Remove the column
+    remove_column :invoices, :total_paid_amount_cents
+  end
+end