@silexpert/core 1.3.152 → 1.3.153

package/ts/api/resources/Revenue.ts

@@ -0,0 +1,81 @@
+import { Resource } from '../Resource';
+import {
+  IGetRevenueMovementsRequest,
+  IGetRevenueSnapshotsRequest,
+  IGetArrSummaryResponse,
+  ICreateRevenueMovementRequest,
+  IUpdateRevenueMovementRequest,
+} from '../../types';
+
+export class Revenue extends Resource {
+  /**
+   * Récupérer les mouvements de revenu
+   */
+  public movements = {
+    getAll: (params: IGetRevenueMovementsRequest) => {
+      return this.axios.$get('/revenue/movements', { params });
+    },
+
+    get: (id: number) => {
+      return this.axios.$get(`/revenue/movements/${id}`);
+    },
+
+    create: (data: ICreateRevenueMovementRequest) => {
+      return this.axios.$post('/revenue/movements', data);
+    },
+
+    update: (id: number, data: IUpdateRevenueMovementRequest) => {
+      return this.axios.$put(`/revenue/movements/${id}`, data);
+    },
+
+    delete: (id: number) => {
+      return this.axios.$delete(`/revenue/movements/${id}`);
+    },
+  };
+
+  /**
+   * Récupérer les snapshots de revenu
+   */
+  public snapshots = {
+    getAll: (params: IGetRevenueSnapshotsRequest) => {
+      return this.axios.$get('/revenue/snapshots', { params });
+    },
+
+    getLatest: (params: { idSociety?: number; idExercice?: number }) => {
+      return this.axios.$get('/revenue/snapshots/latest', { params });
+    },
+
+    generate: (data: { date?: string; idSociety?: number; idExercice?: number }) => {
+      return this.axios.$post('/revenue/snapshots/generate', data);
+    },
+
+    generateAll: (data: { date?: string }) => {
+      return this.axios.$post('/revenue/snapshots/generate-all', data);
+    },
+  };
+
+  /**
+   * Récupérer le résumé ARR
+   */
+  public arrSummary = {
+    get: (params: {
+      idSociety?: number;
+      idExercice?: number;
+      startDate?: string;
+      endDate?: string;
+    }): Promise<IGetArrSummaryResponse> => {
+      return this.axios.$get('/revenue/arr-summary', { params });
+    },
+
+    getSociety: (
+      idSociety: number,
+      params: {
+        idExercice?: number;
+        startDate?: string;
+        endDate?: string;
+      },
+    ): Promise<IGetArrSummaryResponse> => {
+      return this.axios.$get(`/revenue/societies/${idSociety}/arr-summary`, { params });
+    },
+  };
+}

package/ts/api/resources.ts

@@ -185,6 +185,7 @@ import { StripePurchase } from './resources/StripePurchase';
 import { DashboardLayout } from './resources/DashboardLayout';
 import { DocumentRequest } from './resources/DocumentRequest';
 import { BalanceSheetReport } from './resources/BalanceSheetReport';
