@hed-hog/finance 0.0.2

package/hedhog/table/bank_reconciliation.yaml

@@ -0,0 +1,39 @@
+columns:
+  - type: pk
+  - name: bank_statement_line_id
+    type: fk
+    references:
+      table: bank_statement_line
+      column: id
+      onDelete: RESTRICT
+      onUpdate: CASCADE
+  - name: settlement_id
+    type: fk
+    references:
+      table: settlement
+      column: id
+      onDelete: RESTRICT
+      onUpdate: CASCADE
+  - name: status
+    type: enum
+    values: [pending, reconciled, reversed, adjusted]
+  - name: matched_at
+    type: datetime
+    isNullable: true
+  - name: matched_by_user_id
+    type: fk
+    isNullable: true
+    references:
+      table: user
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [bank_statement_line_id]
+    isUnique: true
+  - columns: [settlement_id]
+    isUnique: true
+  - columns: [status]

package/hedhog/table/bank_statement.yaml

@@ -0,0 +1,40 @@
+columns:
+  - type: pk
+  - name: bank_account_id
+    type: fk
+    references:
+      table: bank_account
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: source_type
+    type: enum
+    values: [ofx, csv, manual]
+  - name: idempotency_key
+    type: varchar
+    length: 120
+    isNullable: true
+  - name: period_start
+    type: datetime
+    isNullable: true
+  - name: period_end
+    type: datetime
+    isNullable: true
+  - name: imported_at
+    type: datetime
+  - name: imported_by_user_id
+    type: fk
+    isNullable: true
+    references:
+      table: user
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [bank_account_id]
+  - columns: [bank_account_id, imported_at]
+  - columns: [idempotency_key]
+    isUnique: true

package/hedhog/table/bank_statement_line.yaml

@@ -0,0 +1,41 @@
+columns:
+  - type: pk
+  - name: bank_statement_id
+    type: fk
+    references:
+      table: bank_statement
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: bank_account_id
+    type: fk
+    references:
+      table: bank_account
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: external_id
+    type: varchar
+    length: 120
+    isNullable: true
+  - name: posted_date
+    type: datetime
+  - name: amount_cents
+    type: int
+  - name: description
+    type: text
+  - name: status
+    type: enum
+    values: [imported, pending, reconciled, reversed, adjusted]
+  - name: dedupe_key
+    type: varchar
+    length: 180
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [bank_account_id]
+  - columns: [bank_account_id, posted_date]
+  - columns: [bank_account_id, status]
+  - columns: [dedupe_key]
+    isUnique: true

package/hedhog/table/branch.yaml

@@ -0,0 +1,18 @@
+columns:
+  - type: pk
+  - name: code
+    type: varchar
+    length: 32
+  - name: name
+    type: varchar
+    length: 180
+  - name: status
+    type: enum
+    values: [active, inactive]
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [code]
+    isUnique: true
+  - columns: [status]

package/hedhog/table/cashflow_projection.yaml

@@ -0,0 +1,26 @@
+columns:
+  - type: pk
+  - name: scenario_id
+    type: fk
+    references:
+      table: forecast_scenario
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: projection_date
+    type: datetime
+  - name: projection_type
+    type: enum
+    values: [inflow, outflow, net]
+  - name: amount_cents
+    type: int
+  - name: notes
+    type: text
+    isNullable: true
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [scenario_id]
+  - columns: [scenario_id, projection_date]
+  - columns: [projection_type]

package/hedhog/table/company_profile.yaml

@@ -0,0 +1,23 @@
+columns:
+  - type: pk
+  - name: code
+    type: varchar
+    length: 32
+  - name: status
+    type: enum
+    values: [active, inactive]
+  - name: default_currency
+    type: char
+    length: 3
+    default: BRL
+  - name: timezone
+    type: varchar
+    length: 64
+    default: America/Sao_Paulo
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [code]
+    isUnique: true
+  - columns: [status]

package/hedhog/table/cost_center.yaml

@@ -0,0 +1,18 @@
+columns:
+  - type: pk
+  - name: code
+    type: varchar
+    length: 64
+  - name: name
+    type: varchar
+    length: 180
+  - name: status
+    type: enum
+    values: [active, inactive]
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [code]
+    isUnique: true
+  - columns: [status]

package/hedhog/table/finance_category.yaml

