@tailor-platform/erp-kit 0.7.0 → 0.8.0

package/src/modules/accounting/docs/queries/ListCostCenters.md

@@ -0,0 +1,55 @@
+# ListCostCenters
+
+## Overview
+
+ListCostCenters retrieves a list of cost center records matching optional filter criteria. Callers can filter by companyId, category (overhead, production, administration, sales, research), and hierarchyNodeId to find cost centers assigned to a specific node in the hierarchy. This query supports cost center browsing, allocation rule setup, and budget planning.
+
+## Business Rules
+
+- Accepts optional filter parameters: `{ companyId, category, hierarchyNodeId }`
+- Returns a list of cost centers matching all provided filters (AND logic)
+- When no filters are provided, returns all cost centers accessible to the caller
+- Each returned cost center includes all master data fields and hierarchy node assignment
+- Returns an empty list if no cost centers match the given filters
+- Results are scoped to the caller's accessible companies
+
+## Process Flow
+
+```mermaid
+flowchart TD
+    A[Receive input with optional filters] --> B[Build query with provided filters]
+    B --> C{companyId provided?}
+    C -->|Yes| D[Add companyId filter]
+    C -->|No| E[Skip companyId filter]
+    D --> F{category provided?}
+    E --> F
+    F -->|Yes| G[Add category filter]
+    F -->|No| H[Skip category filter]
+    G --> I{hierarchyNodeId provided?}
+    H --> I
+    I -->|Yes| J[Add hierarchyNodeId filter]
+    I -->|No| K[Skip hierarchyNodeId filter]
+    J --> L[Execute query]
+    K --> L
+    L --> M[Return list of matching cost centers]
+```
+
+## External Dependencies
+
+- None
+
+## Error Scenarios
+
+- **INVALID_CATEGORY_FILTER**: Provided category value is not a recognized cost center category
+- **HIERARCHY_NODE_NOT_FOUND**: Provided hierarchyNodeId does not reference an existing hierarchy node
+
+## Test Cases
+
+- returns all cost centers when no filters are provided
+- returns cost centers filtered by companyId
+- returns cost centers filtered by category
+- returns cost centers filtered by hierarchyNodeId
+- returns cost centers matching multiple filters simultaneously
+- returns an empty list when no cost centers match the given filters
+- returns error when category filter is invalid
+- returns error when hierarchyNodeId does not exist

package/src/modules/accounting/docs/queries/ListCostElements.md

@@ -0,0 +1,63 @@
+# ListCostElements
+
+## Overview
+
+ListCostElements retrieves a list of cost element records matching optional filter criteria. Callers can filter by companyId, type (PRIMARY or SECONDARY), category (overhead, material, labor, depreciation for primary; assessment, distribution, internal_activity_allocation, settlement for secondary), and status (DRAFT, ACTIVE, INACTIVE). This query supports cost element catalog browsing, allocation rule configuration, and budget line item setup.
+
+## Business Rules
+
+- Accepts optional filter parameters: `{ companyId, type, category, status }`
+- Returns a list of cost elements matching all provided filters (AND logic)
+- When no filters are provided, returns all cost elements accessible to the caller
+- Each returned cost element includes all fields (code, name, type, category, status, validity period, GL account reference, companyId, description)
+- Returns an empty list if no cost elements match the given filters
+- Results are scoped to the caller's accessible companies
+
+## Process Flow
+
+```mermaid
+flowchart TD
+    A[Receive input with optional filters] --> B[Build query with provided filters]
+    B --> C{companyId provided?}
+    C -->|Yes| D[Add companyId filter]
+    C -->|No| E[Skip companyId filter]
+    D --> F{type provided?}
+    E --> F
+    F -->|Yes| G[Add type filter]
+    F -->|No| H[Skip type filter]
+    G --> I{category provided?}
+    H --> I
+    I -->|Yes| J[Add category filter]
+    I -->|No| K[Skip category filter]
+    J --> L{status provided?}
+    K --> L
+    L -->|Yes| M[Add status filter]
+    L -->|No| N[Skip status filter]
+    M --> O[Execute query]
+    N --> O
+    O --> P[Return list of matching cost elements]
+```
+
+## External Dependencies
+
+- None
+
+## Error Scenarios
+
+- **INVALID_TYPE_FILTER**: Provided type value is not PRIMARY or SECONDARY
+- **INVALID_STATUS_FILTER**: Provided status value is not DRAFT, ACTIVE, or INACTIVE
+- **INVALID_CATEGORY_FILTER**: Provided category value is not a recognized cost element category
+
+## Test Cases
+
+- returns all cost elements when no filters are provided
+- returns cost elements filtered by companyId
+- returns cost elements filtered by type PRIMARY
+- returns cost elements filtered by type SECONDARY
+- returns cost elements filtered by category
+- returns cost elements filtered by status ACTIVE
+- returns cost elements matching multiple filters simultaneously
+- returns an empty list when no cost elements match the given filters
+- returns error when type filter is invalid
+- returns error when status filter is invalid
+- returns error when category filter is invalid

