@hed-hog/finance 0.0.223 → 0.0.225

package/hedhog/query/constraints.sql

@@ -0,0 +1,169 @@
+-- Regras de integridade do módulo financeiro (PostgreSQL)
+-- Script idempotente: pode ser executado mais de uma vez.
+
+-- 1) CHECKs simples de domínio
+DO $$
+BEGIN
+	IF NOT EXISTS (
+		SELECT 1
+		FROM pg_constraint
+		WHERE conname = 'chk_financial_installment_open_amount_non_negative'
+	) THEN
+		ALTER TABLE financial_installment
+			ADD CONSTRAINT chk_financial_installment_open_amount_non_negative
+			CHECK (open_amount_cents >= 0);
+	END IF;
+
+	IF NOT EXISTS (
+		SELECT 1
+		FROM pg_constraint
+		WHERE conname = 'chk_financial_installment_open_amount_lte_amount'
+	) THEN
+		ALTER TABLE financial_installment
+			ADD CONSTRAINT chk_financial_installment_open_amount_lte_amount
+			CHECK (open_amount_cents <= amount_cents);
+	END IF;
+
+	IF NOT EXISTS (
+		SELECT 1
+		FROM pg_constraint
+		WHERE conname = 'chk_period_close_period_end_gte_start'
+	) THEN
+		ALTER TABLE period_close
+			ADD CONSTRAINT chk_period_close_period_end_gte_start
+			CHECK (period_end >= period_start);
+	END IF;
+END $$;
+
+-- 2) Unicidade em tabelas de vínculo N:N
+DO $$
+BEGIN
+	IF NOT EXISTS (
+		SELECT 1
+		FROM pg_constraint
+		WHERE conname = 'uq_financial_installment_tag_installment_tag'
+	) THEN
+		ALTER TABLE financial_installment_tag
+			ADD CONSTRAINT uq_financial_installment_tag_installment_tag
+			UNIQUE (installment_id, tag_id);
+	END IF;
+
+	IF NOT EXISTS (
+		SELECT 1
+		FROM pg_constraint
+		WHERE conname = 'uq_installment_allocation_installment_cost_center'
+	) THEN
+		ALTER TABLE installment_allocation
+			ADD CONSTRAINT uq_installment_allocation_installment_cost_center
+			UNIQUE (installment_id, cost_center_id);
+	END IF;
+
+	IF NOT EXISTS (
+		SELECT 1
+		FROM pg_constraint
+		WHERE conname = 'uq_settlement_allocation_settlement_installment'
+	) THEN
+		ALTER TABLE settlement_allocation
+			ADD CONSTRAINT uq_settlement_allocation_settlement_installment
+			UNIQUE (settlement_id, installment_id);
+	END IF;
+END $$;
+
+-- 3) Política de alocação por parcela (somatórios não podem exceder amount_cents)
+-- settlement_allocation: soma(allocated_amount_cents) por installment_id <= financial_installment.amount_cents
+
+CREATE OR REPLACE FUNCTION fn_check_settlement_allocation_total_per_installment()
+RETURNS TRIGGER
+LANGUAGE plpgsql
+AS $$
+DECLARE
+	target_installment_id financial_installment.id%TYPE;
+	installment_amount_cents integer;
+	allocated_total_cents bigint;
+BEGIN
+	target_installment_id := COALESCE(NEW.installment_id, OLD.installment_id);
+
+	SELECT fi.amount_cents
+	INTO installment_amount_cents
+	FROM financial_installment fi
+	WHERE fi.id = target_installment_id;
+
+	IF installment_amount_cents IS NULL THEN
+		RETURN NULL;
+	END IF;
+
+	SELECT COALESCE(SUM(sa.allocated_amount_cents), 0)
+	INTO allocated_total_cents
+	FROM settlement_allocation sa
+	WHERE sa.installment_id = target_installment_id;
+
+	IF allocated_total_cents > installment_amount_cents THEN
+		RAISE EXCEPTION
+			'Soma de settlement_allocation (%) excede amount_cents (%) para installment_id=%',
+			allocated_total_cents,
+			installment_amount_cents,
+			target_installment_id;
+	END IF;
+
+	RETURN NULL;
+END;
+$$;
+
+DROP TRIGGER IF EXISTS trg_check_settlement_allocation_total_per_installment
+ON settlement_allocation;
+
+CREATE CONSTRAINT TRIGGER trg_check_settlement_allocation_total_per_installment
+AFTER INSERT OR UPDATE OR DELETE
+ON settlement_allocation
+DEFERRABLE INITIALLY DEFERRED
+FOR EACH ROW
+EXECUTE FUNCTION fn_check_settlement_allocation_total_per_installment();
+
+-- installment_allocation: soma(allocated_amount_cents) por installment_id <= financial_installment.amount_cents
+
+CREATE OR REPLACE FUNCTION fn_check_installment_allocation_total_per_installment()
+RETURNS TRIGGER
+LANGUAGE plpgsql
+AS $$
+DECLARE
+	target_installment_id financial_installment.id%TYPE;
+	installment_amount_cents integer;
+	allocated_total_cents bigint;
+BEGIN
+	target_installment_id := COALESCE(NEW.installment_id, OLD.installment_id);
+
+	SELECT fi.amount_cents
+	INTO installment_amount_cents
+	FROM financial_installment fi
+	WHERE fi.id = target_installment_id;
+
+	IF installment_amount_cents IS NULL THEN
+		RETURN NULL;
+	END IF;
+
+	SELECT COALESCE(SUM(ia.allocated_amount_cents), 0)
+	INTO allocated_total_cents
+	FROM installment_allocation ia
+	WHERE ia.installment_id = target_installment_id;
+
+	IF allocated_total_cents > installment_amount_cents THEN
+		RAISE EXCEPTION
+			'Soma de installment_allocation (%) excede amount_cents (%) para installment_id=%',
+			allocated_total_cents,
+			installment_amount_cents,
+			target_installment_id;
+	END IF;
+
+	RETURN NULL;
+END;
+$$;
+
+DROP TRIGGER IF EXISTS trg_check_installment_allocation_total_per_installment
+ON installment_allocation;
+
+CREATE CONSTRAINT TRIGGER trg_check_installment_allocation_total_per_installment
+AFTER INSERT OR UPDATE OR DELETE
+ON installment_allocation
+DEFERRABLE INITIALLY DEFERRED
+FOR EACH ROW
+EXECUTE FUNCTION fn_check_installment_allocation_total_per_installment();

