@hed-hog/finance 0.0.252 → 0.0.253

package/hedhog/query/settlement-auditability.sql

@@ -0,0 +1,175 @@
+-- Settlement auditability, reversal linkage and reconciliation helpers
+-- Idempotent script for PostgreSQL
+
+DO $$
+BEGIN
+  IF NOT EXISTS (
+    SELECT 1
+    FROM pg_type
+    WHERE typname = 'settlement_entry_type_enum'
+  ) THEN
+    CREATE TYPE settlement_entry_type_enum AS ENUM ('normal', 'reversal');
+  END IF;
+END $$;
+
+ALTER TABLE settlement
+  ADD COLUMN IF NOT EXISTS entry_type settlement_entry_type_enum;
+
+UPDATE settlement
+SET entry_type = 'normal'
+WHERE entry_type IS NULL;
+
+ALTER TABLE settlement
+  ALTER COLUMN entry_type SET DEFAULT 'normal';
+
+ALTER TABLE settlement
+  ALTER COLUMN entry_type SET NOT NULL;
+
+ALTER TABLE settlement
+  ADD COLUMN IF NOT EXISTS reverses_settlement_id INTEGER;
+
+DO $$
+BEGIN
+  IF NOT EXISTS (
+    SELECT 1
+    FROM pg_constraint
+    WHERE conname = 'fk_settlement_reverses_settlement'
+  ) THEN
+    ALTER TABLE settlement
+      ADD CONSTRAINT fk_settlement_reverses_settlement
+      FOREIGN KEY (reverses_settlement_id)
+      REFERENCES settlement(id)
+      ON DELETE RESTRICT
+      ON UPDATE CASCADE;
+  END IF;
+END $$;
+
+CREATE UNIQUE INDEX IF NOT EXISTS uq_settlement_reverses_settlement_id
+  ON settlement(reverses_settlement_id)
+  WHERE reverses_settlement_id IS NOT NULL;
+
+DO $$
+BEGIN
+  BEGIN
+    ALTER TABLE settlement
+      ALTER COLUMN amount_cents TYPE BIGINT USING amount_cents::BIGINT;
+  EXCEPTION
+    WHEN undefined_column THEN
+      NULL;
+  END;
+END $$;
+
+ALTER TABLE settlement_allocation
+  ADD COLUMN IF NOT EXISTS amount_cents BIGINT;
+
+UPDATE settlement_allocation
+SET amount_cents = allocated_amount_cents
+WHERE amount_cents IS NULL;
+
+ALTER TABLE settlement_allocation
+  ALTER COLUMN amount_cents SET NOT NULL;
+
+DO $$
+BEGIN
+  BEGIN
+    ALTER TABLE settlement_allocation
+      ALTER COLUMN allocated_amount_cents TYPE BIGINT USING allocated_amount_cents::BIGINT;
+  EXCEPTION
+    WHEN undefined_column THEN
+      NULL;
+  END;
+END $$;
+
+DO $$
+BEGIN
+  IF NOT EXISTS (
+    SELECT 1
+    FROM pg_constraint
+    WHERE conname = 'chk_settlement_allocation_amount_non_zero'
+  ) THEN
+    ALTER TABLE settlement_allocation
+      ADD CONSTRAINT chk_settlement_allocation_amount_non_zero
+      CHECK (amount_cents <> 0);
+  END IF;
+END $$;
+
+ALTER TABLE bank_reconciliation
+  ADD COLUMN IF NOT EXISTS reconciled_at TIMESTAMPTZ(6);
+
+ALTER TABLE bank_reconciliation
+  ADD COLUMN IF NOT EXISTS reconciled_by_user_id INTEGER;
+
+DO $$
+BEGIN
+  IF NOT EXISTS (
+    SELECT 1
+    FROM pg_constraint
+    WHERE conname = 'fk_bank_reconciliation_reconciled_by_user'
+  ) THEN
+    ALTER TABLE bank_reconciliation
+      ADD CONSTRAINT fk_bank_reconciliation_reconciled_by_user
+      FOREIGN KEY (reconciled_by_user_id)
+      REFERENCES "user"(id)
+      ON DELETE SET NULL
+      ON UPDATE CASCADE;
+  END IF;
+END $$;
+
+CREATE INDEX IF NOT EXISTS idx_settlement_settled_at
+  ON settlement(settled_at);
+
+CREATE INDEX IF NOT EXISTS idx_settlement_entry_type
+  ON settlement(entry_type);
+
+CREATE OR REPLACE FUNCTION fn_prevent_settlement_updates()
+RETURNS TRIGGER
+LANGUAGE plpgsql
+AS $$
+BEGIN
+  RAISE EXCEPTION 'Settlement is immutable. Create a reversal instead of updating settlement %', NEW.id;
+END;
+$$;
+
+DROP TRIGGER IF EXISTS trg_prevent_settlement_updates ON settlement;
+
+CREATE TRIGGER trg_prevent_settlement_updates
+BEFORE UPDATE ON settlement
+FOR EACH ROW
+EXECUTE FUNCTION fn_prevent_settlement_updates();
+
+CREATE OR REPLACE VIEW v_settlement_history AS
+SELECT
+  fi.title_id,
+  s.id AS settlement_id,
+  s.entry_type,
+  s.reverses_settlement_id,
+  CASE
+    WHEN s.entry_type = 'reversal' THEN s.reverses_settlement_id
+    ELSE s.id
+  END AS settlement_group_id,
+  s.settlement_type,
+  s.status,
+  s.settled_at,
+  s.amount_cents,
+  s.payment_method_id,
+  s.bank_account_id,
+  s.description,
+  s.external_reference,
+  s.created_by_user_id,
+  s.created_at,
+  s.updated_at,
+  sa.installment_id,
+  fi.installment_number,
+  sa.amount_cents AS allocation_amount_cents,
+  sa.discount_cents,
+  sa.interest_cents,
+  sa.penalty_cents,
+  br.id AS bank_reconciliation_id,
+  CASE
+    WHEN br.id IS NOT NULL THEN TRUE
+    ELSE FALSE
+  END AS reconciled
+FROM settlement s
+INNER JOIN settlement_allocation sa ON sa.settlement_id = s.id
+INNER JOIN financial_installment fi ON fi.id = sa.installment_id
+LEFT JOIN bank_reconciliation br ON br.settlement_id = s.id;