package/src/modules/accounting/docs/queries/ListInternalOrders.md

@@ -0,0 +1,62 @@
+# ListInternalOrders
+
+## Overview
+
+ListInternalOrders retrieves a list of internal order records matching optional filter criteria. Callers can filter by companyId, orderType (OVERHEAD, INVESTMENT, ACCRUAL), status (CREATED, RELEASED, TECHNICALLY_COMPLETED, CLOSED), and costCenterId to find orders assigned to a specific responsible cost center. This query supports internal order browsing, project portfolio review, and cost posting target selection.
+
+## Business Rules
+
+- Accepts optional filter parameters: `{ companyId, orderType, status, costCenterId }`
+- Returns a list of internal orders matching all provided filters (AND logic)
+- When no filters are provided, returns all internal orders accessible to the caller
+- Each returned internal order includes all header fields, responsible cost center reference, and budget assignment
+- Returns an empty list if no internal orders match the given filters
+- Results are scoped to the caller's accessible companies
+
+## Process Flow
+
+```mermaid
+flowchart TD
+    A[Receive input with optional filters] --> B[Build query with provided filters]
+    B --> C{companyId provided?}
+    C -->|Yes| D[Add companyId filter]
+    C -->|No| E[Skip companyId filter]
+    D --> F{orderType provided?}
+    E --> F
+    F -->|Yes| G[Add orderType filter]
+    F -->|No| H[Skip orderType filter]
+    G --> I{status provided?}
+    H --> I
+    I -->|Yes| J[Add status filter]
+    I -->|No| K[Skip status filter]
+    J --> L{costCenterId provided?}
+    K --> L
+    L -->|Yes| M[Add costCenterId filter]
+    L -->|No| N[Skip costCenterId filter]
+    M --> O[Execute query]
+    N --> O
+    O --> P[Return list of matching internal orders]
+```
+
+## External Dependencies
+
+- None
+
+## Error Scenarios
+
+- **INVALID_ORDER_TYPE_FILTER**: Provided orderType value is not OVERHEAD, INVESTMENT, or ACCRUAL
+- **INVALID_STATUS_FILTER**: Provided status value is not CREATED, RELEASED, TECHNICALLY_COMPLETED, or CLOSED
+- **COST_CENTER_NOT_FOUND**: Provided costCenterId does not reference an existing cost center
+
+## Test Cases
+
+- returns all internal orders when no filters are provided
+- returns internal orders filtered by companyId
+- returns internal orders filtered by orderType OVERHEAD
+- returns internal orders filtered by status RELEASED
+- returns internal orders filtered by costCenterId
+- returns internal orders matching multiple filters simultaneously
+- returns an empty list when no internal orders match the given filters
+- returns error when orderType filter is invalid
+- returns error when status filter is invalid
+- returns error when costCenterId does not exist

package/src/modules/accounting/docs/queries/ListProfitCenters.md