package/package.json

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

package/src/dto/create-financial-title.dto.ts

@@ -0,0 +1,142 @@
+import { getLocaleText } from '@hed-hog/api-locale';
+import { Type } from 'class-transformer';
+import {
+    IsArray,
+    IsDateString,
+    IsInt,
+    IsNotEmpty,
+    IsNumber,
+    IsOptional,
+    IsString,
+    Min,
+    ValidateNested,
+} from 'class-validator';
+
+export class CreateFinancialInstallmentDto {
+  @IsOptional()
+  @IsInt({
+    message: (args) =>
+      getLocaleText('validation.installmentNumberMustBeNumber', args.value),
+  })
+  @Min(1, {
+    message: (args) =>
+      getLocaleText('validation.installmentNumberMin', args.value),
+  })
+  installment_number?: number;
+
+  @IsDateString(
+    {},
+    {
+      message: (args) =>
+        getLocaleText('validation.dueDateMustBeDate', args.value),
+    },
+  )
+  due_date: string;
+
+  @IsNumber(
+    {},
+    {
+      message: (args) =>
+        getLocaleText('validation.installmentAmountMustBeNumber', args.value),
+    },
+  )
+  @Min(0.01, {
+    message: (args) =>
+      getLocaleText('validation.installmentAmountMin', args.value),
+  })
+  amount: number;
+}
+
+export class CreateFinancialTitleDto {
+  @IsString({
+    message: (args) => getLocaleText('validation.documentMustBeString', args.value),
+  })
+  @IsNotEmpty({
+    message: (args) => getLocaleText('validation.documentRequired', args.value),
+  })
+  document_number: string;
+
+  @IsInt({
+    message: (args) => getLocaleText('validation.personIdMustBeNumber', args.value),
+  })
+  person_id: number;
+
+  @IsOptional()
+  @IsDateString(
+    {},
+    {
+      message: (args) =>
+        getLocaleText('validation.competenceDateMustBeDate', args.value),
+    },
+  )
+  competence_date?: string;
+
+  @IsOptional()
+  @IsDateString(
+    {},
+    {
+      message: (args) =>
+        getLocaleText('validation.issueDateMustBeDate', args.value),
+    },
+  )
+  issue_date?: string;
+
+  @IsDateString(
+    {},
+    {
+      message: (args) =>
+        getLocaleText('validation.dueDateMustBeDate', args.value),
+    },
+  )
+  due_date: string;
+
+  @IsNumber(
+    {},
+    {
+      message: (args) =>
+        getLocaleText('validation.totalAmountMustBeNumber', args.value),
+    },
+  )
+  @Min(0.01, {
+    message: (args) =>
+      getLocaleText('validation.totalAmountMin', args.value),
+  })
+  total_amount: number;
+
+  @IsOptional()
+  @IsInt({
+    message: (args) =>
+      getLocaleText('validation.financeCategoryIdMustBeNumber', args.value),
+  })
+  finance_category_id?: number;
+
+  @IsOptional()
+  @IsInt({
+    message: (args) =>
+      getLocaleText('validation.costCenterIdMustBeNumber', args.value),
+  })
+  cost_center_id?: number;
+
+  @IsOptional()
+  @IsString({
+    message: (args) =>
+      getLocaleText('validation.paymentChannelMustBeString', args.value),
+  })
+  payment_channel?: string;
+
+  @IsOptional()
+  @IsString({
+    message: (args) =>
+      getLocaleText('validation.descriptionMustBeString', args.value),
+  })
+  description?: string;
+
+  @IsOptional()
+  @IsArray({
+    message: (args) =>
+      getLocaleText('validation.installmentsMustBeArray', args.value),
+  })
+  @ValidateNested({ each: true })
+  @Type(() => CreateFinancialInstallmentDto)
+  installments?: CreateFinancialInstallmentDto[];
+}