package/hedhog/table/bank_reconciliation.yaml

@@ -20,6 +20,9 @@ columns:
   - name: matched_at
     type: datetime
     isNullable: true
+  - name: reconciled_at
+    type: datetime
+    isNullable: true
   - name: matched_by_user_id
     type: fk
     isNullable: true
@@ -28,6 +31,14 @@ columns:
       column: id
       onDelete: SET NULL
       onUpdate: CASCADE
+  - name: reconciled_by_user_id
+    type: fk
+    isNullable: true
+    references:
+      table: user
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
   - type: created_at
   - type: updated_at
 

package/hedhog/table/settlement.yaml

@@ -27,6 +27,10 @@ columns:
   - name: settlement_type
     type: enum
     values: [payable, receivable, transfer, adjustment]
+  - name: entry_type
+    type: enum
+    values: [normal, reversal]
+    default: normal
   - name: status
     type: enum
     values: [pending, confirmed, reversed]
@@ -41,6 +45,14 @@ columns:
     type: varchar
     length: 120
     isNullable: true
+  - name: reverses_settlement_id
+    type: fk
+    isNullable: true
+    references:
+      table: settlement
+      column: id
+      onDelete: RESTRICT
+      onUpdate: CASCADE
   - name: created_by_user_id
     type: fk
     isNullable: true
@@ -55,4 +67,8 @@ columns:
 indices:
   - columns: [status]
   - columns: [settled_at]
-  - columns: [bank_account_id]
+  - columns: [bank_account_id]
+  - columns: [entry_type]
+  - columns: [settlement_type, settled_at]
+  - columns: [reverses_settlement_id]
+    isUnique: true

package/hedhog/table/settlement_allocation.yaml

@@ -16,6 +16,9 @@ columns:
       onUpdate: CASCADE
   - name: allocated_amount_cents
     type: int
+  - name: amount_cents
+    type: int
+    isNullable: true
   - name: discount_cents
     type: int
     default: 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hed-hog/finance",
-  "version": "0.0.252",
+  "version": "0.0.253",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
@@ -9,14 +9,14 @@
     "@nestjs/core": "^11",
     "@nestjs/jwt": "^11",
     "@nestjs/mapped-types": "*",
-    "@hed-hog/api-prisma": "0.0.4",
-    "@hed-hog/contact": "0.0.251",
     "@hed-hog/api-pagination": "0.0.5",
