@goodsamsoftware/freshbooks-mcp 1.0.0

package/dist/tools/report/schemas.d.ts

@@ -0,0 +1,859 @@
+/**
+ * Zod schemas for Report entity
+ *
+ * Financial report schemas for FreshBooks API
+ */
+import { z } from 'zod';
+/**
+ * Date range schema for reports
+ */
+export declare const DateRangeSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    startDate: string;
+    endDate: string;
+}, {
+    startDate: string;
+    endDate: string;
+}>;
+/**
+ * Payment item schema for payments collected report
+ */
+export declare const PaymentItemSchema: z.ZodObject<{
+    date: z.ZodString;
+    clientName: z.ZodString;
+    invoiceNumber: z.ZodString;
+    amount: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    paymentType: z.ZodString;
+    notes: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    date: string;
+    amount: {
+        code: string;
+        amount: string;
+    };
+    invoiceNumber: string;
+    paymentType: string;
+    clientName: string;
+    notes?: string | undefined;
+}, {
+    date: string;
+    amount: {
+        code: string;
+        amount: string;
+    };
+    invoiceNumber: string;
+    paymentType: string;
+    clientName: string;
+    notes?: string | undefined;
+}>;
+/**
+ * Payments Collected Report schema
+ */
+export declare const PaymentsCollectedReportSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+    payments: z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        clientName: z.ZodString;
+        invoiceNumber: z.ZodString;
+        amount: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        paymentType: z.ZodString;
+        notes: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        date: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        invoiceNumber: string;
+        paymentType: string;
+        clientName: string;
+        notes?: string | undefined;
+    }, {
+        date: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        invoiceNumber: string;
+        paymentType: string;
+        clientName: string;
+        notes?: string | undefined;
+    }>, "many">;
+    totalAmount: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    payments: {
+        date: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        invoiceNumber: string;
+        paymentType: string;
+        clientName: string;
+        notes?: string | undefined;
+    }[];
+    startDate: string;
+    endDate: string;
+    totalAmount: {
+        code: string;
+        amount: string;
+    };
+}, {
+    payments: {
+        date: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        invoiceNumber: string;
+        paymentType: string;
+        clientName: string;
+        notes?: string | undefined;
+    }[];
+    startDate: string;
+    endDate: string;
+    totalAmount: {
+        code: string;
+        amount: string;
+    };
+}>;
+/**
+ * Profit/Loss line item schema
+ */
+export declare const ProfitLossLineSchema: z.ZodObject<{
+    category: z.ZodString;
+    amount: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    children: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+}, "strip", z.ZodTypeAny, {
+    amount: {
+        code: string;
+        amount: string;
+    };
+    category: string;
+    children?: any[] | undefined;
+}, {
+    amount: {
+        code: string;
+        amount: string;
+    };
+    category: string;
+    children?: any[] | undefined;
+}>;
+/**
+ * Profit/Loss Report schema
+ */
+export declare const ProfitLossReportSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+    revenue: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    expenses: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    netIncome: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        category: z.ZodString;
+        amount: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        children: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        amount: {
+            code: string;
+            amount: string;
+        };
+        category: string;
+        children?: any[] | undefined;
+    }, {
+        amount: {
+            code: string;
+            amount: string;
+        };
+        category: string;
+        children?: any[] | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    expenses: {
+        code: string;
+        amount: string;
+    };
+    startDate: string;
+    endDate: string;
+    revenue: {
+        code: string;
+        amount: string;
+    };
+    netIncome: {
+        code: string;
+        amount: string;
+    };
+    lines?: {
+        amount: {
+            code: string;
+            amount: string;
+        };
+        category: string;
+        children?: any[] | undefined;
+    }[] | undefined;
+}, {
+    expenses: {
+        code: string;
+        amount: string;
+    };
+    startDate: string;
+    endDate: string;
+    revenue: {
+        code: string;
+        amount: string;
+    };
+    netIncome: {
+        code: string;
+        amount: string;
+    };
+    lines?: {
+        amount: {
+            code: string;
+            amount: string;
+        };
+        category: string;
+        children?: any[] | undefined;
+    }[] | undefined;
+}>;
+/**
+ * Tax summary item schema
+ */
+export declare const TaxSummaryItemSchema: z.ZodObject<{
+    taxName: z.ZodString;
+    taxRate: z.ZodString;
+    taxableAmount: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    taxCollected: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    taxPaid: z.ZodOptional<z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    taxName: string;
+    taxRate: string;
+    taxableAmount: {
+        code: string;
+        amount: string;
+    };
+    taxCollected: {
+        code: string;
+        amount: string;
+    };
+    taxPaid?: {
+        code: string;
+        amount: string;
+    } | undefined;
+}, {
+    taxName: string;
+    taxRate: string;
+    taxableAmount: {
+        code: string;
+        amount: string;
+    };
+    taxCollected: {
+        code: string;
+        amount: string;
+    };
+    taxPaid?: {
+        code: string;
+        amount: string;
+    } | undefined;
+}>;
+/**
+ * Tax Summary Report schema
+ */
+export declare const TaxSummaryReportSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+    taxes: z.ZodArray<z.ZodObject<{
+        taxName: z.ZodString;
+        taxRate: z.ZodString;
+        taxableAmount: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        taxCollected: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        taxPaid: z.ZodOptional<z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        taxName: string;
+        taxRate: string;
+        taxableAmount: {
+            code: string;
+            amount: string;
+        };
+        taxCollected: {
+            code: string;
+            amount: string;
+        };
+        taxPaid?: {
+            code: string;
+            amount: string;
+        } | undefined;
+    }, {
+        taxName: string;
+        taxRate: string;
+        taxableAmount: {
+            code: string;
+            amount: string;
+        };
+        taxCollected: {
+            code: string;
+            amount: string;
+        };
+        taxPaid?: {
+            code: string;
+            amount: string;
+        } | undefined;
+    }>, "many">;
+    totalTaxCollected: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    startDate: string;
+    endDate: string;
+    taxes: {
+        taxName: string;
+        taxRate: string;
+        taxableAmount: {
+            code: string;
+            amount: string;
+        };
+        taxCollected: {
+            code: string;
+            amount: string;
+        };
+        taxPaid?: {
+            code: string;
+            amount: string;
+        } | undefined;
+    }[];
+    totalTaxCollected: {
+        code: string;
+        amount: string;
+    };
+}, {
+    startDate: string;
+    endDate: string;
+    taxes: {
+        taxName: string;
+        taxRate: string;
+        taxableAmount: {
+            code: string;
+            amount: string;
+        };
+        taxCollected: {
+            code: string;
+            amount: string;
+        };
+        taxPaid?: {
+            code: string;
+            amount: string;
+        } | undefined;
+    }[];
+    totalTaxCollected: {
+        code: string;
+        amount: string;
+    };
+}>;
+/**
+ * Input schema for payments collected report
+ */
+export declare const PaymentsCollectedReportInputSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+} & {
+    accountId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    startDate: string;
+    endDate: string;
+}, {
+    accountId: string;
+    startDate: string;
+    endDate: string;
+}>;
+/**
+ * Input schema for profit/loss report
+ */
+export declare const ProfitLossReportInputSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+} & {
+    accountId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    startDate: string;
+    endDate: string;
+}, {
+    accountId: string;
+    startDate: string;
+    endDate: string;
+}>;
+/**
+ * Input schema for tax summary report
+ */
+export declare const TaxSummaryReportInputSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+} & {
+    accountId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    startDate: string;
+    endDate: string;
+}, {
+    accountId: string;
+    startDate: string;
+    endDate: string;
+}>;
+/**
+ * Output schemas
+ */
+export declare const PaymentsCollectedReportOutputSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+    payments: z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        clientName: z.ZodString;
+        invoiceNumber: z.ZodString;
+        amount: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        paymentType: z.ZodString;
+        notes: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        date: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        invoiceNumber: string;
+        paymentType: string;
+        clientName: string;
+        notes?: string | undefined;
+    }, {
+        date: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        invoiceNumber: string;
+        paymentType: string;
+        clientName: string;
+        notes?: string | undefined;
+    }>, "many">;
+    totalAmount: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    payments: {
+        date: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        invoiceNumber: string;
+        paymentType: string;
+        clientName: string;
+        notes?: string | undefined;
+    }[];
+    startDate: string;
+    endDate: string;
+    totalAmount: {
+        code: string;
+        amount: string;
+    };
+}, {
+    payments: {
+        date: string;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        invoiceNumber: string;
+        paymentType: string;
+        clientName: string;
+        notes?: string | undefined;
+    }[];
+    startDate: string;
+    endDate: string;
+    totalAmount: {
+        code: string;
+        amount: string;
+    };
+}>;
+export declare const ProfitLossReportOutputSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+    revenue: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    expenses: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    netIncome: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+    lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        category: z.ZodString;
+        amount: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        children: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        amount: {
+            code: string;
+            amount: string;
+        };
+        category: string;
+        children?: any[] | undefined;
+    }, {
+        amount: {
+            code: string;
+            amount: string;
+        };
+        category: string;
+        children?: any[] | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    expenses: {
+        code: string;
+        amount: string;
+    };
+    startDate: string;
+    endDate: string;
+    revenue: {
+        code: string;
+        amount: string;
+    };
+    netIncome: {
+        code: string;
+        amount: string;
+    };
+    lines?: {
+        amount: {
+            code: string;
+            amount: string;
+        };
+        category: string;
+        children?: any[] | undefined;
+    }[] | undefined;
+}, {
+    expenses: {
+        code: string;
+        amount: string;
+    };
+    startDate: string;
+    endDate: string;
+    revenue: {
+        code: string;
+        amount: string;
+    };
+    netIncome: {
+        code: string;
+        amount: string;
+    };
+    lines?: {
+        amount: {
+            code: string;
+            amount: string;
+        };
+        category: string;
+        children?: any[] | undefined;
+    }[] | undefined;
+}>;
+export declare const TaxSummaryReportOutputSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+    taxes: z.ZodArray<z.ZodObject<{
+        taxName: z.ZodString;
+        taxRate: z.ZodString;
+        taxableAmount: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        taxCollected: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        taxPaid: z.ZodOptional<z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        taxName: string;
+        taxRate: string;
+        taxableAmount: {
+            code: string;
+            amount: string;
+        };
+        taxCollected: {
+            code: string;
+            amount: string;
+        };
+        taxPaid?: {
+            code: string;
+            amount: string;
+        } | undefined;
+    }, {
+        taxName: string;
+        taxRate: string;
+        taxableAmount: {
+            code: string;
+            amount: string;
+        };
+        taxCollected: {
+            code: string;
+            amount: string;
+        };
+        taxPaid?: {
+            code: string;
+            amount: string;
+        } | undefined;
+    }>, "many">;
+    totalTaxCollected: z.ZodObject<{
+        amount: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        code: string;
+        amount: string;
+    }, {
+        code: string;
+        amount: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    startDate: string;
+    endDate: string;
+    taxes: {
+        taxName: string;
+        taxRate: string;
+        taxableAmount: {
+            code: string;
+            amount: string;
+        };
+        taxCollected: {
+            code: string;
+            amount: string;
+        };
+        taxPaid?: {
+            code: string;
+            amount: string;
+        } | undefined;
+    }[];
+    totalTaxCollected: {
+        code: string;
+        amount: string;
+    };
+}, {
+    startDate: string;
+    endDate: string;
+    taxes: {
+        taxName: string;
+        taxRate: string;
+        taxableAmount: {
+            code: string;
+            amount: string;
+        };
+        taxCollected: {
+            code: string;
+            amount: string;
+        };
+        taxPaid?: {
+            code: string;
+            amount: string;
+        } | undefined;
+    }[];
+    totalTaxCollected: {
+        code: string;
+        amount: string;
+    };
+}>;
+//# sourceMappingURL=schemas.d.ts.map