@@ -0,0 +1,49 @@
+# ListProfitCenters
+
+## Overview
+
+ListProfitCenters retrieves a list of profit center records matching optional filter criteria. Callers can filter by companyId and status (DRAFT, ACTIVE, INACTIVE). This query supports profit center browsing, transaction tagging setup, and profitability reporting configuration.
+
+## Business Rules
+
+- Accepts optional filter parameters: `{ companyId, status }`
+- Returns a list of profit centers matching all provided filters (AND logic)
+- When no filters are provided, returns all profit centers accessible to the caller
+- Each returned profit center includes all master data fields and hierarchy node assignment
+- Returns an empty list if no profit centers match the given filters
+- Results are scoped to the caller's accessible companies
+
+## Process Flow
+
+```mermaid
+flowchart TD
+    A[Receive input with optional filters] --> B[Build query with provided filters]
+    B --> C{companyId provided?}
+    C -->|Yes| D[Add companyId filter]
+    C -->|No| E[Skip companyId filter]
+    D --> F{status provided?}
+    E --> F
+    F -->|Yes| G[Add status filter]
+    F -->|No| H[Skip status filter]
+    G --> I[Execute query]
+    H --> I
+    I --> J[Return list of matching profit centers]
+```
+
+## External Dependencies
+
+- None
+
+## Error Scenarios
+
+- **INVALID_STATUS_FILTER**: Provided status value is not DRAFT, ACTIVE, or INACTIVE
+
+## Test Cases
+
+- returns all profit centers when no filters are provided
+- returns profit centers filtered by companyId
+- returns profit centers filtered by status ACTIVE
+- returns profit centers filtered by status DRAFT
+- returns profit centers matching companyId and status filters simultaneously
+- returns an empty list when no profit centers match the given filters
+- returns error when status filter is invalid

package/src/modules/accounting/generated/enums.ts

@@ -0,0 +1,110 @@
+/**
+ * Allocation type
+ */
+export const AllocationCycleAllocationType = {
+  "ASSESSMENT": "ASSESSMENT",
+  "DISTRIBUTION": "DISTRIBUTION"
+} as const;
+export type AllocationCycleAllocationType = (typeof AllocationCycleAllocationType)[keyof typeof AllocationCycleAllocationType];
+
+/**
+ * Allocation cycle lifecycle status
+ */
+export const AllocationCycleStatus = {
+  "DRAFT": "DRAFT",
+  "VALIDATED": "VALIDATED",
+  "EXECUTED": "EXECUTED",
+  "POSTED": "POSTED",
+  "REVERSED": "REVERSED"
+} as const;
+export type AllocationCycleStatus = (typeof AllocationCycleStatus)[keyof typeof AllocationCycleStatus];
+
+/**
+ * Budget lifecycle status
+ */
+export const BudgetStatus = {
+  "DRAFT": "DRAFT",
+  "SUBMITTED": "SUBMITTED",
+  "APPROVED": "APPROVED",
+  "ACTIVE": "ACTIVE",
+  "CLOSED": "CLOSED"
+} as const;
+export type BudgetStatus = (typeof BudgetStatus)[keyof typeof BudgetStatus];
+
+/**
+ * Cost element type
+ */
+export const CostElementType = {
+  "PRIMARY": "PRIMARY",
+  "SECONDARY": "SECONDARY"
+} as const;
+export type CostElementType = (typeof CostElementType)[keyof typeof CostElementType];
+
+/**
+ * Cost element lifecycle status
+ */
+export const CostElementStatus = {
+  "DRAFT": "DRAFT",
+  "ACTIVE": "ACTIVE",
+  "INACTIVE": "INACTIVE"
+} as const;
+export type CostElementStatus = (typeof CostElementStatus)[keyof typeof CostElementStatus];
+
+/**
+ * Internal order type
+ */
+export const InternalOrderOrderType = {
+  "OVERHEAD": "OVERHEAD",
+  "INVESTMENT": "INVESTMENT",
+  "ACCRUAL": "ACCRUAL"
+} as const;
+export type InternalOrderOrderType = (typeof InternalOrderOrderType)[keyof typeof InternalOrderOrderType];
+
+/**
+ * Internal order lifecycle status
+ */
+export const InternalOrderStatus = {
+  "CREATED": "CREATED",
+  "RELEASED": "RELEASED",
+  "TECHNICALLY_COMPLETED": "TECHNICALLY_COMPLETED",
+  "CLOSED": "CLOSED"
+} as const;
+export type InternalOrderStatus = (typeof InternalOrderStatus)[keyof typeof InternalOrderStatus];
+
+/**
+ * Plan version type
+ */
+export const PlanVersionType = {
+  "BUDGET": "BUDGET",
+  "FORECAST": "FORECAST",
+  "SIMULATION": "SIMULATION"
+} as const;
+export type PlanVersionType = (typeof PlanVersionType)[keyof typeof PlanVersionType];
+
+/**
+ * Profit center lifecycle status
+ */
+export const ProfitCenterStatus = {
+  "DRAFT": "DRAFT",
+  "ACTIVE": "ACTIVE",
+  "INACTIVE": "INACTIVE"
+} as const;
+export type ProfitCenterStatus = (typeof ProfitCenterStatus)[keyof typeof ProfitCenterStatus];
+
+/**
+ * Variance report lifecycle status
+ */
+export const VarianceReportStatus = {
+  "DRAFT": "DRAFT",
+  "FINAL": "FINAL"
+} as const;
+export type VarianceReportStatus = (typeof VarianceReportStatus)[keyof typeof VarianceReportStatus];
+
+/**
+ * Direction of the variance
+ */
+export const VarianceReportLineVarianceDirection = {
+  "FAVORABLE": "FAVORABLE",
+  "UNFAVORABLE": "UNFAVORABLE"
+} as const;
+export type VarianceReportLineVarianceDirection = (typeof VarianceReportLineVarianceDirection)[keyof typeof VarianceReportLineVarianceDirection];