+    "@hed-hog/contact": "0.0.251",
     "@hed-hog/tag": "0.0.251",
     "@hed-hog/api-locale": "0.0.11",
+    "@hed-hog/api-prisma": "0.0.4",
     "@hed-hog/api-types": "0.0.1",
-    "@hed-hog/core": "0.0.251",
-    "@hed-hog/api": "0.0.3"
+    "@hed-hog/api": "0.0.3",
+    "@hed-hog/core": "0.0.251"
   },
   "exports": {
     ".": {

package/src/dto/reverse-settlement.dto.ts

@@ -4,4 +4,8 @@ export class ReverseSettlementDto {
   @IsOptional()
   @IsString()
   reason?: string;
+
+  @IsOptional()
+  @IsString()
+  memo?: string;
 }

package/src/finance-installments.controller.ts

@@ -2,22 +2,24 @@ import { Role, User } from '@hed-hog/api';
 import { Locale } from '@hed-hog/api-locale';
 import { Pagination } from '@hed-hog/api-pagination';
 import {
-  Body,
-  Controller,
-  Get,
-  Param,
-  ParseIntPipe,
-  Patch,
-  Post,
-  Query,
-  UploadedFile,
-  UseInterceptors,
+    Body,
+    Controller,
+    Delete,
+    Get,
+    Param,
+    ParseIntPipe,
+    Patch,
+    Post,
+    Query,
+    UploadedFile,
+    UseInterceptors,
 } from '@nestjs/common';
 import { FileInterceptor } from '@nestjs/platform-express';
 import { CreateFinanceTagDto } from './dto/create-finance-tag.dto';
 import { CreateFinancialTitleDto } from './dto/create-financial-title.dto';
 import { ExtractFinancialTitleFromFileDto } from './dto/extract-financial-title-from-file.dto';
 import { RejectTitleDto } from './dto/reject-title.dto';
+import { ReverseSettlementDto } from './dto/reverse-settlement.dto';
 import { FinanceService } from './finance.service';
 
 import { UpdateInstallmentTagsDto } from './dto/update-installment-tags.dto';
@@ -45,6 +47,14 @@ export class FinanceInstallmentsController {
     return this.financeService.getAccountsPayableInstallment(id, locale);
   }
 
+  @Get('titles/:id/settlements-history')
+  async getTitleSettlementsHistory(
+    @Param('id', ParseIntPipe) id: number,
+    @Locale() locale: string,
+  ) {
+    return this.financeService.getTitleSettlementsHistory(id, locale);
+  }
+
   @Post('accounts-payable/installments')
   async createAccountsPayableTitle(
     @Body() data: CreateFinancialTitleDto,
@@ -131,7 +141,7 @@ export class FinanceInstallmentsController {
   async reverseAccountsPayableSettlement(
     @Param('id', ParseIntPipe) id: number,
     @Param('settlementId', ParseIntPipe) settlementId: number,
-    @Body() data,
+    @Body() data: ReverseSettlementDto,
     @Locale() locale: string,
     @User() user,
   ) {
@@ -144,6 +154,29 @@ export class FinanceInstallmentsController {
     );
   }
 
+  @Post('settlements/:id/reverse')
+  async reverseSettlement(
+    @Param('id', ParseIntPipe) settlementId: number,
+    @Body() data: ReverseSettlementDto,
+    @Locale() locale: string,
+    @User() user,
+  ) {
+    return this.financeService.reverseSettlementById(
+      settlementId,
+      data,
+      locale,
+      user?.id,
+    );
+  }
+
+  @Delete('bank-reconciliations/:id')
+  async unreconcileBankReconciliation(
+    @Param('id', ParseIntPipe) id: number,
+    @User() user,
+  ) {
+    return this.financeService.unreconcileBankReconciliation(id, user?.id);
+  }
+
   @Patch('accounts-payable/installments/:id/tags')
   async updateAccountsPayableInstallmentTags(
     @Param('id', ParseIntPipe) id: number,
@@ -260,7 +293,7 @@ export class FinanceInstallmentsController {
   async reverseAccountsReceivableSettlement(
     @Param('id', ParseIntPipe) id: number,
     @Param('settlementId', ParseIntPipe) settlementId: number,
-    @Body() data,
+    @Body() data: ReverseSettlementDto,
     @Locale() locale: string,
     @User() user,
   ) {