+import { Revenue } from './resources/Revenue';
 
 export const resources = {
   budgetInsight: BudgetInsight,
@@ -374,4 +375,5 @@ export const resources = {
   StripePurchase: StripePurchase,
   documentRequest: DocumentRequest,
   balanceSheetReport: BalanceSheetReport,
+  revenue: Revenue,
 };

package/ts/types/Enum/BankAccountType.ts

@@ -4,6 +4,12 @@ export enum BankAccountType {
   EXPENSE = 3,
 }
 
+export enum BankAccountBalanceState {
+  DESYNCHRONIZED = 0,
+  SYNCHRONIZED = 1,
+  NA = 2, // This value is for manual bank accounts where balance synchronization is not applicable
+}
+
 export type BankAccountSubType =
   | 'article83'
   | 'capitalisation'
@@ -25,4 +31,4 @@ export type BankAccountSubType =
   | 'real_estate'
   | 'rsp'
   | 'savings'
-  | 'unknown';
+  | 'unknown';

package/ts/types/Enum/Revenue.ts

@@ -0,0 +1,42 @@
+/**
+ * Type de mouvement de revenu
+ */
+export enum RevenueMovementType {
+  /** Nouveau booking (nouvelle prestation souscrite) */
+  BOOKING = 1,
+  
+  /** Churn (résiliation client) */
+  CHURN = 2,
+  
+  /** Provision (revenu différé) */
+  PROVISION = 3,
+  
+  /** Reconnaissance de revenu */
+  RECOGNITION = 4,
+  
+  /** Upgrade (augmentation de prestation) */
+  UPGRADE = 5,
+  
+  /** Downgrade (réduction de prestation) */
+  DOWNGRADE = 6,
+  
+  /** Reactivation (client qui revient) */
+  REACTIVATION = 7,
+}
+
+/**
+ * Type de périodicité pour les prestations
+ */
+export enum PrestationPeriodicity {
+  /** Mensuel */
+  MONTHLY = 1,
+  
+  /** Trimestriel */
+  QUARTERLY = 2,
+  
+  /** Annuel */
+  YEARLY = 3,
+  
+  /** Paiement unique (non récurrent) */
+  ONE_TIME = 4,
+}

package/ts/types/Interface/api/revenueMovement.ts

@@ -0,0 +1,74 @@
+import { RevenueMovementType } from '../../Enum/Revenue';
+
+/**
+ * DTO pour créer un mouvement de revenu
+ */
+export interface ICreateRevenueMovementRequest {
+  type: RevenueMovementType;
+  idSociety: number;
+  idExercice?: number;
+  idPrestation?: number;
+  idTerminationList?: number;
+  amount: number;
+  mrr: number;
+  arr: number;
+  movementDate: Date;
+  description?: string;
+  metadata?: Record<string, any>;
+}
+
+/**
+ * DTO pour mettre à jour un mouvement de revenu
+ */
+export interface IUpdateRevenueMovementRequest {
+  type?: RevenueMovementType;
+  idTerminationList?: number;
+  amount?: number;
+  mrr?: number;
+  arr?: number;
+  movementDate?: Date | string;
+  description?: string;
+  metadata?: Record<string, any>;
+}
+
+/**
+ * Filtres pour récupérer les mouvements de revenu
+ */
+export interface IGetRevenueMovementsRequest {
+  idSociety?: number;
+  idExercice?: number;
+  idPrestation?: number;
+  idTerminationList?: number;
+  type?: RevenueMovementType[];
+  startDate?: Date | string;
+  endDate?: Date | string;
+  page?: number;
+  limit?: number;
+}
+
+/**
+ * Réponse paginée pour les mouvements de revenu
+ */
+export interface IGetRevenueMovementsResponse {
+  movements: any[]; // IRevenueMovement[]
+  total: number;
+  page: number;
+  limit: number;
+  totalPages: number;
+}
+
+/**
+ * DTO pour générer un snapshot de revenu
+ */
+export interface IGenerateSnapshotRequest {
+  date?: string;
+  idSociety?: number;
+  idExercice?: number;
+}
+
+/**
+ * DTO pour générer tous les snapshots de revenu
+ */
+export interface IGenerateAllSnapshotsRequest {
+  date?: string;
+}

package/ts/types/Interface/api/revenueSnapshot.ts

@@ -0,0 +1,59 @@
+/**
+ * Filtres pour récupérer les snapshots de revenu
+ */
+export interface IGetRevenueSnapshotsRequest {
+  idSociety?: number;
+  idExercice?: number;
+  startDate?: Date | string;
+  endDate?: Date | string;
+  page?: number;
+  limit?: number;
+}
+
+/**
+ * Réponse paginée pour les snapshots de revenu
+ */
+export interface IGetRevenueSnapshotsResponse {
+  snapshots: any[]; // IRevenueSnapshot[]
+  total: number;
+  page: number;
+  limit: number;
+  totalPages: number;
+}
+
+/**
+ * Réponse pour obtenir le dernier snapshot d'une société
+ */
+export interface IGetLatestSnapshotResponse {
+  snapshot: any; // IRevenueSnapshot
+}
+
+/**
+ * Réponse pour obtenir le tableau récapitulatif ARR
+ */
+export interface IGetArrSummaryResponse {
+  idSociety?: number;
+  idExercice?: number;
+  period: {
+    startDate: Date;
+    endDate: Date;
+  };
+  summary: {
+    currentArr: number;
+    currentMrr: number;
+    totalBookings: number;
+    totalChurn: number;
+    totalProvisions: number;
+    totalRecognitions: number;
+    activeCustomers: number;
+    churnRate: number;
+    mrrGrowthRate: number;
+  };
+  timeline: Array<{
+    date: Date;
+    arr: number;
+    mrr: number;
+    bookings: number;
+    churn: number;
+  }>;
+}

package/ts/types/Interface/api/revenueSnapshotGenerate.ts

@@ -0,0 +1,42 @@
+import { ApiProperty } from '../../../utils';
+import { IsOptional, IsString, IsNumber } from 'class-validator';
+
+export class GenerateSnapshot {
+  @ApiProperty({
+    required: false,
+    description: 'Date du snapshot au format ISO (YYYY-MM-DD)',
+    example: '2025-11-04',
+  })
+  @IsOptional()
+  @IsString()
+  date?: string;
+
+  @ApiProperty({
+    required: false,
+    description: 'ID de la société',
+    example: 60170,
+  })
+  @IsOptional()
+  @IsNumber()
+  idSociety?: number;
+
+  @ApiProperty({
+    required: false,
+    description: "ID de l'exercice",
+    example: 123456,
+  })
+  @IsOptional()
+  @IsNumber()
+  idExercice?: number;
+}
+
+export class GenerateAllSnapshots {
+  @ApiProperty({
+    required: false,
+    description: 'Date du snapshot au format ISO (YYYY-MM-DD)',
+    example: '2025-11-04',
+  })
+  @IsOptional()
+  @IsString()
+  date?: string;
+}

package/ts/types/Interface/models/IRevenueMovement.ts

@@ -0,0 +1,51 @@
+import { RevenueMovementType } from '../../Enum/Revenue';
+
+/**
+ * Interface pour les mouvements de revenus (bookings, churn, provisions, etc.)
+ */
+export interface IRevenueMovement {
+  /** ID unique du mouvement */
+  id: number;
+
+  /** Type de mouvement (booking, churn, provision, etc.) */
+  type: RevenueMovementType;
+
+  /** ID de la société concernée */
+  idSociety: number;
+
+  /** ID de l'exercice concerné (optionnel) */
+  idExercice?: number | null;
+
+  /** ID de la prestation concernée (optionnel) */
+  idPrestation?: number | null;
+
+  /** ID de la résiliation qui a annulé ce mouvement (pour traçabilité) */
+  idTerminationList?: number | null;
+
+  /** Montant du mouvement (en centimes) */
+  amount: number;
+
+  /** Montant MRR (Monthly Recurring Revenue) en centimes */
+  mrr: number;
+
+  /** Montant ARR (Annual Recurring Revenue) en centimes */
+  arr: number;
+
+  /** Date du mouvement */
+  movementDate: Date;
+
+  /** Description/commentaire du mouvement */
+  description?: string | null;
+
+  /** Métadonnées additionnelles (JSON) */
+  metadata?: Record<string, any> | null;
+
+  /** Date de création */
+  createdAt: Date;
+
+  /** Date de mise à jour */
+  updatedAt: Date;
+
+  /** Date de suppression (soft delete) */
+  deletedAt?: Date | null;
+}

package/ts/types/Interface/models/IRevenueSnapshot.ts

@@ -0,0 +1,55 @@
+/**
+ * Interface pour les snapshots quotidiens d'ARR par société/exercice
+ */
+export interface IRevenueSnapshot {
+  /** ID unique du snapshot */
+  id: number;
+
+  /** ID de la société concernée (null = snapshot global toutes sociétés) */
+  idSociety?: number | null;
+
+  /** ID de l'exercice concerné (null = snapshot global tous exercices) */
+  idExercice?: number | null;
+
+  /** Date du snapshot */
+  snapshotDate: Date;
+
+  /** ARR total à cette date (en centimes) */
+  arr: number;
+
+  /** MRR total à cette date (en centimes) */
+  mrr: number;
+
+  /** Total des bookings du mois en cours (en centimes) */
+  monthlyBookings: number;
+
+  /** Total du churn du mois en cours (en centimes) */
+  monthlyChurn: number;
+
+  /** Provisions en attente de reconnaissance (en centimes) */
+  pendingProvisions: number;
+
+  /** Reconnaissances du mois en cours (en centimes) */
+  monthlyRecognitions: number;
+
+  /** Nombre de clients actifs */
+  // Optionnel, voir si utile ?
+  activeCustomers: number;
+
+  /** Taux de churn du mois (en pourcentage) */
+  // Optionnel, voir si utile ?
+  churnRate?: number | null;
+
+  /** Croissance MRR vs mois précédent (en pourcentage) */
+  // Optionnel, voir si utile ?
+  mrrGrowthRate?: number | null;
+
+  /** Métadonnées additionnelles (JSON) */
+  metadata?: Record<string, any> | null;
+
+  /** Date de création */
+  createdAt: Date;
+
+  /** Date de mise à jour */
+  updatedAt: Date;
+}

package/ts/types/Interface/models/IStateBankAccount.ts

@@ -1,10 +1,11 @@
+import { BankAccountBalanceState } from '../../Enum/BankAccountType';
 import { IBankAccount } from './IBankAccount';
 import { IExercice } from './IExercice';
 
 // stateBankAccount
 export interface IStateBankAccount {
   id?: number;
-  balanceState?: boolean | null;
+  balanceState?: BankAccountBalanceState | null;
   balanceValue?: number | null;
   balanceDate?: Date | null;
   idBankAccount: number;

package/ts/types/index.ts

@@ -1185,3 +1185,11 @@ export * from './Interface/api/regulation/Create';
 export * from './Interface/api/marketing/NewLeadSheet';
 export * from './Interface/api/ai/AskQuestionCollaborator';
 export * from './Interface/api/refund/QueryRefundPaginated';
+
+// Revenue tracking interfaces
+export * from './Interface/models/IRevenueMovement';
+export * from './Interface/models/IRevenueSnapshot';
+export * from './Interface/api/revenueMovement';
+export * from './Interface/api/revenueSnapshot';
+export * from './Interface/api/revenueSnapshotGenerate';
+export * from './Enum/Revenue';