package/src/modules/accounting/generated/kysely-tailordb.ts

@@ -0,0 +1,302 @@
+import {
+  createGetDB,
+  type Generated,
+  type Timestamp,
+  type NamespaceDB,
+  type NamespaceInsertable,
+  type NamespaceSelectable,
+  type NamespaceTable,
+  type NamespaceTableName,
+  type NamespaceTransaction,
+  type NamespaceUpdateable,
+} from "@tailor-platform/sdk/kysely";
+
+export interface Namespace {
+  "main-db": {
+    AllocationCycle: {
+      id: Generated<string>;
+      name: string;
+      allocationType: "ASSESSMENT" | "DISTRIBUTION";
+      companyId: string;
+      accountingPeriodId: string;
+      status: "DRAFT" | "VALIDATED" | "EXECUTED" | "POSTED" | "REVERSED";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    AllocationResult: {
+      id: Generated<string>;
+      allocationCycleId: string;
+      senderCostCenterId: string;
+      receiverType: string;
+      receiverId: string;
+      allocatedAmount: number;
+      costElementId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    AllocationRule: {
+      id: Generated<string>;
+      allocationCycleId: string;
+      senderCostCenterId: string;
+      receiverType: string;
+      receiverId: string;
+      percentage: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Budget: {
+      id: Generated<string>;
+      name: string;
+      description: string | null;
+      budgetHolderId: string;
+      fiscalYearId: string;
+      companyId: string;
+      costObjectType: string;
+      costObjectId: string;
+      planVersionId: string;
+      totalAmount: number;
+      rejectionReason: string | null;
+      status: "DRAFT" | "SUBMITTED" | "APPROVED" | "ACTIVE" | "CLOSED";
+      createdByUserId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    BudgetLineItem: {
+      id: Generated<string>;
+      budgetId: string;
+      costElementId: string;
+      accountingPeriodId: string;
+      glAccountId: string | null;
+      plannedAmount: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Commitment: {
+      id: Generated<string>;
+      costElementId: string;
+      costObjectType: string;
+      costObjectId: string;
+      accountingPeriodId: string;
+      amount: number;
+      consumedAmount: number;
+      purchaseOrderId: string;
+      companyId: string;
+      status: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    CostCenter: {
+      id: Generated<string>;
+      code: string;
+      name: string;
+      description: string | null;
+      category: string;
+      responsiblePersonId: string | null;
+      departmentId: string | null;
+      companyId: string;
+      hierarchyNodeId: string;
+      validFrom: Timestamp;
+      validTo: Timestamp | null;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    CostCenterHierarchy: {
+      id: Generated<string>;
+      name: string;
+      version: string;
+      companyId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    CostCenterHierarchyNode: {
+      id: Generated<string>;
+      name: string;
+      hierarchyId: string;
+      parentNodeId: string | null;
+      sortOrder: number;
+      level: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    CostElement: {
+      id: Generated<string>;
+      code: string;
+      name: string;
+      type: "PRIMARY" | "SECONDARY";
+      category: string;
+      description: string | null;
+      glAccountId: string | null;
+      companyId: string;
+      validFrom: Timestamp | null;
+      validTo: Timestamp | null;
+      status: "DRAFT" | "ACTIVE" | "INACTIVE";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    InternalOrder: {
+      id: Generated<string>;
+      orderNumber: string;
+      orderType: "OVERHEAD" | "INVESTMENT" | "ACCRUAL";
+      description: string;
+      responsiblePersonId: string;
+      costCenterId: string;
+      companyId: string;
+      validFrom: Timestamp | null;
+      validTo: Timestamp | null;
+      status: "CREATED" | "RELEASED" | "TECHNICALLY_COMPLETED" | "CLOSED";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    PlanVersion: {
+      id: Generated<string>;
+      name: string;
+      type: "BUDGET" | "FORECAST" | "SIMULATION";
+      baseVersionId: string | null;
+      companyId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ProfitCenter: {
+      id: Generated<string>;
+      code: string;
+      name: string;
+      description: string | null;
+      responsiblePersonId: string | null;
+      companyId: string;
+      validFrom: Timestamp;
+      validTo: Timestamp | null;
+      status: "DRAFT" | "ACTIVE" | "INACTIVE";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ProfitCenterHierarchy: {
+      id: Generated<string>;
+      name: string;
+      companyId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ProfitCenterHierarchyAssignment: {
+      id: Generated<string>;
+      profitCenterId: string;
+      hierarchyId: string;
+      hierarchyNodeId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ProfitCenterHierarchyNode: {
+      id: Generated<string>;
+      name: string;
+      hierarchyId: string;
+      parentNodeId: string | null;
+      sortOrder: number;
+      level: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    VarianceReport: {
+      id: Generated<string>;
+      costObjectType: string;
+      costObjectId: string;
+      accountingPeriodId: string;
+      companyId: string;
+      totalPlanned: number;
+      totalActual: number;
+      totalVariance: number;
+      status: "DRAFT" | "FINAL";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    VarianceReportLine: {
+      id: Generated<string>;
+      varianceReportId: string;
+      costElementId: string;
+      accountingPeriodId: string;
+      plannedAmount: number;
+      actualAmount: number;
+      varianceAmount: number;
+      variancePercentage: number;
+      varianceDirection: "FAVORABLE" | "UNFAVORABLE";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Account: {
+      id: Generated<string>;
+      code: string | null;
+      name: string | null;
+      classification: string | null;
+      status: string | null;
+      chartOfAccountsId: string | null;
+    }
+
+    AccountingPeriod: {
+      id: Generated<string>;
+      companyId: string | null;
+      fiscalYearId: string | null;
+      status: string | null;
+    }
+
+    ChartOfAccounts: {
+      id: Generated<string>;
+      companyId: string | null;
+      status: string | null;
+    }
+
+    Company: {
+      id: Generated<string>;
+      status: string | null;
+    }
+
+    Department: {
+      id: Generated<string>;
+      name: string | null;
+    }
+
+    FiscalYear: {
+      id: Generated<string>;
+      companyId: string | null;
+    }
+
+    PurchaseOrder: {
+      id: Generated<string>;
+      status: string | null;
+    }
+
+    User: {
+      id: Generated<string>;
+      status: string | null;
+    }
+  }
+}
+
+export const getDB = createGetDB<Namespace>();
+
+export type DB<N extends keyof Namespace = keyof Namespace> = NamespaceDB<Namespace, N>;
+
+export type Transaction<K extends keyof Namespace | DB = keyof Namespace> =
+  NamespaceTransaction<Namespace, K>;
+
+type TableName = NamespaceTableName<Namespace>;
+export type Table<T extends TableName> = NamespaceTable<Namespace, T>;
+
+export type Insertable<T extends TableName> = NamespaceInsertable<Namespace, T>;
+export type Selectable<T extends TableName> = NamespaceSelectable<Namespace, T>;
+export type Updateable<T extends TableName> = NamespaceUpdateable<Namespace, T>;

package/src/modules/accounting/index.ts

@@ -0,0 +1,2 @@
+export { defineModule } from "./module";
+export { permissions, own, all } from "./lib/permissions.generated";