@@ -0,0 +1,29 @@
+columns:
+  - type: pk
+  - name: parent_id
+    type: fk
+    isNullable: true
+    references:
+      table: finance_category
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: code
+    type: varchar
+    length: 64
+  - name: name
+    type: varchar
+    length: 180
+  - name: kind
+    type: enum
+    values: [revenue, expense, transfer, adjustment, other]
+  - name: status
+    type: enum
+    values: [active, inactive]
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [code]
+    isUnique: true
+  - columns: [status]

package/hedhog/table/financial_installment.yaml

@@ -0,0 +1,34 @@
+columns:
+  - type: pk
+  - name: title_id
+    type: fk
+    references:
+      table: financial_title
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: installment_number
+    type: int
+  - name: competence_date
+    type: datetime
+  - name: due_date
+    type: datetime
+  - name: amount_cents
+    type: int
+  - name: open_amount_cents
+    type: int
+  - name: status
+    type: enum
+    values: [open, partial, settled, canceled, overdue]
+  - name: notes
+    type: text
+    isNullable: true
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [title_id, installment_number]
+    isUnique: true
+  - columns: [status]
+  - columns: [due_date]
+  - columns: [competence_date]

package/hedhog/table/financial_installment_tag.yaml

@@ -0,0 +1,23 @@
+columns:
+  - type: pk
+  - name: installment_id
+    type: fk
+    references:
+      table: financial_installment
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: tag_id
+    type: fk
+    references:
+      table: tag
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [installment_id, tag_id]
+    isUnique: true
+  - columns: [tag_id]

package/hedhog/table/financial_title.yaml

@@ -0,0 +1,61 @@
+columns:
+  - type: pk
+  - name: branch_id
+    type: fk
+    isNullable: true
+    references:
+      table: branch
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: person_id
+    type: fk
+    references:
+      table: person
+      column: id
+      onDelete: RESTRICT
+      onUpdate: CASCADE
+  - name: title_type
+    type: enum
+    values: [payable, receivable]
+  - name: status
+    type: enum
+    values: [draft, approved, open, partial, settled, canceled, overdue]
+  - name: document_number
+    type: varchar
+    length: 80
+    isNullable: true
+  - name: description
+    type: text
+    isNullable: true
+  - name: competence_date
+    type: datetime
+    isNullable: true
+  - name: issue_date
+    type: datetime
+    isNullable: true
+  - name: total_amount_cents
+    type: int
+  - name: finance_category_id
+    type: fk
+    isNullable: true
+    references:
+      table: finance_category
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: created_by_user_id
+    type: fk
+    isNullable: true
+    references:
+      table: user
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [title_type, status]
+  - columns: [person_id]
+  - columns: [competence_date]

package/hedhog/table/financial_title_attachment.yaml

@@ -0,0 +1,32 @@
+columns:
+  - type: pk
+  - name: title_id
+    type: fk
+    references:
+      table: financial_title
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: file_id
+    type: fk
+    references:
+      table: file
+      column: id
+      onDelete: RESTRICT
+      onUpdate: CASCADE
+  - name: uploaded_by_user_id
+    type: fk
+    isNullable: true
+    references:
+      table: user
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [title_id]
+  - columns: [file_id]
+  - columns: [title_id, file_id]
+    isUnique: true

package/hedhog/table/forecast_scenario.yaml

@@ -0,0 +1,18 @@
+columns:
+  - type: pk
+  - name: name
+    type: varchar
+    length: 120
+  - name: status
+    type: enum
+    values: [active, inactive]
+  - name: is_default
+    type: boolean
+    default: false
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [name]
+    isUnique: true
+  - columns: [status]

package/hedhog/table/installment_allocation.yaml

@@ -0,0 +1,26 @@
+columns:
+  - type: pk
+  - name: installment_id
+    type: fk
+    references:
+      table: financial_installment
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: cost_center_id
+    type: fk
+    references:
+      table: cost_center
+      column: id
+      onDelete: RESTRICT
+      onUpdate: CASCADE
+  - name: allocated_amount_cents
+    type: int
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [installment_id]
+  - columns: [cost_center_id]
+  - columns: [installment_id, cost_center_id]
+    isUnique: true

package/hedhog/table/payment_method.yaml

@@ -0,0 +1,21 @@
+columns:
+  - type: pk
+  - name: code
+    type: varchar
+    length: 32
+  - name: name
+    type: varchar
+    length: 120
+  - name: type
+    type: enum
+    values: [pix, boleto, ted, doc, card, cash, other]
+  - name: status
+    type: enum
+    values: [active, inactive]
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [code]
+    isUnique: true
+  - columns: [status]

package/hedhog/table/period_close.yaml