package/src/finance.controller.ts

@@ -0,0 +1,89 @@
+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,
+  Post,
+  Query,
+} from '@nestjs/common';
+import { CreateFinancialTitleDto } from './dto/create-financial-title.dto';
+import { FinanceService } from './finance.service';
+
+@Role()
+@Controller('finance')
+export class FinanceController {
+  constructor(private readonly financeService: FinanceService) {}
+
+  @Get('data')
+  async getData() {
+    return this.financeService.getData();
+  }
+
+  @Get('accounts-payable/installments')
+  async listAccountsPayableInstallments(
+    @Pagination() paginationParams,
+    @Query('status') status?: string,
+  ) {
+    return this.financeService.listAccountsPayableInstallments(
+      paginationParams,
+      status,
+    );
+  }
+
+  @Get('accounts-payable/installments/:id')
+  async getAccountsPayableInstallment(
+    @Param('id', ParseIntPipe) id: number,
+    @Locale() locale: string,
+  ) {
+    return this.financeService.getAccountsPayableInstallment(id, locale);
+  }
+
+  @Post('accounts-payable/installments')
+  async createAccountsPayableTitle(
+    @Body() data: CreateFinancialTitleDto,
+    @Locale() locale: string,
+    @User() user,
+  ) {
+    return this.financeService.createAccountsPayableTitle(
+      data,
+      locale,
+      user?.id,
+    );
+  }
+
+  @Get('accounts-receivable/installments')
+  async listAccountsReceivableInstallments(
+    @Pagination() paginationParams,
+    @Query('status') status?: string,
+  ) {
+    return this.financeService.listAccountsReceivableInstallments(
+      paginationParams,
+      status,
+    );
+  }
+
+  @Get('accounts-receivable/installments/:id')
+  async getAccountsReceivableInstallment(
+    @Param('id', ParseIntPipe) id: number,
+    @Locale() locale: string,
+  ) {
+    return this.financeService.getAccountsReceivableInstallment(id, locale);
+  }
+
+  @Post('accounts-receivable/installments')
+  async createAccountsReceivableTitle(
+    @Body() data: CreateFinancialTitleDto,
+    @Locale() locale: string,
+    @User() user,
+  ) {
+    return this.financeService.createAccountsReceivableTitle(
+      data,
+      locale,
+      user?.id,
+    );
+  }
+}

package/src/finance.module.ts

@@ -1,8 +1,10 @@
-import { forwardRef, Module } from '@nestjs/common';
-import { ConfigModule } from '@nestjs/config';
 import { LocaleModule } from '@hed-hog/api-locale';
 import { PaginationModule } from '@hed-hog/api-pagination';
 import { PrismaModule } from '@hed-hog/api-prisma';
+import { forwardRef, Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { FinanceController } from './finance.controller';
+import { FinanceService } from './finance.service';
 
 @Module({
   imports: [
@@ -10,6 +12,9 @@ import { PrismaModule } from '@hed-hog/api-prisma';
     forwardRef(() => PaginationModule),
     forwardRef(() => PrismaModule),
     forwardRef(() => LocaleModule)
-  ]
+  ],
+  controllers: [FinanceController],
+  providers: [FinanceService],
+  exports: [FinanceService],
 })
 export class FinanceModule {}