hvp-shared 6.15.0 → 6.17.0

package/dist/contracts/qvet/responses.d.ts

@@ -510,3 +510,187 @@ export interface QvetCollectionsQueryParams {
     page?: number;
     skip?: number;
 }
+/**
+ * Single cash closing record from QVET
+ * Represents a cash register closing entry - one row per payment method per closing
+ *
+ * A single closing (closingNumber) has multiple rows, one for each payment method.
+ * To get the total for a closing, sum all rows with the same closingNumber.
+ */
+export interface QvetCashClosingResponse {
+    id: string;
+    cashRegister: string;
+    closingNumber: number;
+    paymentMethod: string;
+    saleAmount: number;
+    closingTotal: number;
+    collectedAmount: number;
+    dayCollections: number;
+    cashOut: number;
+    closingDate: string;
+    previousClosingDate: string;
+    branch: string;
+    staffName: string;
+    syncedAt: string;
+}
+/**
+ * Cash closings summary statistics data.
+ * Backend wraps with: ApiSingleSuccessResponse<QvetCashClosingsSummaryData>
+ */
+export interface QvetCashClosingsSummaryData {
+    totalRecords: number;
+    totalClosings: number;
+    totalSales: number;
+    totalCollected: number;
+    totalCashOut: number;
+    byPaymentMethod: {
+        method: string;
+        totalAmount: number;
+        count: number;
+    }[];
+}
+/**
+ * Cash closings grouped by cash register.
+ * Backend returns: ApiSingleSuccessResponse<QvetCashClosingsByCashRegisterItem[]>
+ */
+export interface QvetCashClosingsByCashRegisterItem {
+    cashRegister: string;
+    totalSales: number;
+    totalClosings: number;
+    totalCashOut: number;
+}
+/**
+ * Cash closings grouped by staff member.
+ * Backend returns: ApiSingleSuccessResponse<QvetCashClosingsByStaffItem[]>
+ */
+export interface QvetCashClosingsByStaffItem {
+    staffName: string;
+    totalClosings: number;
+    totalSales: number;
+    branches: string[];
+}
+/**
+ * Cash closing grouped response - one entry per closing with payment methods nested.
+ * Used for displaying closings as single cards/rows in the UI.
+ * Backend returns: ApiListSuccessResponse<QvetCashClosingGroupedResponse>
+ *
+ * @example GET /api/qvet/cash-closings/grouped?year=2026&month=1
+ */
+export interface QvetCashClosingGroupedResponse {
+    closingNumber: number;
+    closingDate: string;
+    previousClosingDate: string;
+    cashRegister: string;
+    branch: string;
+    staffName: string;
+    closingTotal: number;
+    collectedAmount: number;
+    dayCollections: number;
+    cashOut: number;
+    syncedAt: string;
+    paymentMethods: {
+        method: string;
+        amount: number;
+    }[];
+}
+/**
+ * Query parameters for cash closings endpoint
+ */
+export interface QvetCashClosingsQueryParams {
+    startDate?: string;
+    endDate?: string;
+    year?: number;
+    month?: number;
+    halfMonth?: 1 | 2;
+    branch?: string;
+    cashRegister?: string;
+    paymentMethod?: string;
+    staffName?: string;
+    limit?: number;
+    page?: number;
+    skip?: number;
+    sort?: string;
+}
+/**
+ * Single cash flow record from QVET (Entradas/Salidas de Caja)
+ * Represents cash in/out transactions outside of regular sales
+ * Examples: petty cash, reimbursements, supplier payments
+ *
+ * Transaction types:
+ * - ENTRADA CAJA: Cash in (positive amount)
+ * - SALIDA CAJA: Cash out (negative amount)
+ */
+export interface QvetCashFlowResponse {
+    id: string;
+    branch: string;
+    cashRegister: string;
+    transactionDate: string;
+    transactionType: string;
+    paymentMethod: string;
+    amount: number;
+    comments: string;
+    supplier: string;
+    staffName: string;
+    closingDate: string;
+    syncedAt: string;
+}
+/**
+ * Cash flows summary statistics data.
+ * Backend wraps with: ApiSingleSuccessResponse<QvetCashFlowsSummaryData>
+ */
+export interface QvetCashFlowsSummaryData {
+    totalRecords: number;
+    totalCashIn: number;
+    totalCashOut: number;
+    netFlow: number;
+    byTransactionType: {
+        type: string;
+        totalAmount: number;
+        count: number;
+    }[];
+    byPaymentMethod: {
+        method: string;
+        totalAmount: number;
+        count: number;
+    }[];
+}
+/**
+ * Cash flows grouped by staff member.
+ * Backend returns: ApiSingleSuccessResponse<QvetCashFlowsByStaffItem[]>
+ */
+export interface QvetCashFlowsByStaffItem {
+    staffName: string;
+    totalCashIn: number;
+    totalCashOut: number;
+    netFlow: number;
+    recordCount: number;
+}
+/**
+ * Cash flows grouped by supplier/recipient.
+ * Backend returns: ApiSingleSuccessResponse<QvetCashFlowsBySupplierItem[]>
+ */
+export interface QvetCashFlowsBySupplierItem {
+    supplier: string;
+    totalAmount: number;
+    recordCount: number;
+}
+/**
+ * Query parameters for cash flows endpoint
+ */
+export interface QvetCashFlowsQueryParams {
+    startDate?: string;
+    endDate?: string;
+    year?: number;
+    month?: number;
+    halfMonth?: 1 | 2;
+    branch?: string;
+    cashRegister?: string;
+    transactionType?: string;
+    paymentMethod?: string;
+    staffName?: string;
+    supplier?: string;
+    limit?: number;
+    page?: number;
+    skip?: number;
+    sort?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hvp-shared",
-  "version": "6.15.0",
+  "version": "6.17.0",
   "description": "Shared types and utilities for HVP backend and frontend",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",