@@ -0,0 +1,30 @@
+columns:
+  - type: pk
+  - name: period_start
+    type: datetime
+  - name: period_end
+    type: datetime
+  - name: status
+    type: enum
+    values: [open, closed]
+  - name: closed_at
+    type: datetime
+    isNullable: true
+  - name: closed_by_user_id
+    type: fk
+    isNullable: true
+    references:
+      table: user
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: notes
+    type: text
+    isNullable: true
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [period_start, period_end]
+    isUnique: true
+  - columns: [status]

package/hedhog/table/receivable_schedule.yaml

@@ -0,0 +1,31 @@
+columns:
+  - type: pk
+  - name: scenario_id
+    type: fk
+    references:
+      table: forecast_scenario
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: person_id
+    type: fk
+    isNullable: true
+    references:
+      table: person
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: expected_date
+    type: datetime
+  - name: amount_cents
+    type: int
+  - name: description
+    type: text
+    isNullable: true
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [scenario_id]
+  - columns: [scenario_id, expected_date]
+  - columns: [person_id]

package/hedhog/table/settlement.yaml

@@ -0,0 +1,66 @@
+columns:
+  - type: pk
+  - name: branch_id
+    type: fk
+    isNullable: true
+    references:
+      table: branch
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: person_id
+    type: fk
+    isNullable: true
+    references:
+      table: person
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: bank_account_id
+    type: fk
+    isNullable: true
+    references:
+      table: bank_account
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: payment_method_id
+    type: fk
+    isNullable: true
+    references:
+      table: payment_method
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - name: settlement_type
+    type: enum
+    values: [payable, receivable, transfer, adjustment]
+  - name: status
+    type: enum
+    values: [pending, confirmed, reversed]
+  - name: settled_at
+    type: datetime
+  - name: amount_cents
+    type: int
+  - name: description
+    type: text
+    isNullable: true
+  - name: external_reference
+    type: varchar
+    length: 120
+    isNullable: true
+  - name: created_by_user_id
+    type: fk
+    isNullable: true
+    references:
+      table: user
+      column: id
+      onDelete: SET NULL
+      onUpdate: CASCADE
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [status]
+  - columns: [settled_at]
+  - columns: [bank_account_id]

package/hedhog/table/settlement_allocation.yaml

@@ -0,0 +1,35 @@
+columns:
+  - type: pk
+  - name: settlement_id
+    type: fk
+    references:
+      table: settlement
+      column: id
+      onDelete: CASCADE
+      onUpdate: CASCADE
+  - name: installment_id
+    type: fk
+    references:
+      table: financial_installment
+      column: id
+      onDelete: RESTRICT
+      onUpdate: CASCADE
+  - name: allocated_amount_cents
+    type: int
+  - name: discount_cents
+    type: int
+    default: 0
+  - name: interest_cents
+    type: int
+    default: 0
+  - name: penalty_cents
+    type: int
+    default: 0
+  - type: created_at
+  - type: updated_at
+
+indices:
+  - columns: [settlement_id]
+  - columns: [installment_id]
+  - columns: [settlement_id, installment_id]
+    isUnique: true

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@hed-hog/finance",
+  "version": "0.0.2",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "@nestjs/common": "*",
+    "@nestjs/config": "^4.0.2",
+    "@nestjs/core": "^11",
+    "@nestjs/jwt": "^11",
+    "@nestjs/mapped-types": "*",
+    "@hed-hog/api-locale": "0.0.11",
+    "@hed-hog/api": "0.0.3",
+    "@hed-hog/api-pagination": "0.0.5",
+    "@hed-hog/api-prisma": "0.0.4",
+    "@hed-hog/contact": "0.0.222",
+    "@hed-hog/api-types": "0.0.1",
+    "@hed-hog/tag": "0.0.222"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "hedhog"
+  ],
+  "scripts": {
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
+    "prebuild": "pnpm exec ts-node ../../scripts/build-dependencies.ts libraries/finance",
+    "build": "tsc --project tsconfig.production.json",
+    "patch": "pnpm exec ts-node ../../scripts/patch.ts libraries/finance",
+    "prod": "pnpm run patch && pnpm run build && pnpm publish --access public --no-git-checks"
+  }
+}

package/src/finance.module.ts

@@ -0,0 +1,15 @@
+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';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot(),
+    forwardRef(() => PaginationModule),
+    forwardRef(() => PrismaModule),
+    forwardRef(() => LocaleModule)
+  ]
+})
+export class FinanceModule {}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './finance.module';