@goodsamsoftware/freshbooks-mcp 1.0.0

package/dist/tools/expense/expense-update.d.ts

@@ -0,0 +1,199 @@
+/**
+ * expense_update Tool
+ *
+ * Update an existing expense in FreshBooks.
+ */
+import { z } from 'zod';
+import { ExpenseUpdateInputSchema, ExpenseSingleOutputSchema } from './schemas.js';
+import { FreshBooksClientWrapper } from '../../client/index.js';
+/**
+ * Tool definition for expense_update
+ */
+export declare const expenseUpdateTool: {
+    name: string;
+    description: string;
+    inputSchema: z.ZodObject<{
+        accountId: z.ZodString;
+        expenseId: z.ZodNumber;
+        categoryId: z.ZodOptional<z.ZodNumber>;
+        date: z.ZodOptional<z.ZodString>;
+        amount: z.ZodOptional<z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>>;
+        vendor: z.ZodOptional<z.ZodString>;
+        notes: z.ZodOptional<z.ZodString>;
+        clientId: z.ZodOptional<z.ZodNumber>;
+        projectId: z.ZodOptional<z.ZodNumber>;
+        markupPercent: z.ZodOptional<z.ZodNumber>;
+        taxName1: z.ZodOptional<z.ZodString>;
+        taxPercent1: z.ZodOptional<z.ZodString>;
+        taxName2: z.ZodOptional<z.ZodString>;
+        taxPercent2: z.ZodOptional<z.ZodString>;
+        visState: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+    }, "strip", z.ZodTypeAny, {
+        accountId: string;
+        expenseId: number;
+        date?: string | undefined;
+        amount?: {
+            code: string;
+            amount: string;
+        } | undefined;
+        clientId?: number | undefined;
+        projectId?: number | undefined;
+        visState?: 0 | 1 | 2 | undefined;
+        taxName1?: string | undefined;
+        taxName2?: string | undefined;
+        notes?: string | undefined;
+        categoryId?: number | undefined;
+        vendor?: string | undefined;
+        markupPercent?: number | undefined;
+        taxPercent1?: string | undefined;
+        taxPercent2?: string | undefined;
+    }, {
+        accountId: string;
+        expenseId: number;
+        date?: string | undefined;
+        amount?: {
+            code: string;
+            amount: string;
+        } | undefined;
+        clientId?: number | undefined;
+        projectId?: number | undefined;
+        visState?: 0 | 1 | 2 | undefined;
+        taxName1?: string | undefined;
+        taxName2?: string | undefined;
+        notes?: string | undefined;
+        categoryId?: number | undefined;
+        vendor?: string | undefined;
+        markupPercent?: number | undefined;
+        taxPercent1?: string | undefined;
+        taxPercent2?: string | undefined;
+    }>;
+    outputSchema: z.ZodObject<{
+        id: z.ZodNumber;
+        expenseId: z.ZodOptional<z.ZodNumber>;
+        categoryId: z.ZodNumber;
+        staffId: z.ZodNumber;
+        date: z.ZodString;
+        amount: z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>;
+        vendor: z.ZodNullable<z.ZodString>;
+        notes: z.ZodString;
+        clientId: z.ZodOptional<z.ZodNumber>;
+        projectId: z.ZodOptional<z.ZodNumber>;
+        invoiceId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        status: z.ZodOptional<z.ZodEnum<["outstanding", "invoiced", "partial", "paid"]>>;
+        hasReceipt: z.ZodOptional<z.ZodBoolean>;
+        markupPercent: z.ZodOptional<z.ZodNumber>;
+        taxName1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        taxPercent1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        taxAmount1: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>>>;
+        taxName2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        taxPercent2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        taxAmount2: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            amount: z.ZodString;
+            code: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            code: string;
+            amount: string;
+        }, {
+            code: string;
+            amount: string;
+        }>>>;
+        visState: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+        updated: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        date: string;
+        id: number;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        notes: string;
+        categoryId: number;
+        staffId: number;
+        vendor: string | null;
+        status?: "partial" | "outstanding" | "paid" | "invoiced" | undefined;
+        clientId?: number | undefined;
+        projectId?: number | undefined;
+        visState?: 0 | 1 | 2 | undefined;
+        updated?: string | undefined;
+        taxName1?: string | null | undefined;
+        taxAmount1?: {
+            code: string;
+            amount: string;
+        } | null | undefined;
+        taxName2?: string | null | undefined;
+        taxAmount2?: {
+            code: string;
+            amount: string;
+        } | null | undefined;
+        invoiceId?: number | null | undefined;
+        expenseId?: number | undefined;
+        hasReceipt?: boolean | undefined;
+        markupPercent?: number | undefined;
+        taxPercent1?: string | null | undefined;
+        taxPercent2?: string | null | undefined;
+    }, {
+        date: string;
+        id: number;
+        amount: {
+            code: string;
+            amount: string;
+        };
+        notes: string;
+        categoryId: number;
+        staffId: number;
+        vendor: string | null;
+        status?: "partial" | "outstanding" | "paid" | "invoiced" | undefined;
+        clientId?: number | undefined;
+        projectId?: number | undefined;
+        visState?: 0 | 1 | 2 | undefined;
+        updated?: string | undefined;
+        taxName1?: string | null | undefined;
+        taxAmount1?: {
+            code: string;
+            amount: string;
+        } | null | undefined;
+        taxName2?: string | null | undefined;
+        taxAmount2?: {
+            code: string;
+            amount: string;
+        } | null | undefined;
+        invoiceId?: number | null | undefined;
+        expenseId?: number | undefined;
+        hasReceipt?: boolean | undefined;
+        markupPercent?: number | undefined;
+        taxPercent1?: string | null | undefined;
+        taxPercent2?: string | null | undefined;
+    }>;
+    /**
+     * Execute the tool
+     */
+    execute(input: z.infer<typeof ExpenseUpdateInputSchema>, client: FreshBooksClientWrapper): Promise<z.infer<typeof ExpenseSingleOutputSchema>>;
+};
+//# sourceMappingURL=expense-update.d.ts.map

package/dist/tools/expense/expense-update.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expense-update.d.ts","sourceRoot":"","sources":["../../../src/tools/expense/expense-update.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AACnF,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAKhE;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAwC5B;;OAEG;mBAEM,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,UACvC,uBAAuB,GAC9B,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;CA4DtD,CAAC"}

package/dist/tools/expense/expense-update.js

@@ -0,0 +1,108 @@
+/**
+ * expense_update Tool
+ *
+ * Update an existing expense in FreshBooks.
+ */
+import { ExpenseUpdateInputSchema, ExpenseSingleOutputSchema } from './schemas.js';
+import { ErrorHandler } from '../../errors/error-handler.js';
+import { logger } from '../../utils/logger.js';
+/**
+ * Tool definition for expense_update
+ */
+export const expenseUpdateTool = {
+    name: 'expense_update',
+    description: `Update an existing expense in FreshBooks.
+
+WHEN TO USE:
+- User wants to modify an existing expense
+- User says "update expense", "change expense", "edit expense"
+- Correcting expense details or amounts
+- Updating expense billing information
+- Archiving/deleting expenses (via visState)
+
+REQUIRED:
+- accountId: FreshBooks account ID (get from auth_status if not specified)
+- expenseId: ID of expense to update
+
+OPTIONAL FIELDS (only include what needs to change):
+- categoryId: Change expense category
+- date: Update expense date
+- amount: Modify expense amount/currency
+- vendor: Change vendor name
+- notes: Update description
+- clientId: Change client billing
+- projectId: Change project association
+- markupPercent: Adjust markup percentage (0-100)
+- taxName1/taxPercent1: Update first tax
+- taxName2/taxPercent2: Update second tax
+- visState: Archive or restore (0=active, 1=deleted, 2=archived)
+
+EXAMPLE PROMPTS:
+- "Update expense 12345 to $175.50"
+- "Change the vendor on expense 67890 to 'Acme Corp'"
+- "Update expense 11111: add client 99 for billing"
+- "Archive expense 54321"
+
+RETURNS:
+Updated expense with all current details.`,
+    inputSchema: ExpenseUpdateInputSchema,
+    outputSchema: ExpenseSingleOutputSchema,
+    /**
+     * Execute the tool
+     */
+    async execute(input, client) {
+        const handler = ErrorHandler.wrapHandler('expense_update', async (input, _context) => {
+            const { accountId, expenseId, ...updateData } = input;
+            logger.debug('Updating expense', {
+                accountId,
+                expenseId,
+                fields: Object.keys(updateData),
+            });
+            // Build expense update object using camelCase properties
+            // The FreshBooks SDK's transformExpenseRequest() will convert to API format
+            const expense = {};
+            // Add fields if provided
+            if (updateData.categoryId !== undefined)
+                expense.categoryId = updateData.categoryId;
+            if (updateData.date !== undefined)
+                expense.date = updateData.date;
+            if (updateData.amount !== undefined)
+                expense.amount = updateData.amount;
+            if (updateData.vendor !== undefined)
+                expense.vendor = updateData.vendor;
+            if (updateData.notes !== undefined)
+                expense.notes = updateData.notes;
+            if (updateData.clientId !== undefined)
+                expense.clientId = updateData.clientId;
+            if (updateData.projectId !== undefined)
+                expense.projectId = updateData.projectId;
+            if (updateData.markupPercent !== undefined)
+                expense.markupPercent = updateData.markupPercent;
+            if (updateData.taxName1 !== undefined)
+                expense.taxName1 = updateData.taxName1;
+            if (updateData.taxPercent1 !== undefined)
+                expense.taxPercent1 = updateData.taxPercent1;
+            if (updateData.taxName2 !== undefined)
+                expense.taxName2 = updateData.taxName2;
+            if (updateData.taxPercent2 !== undefined)
+                expense.taxPercent2 = updateData.taxPercent2;
+            if (updateData.visState !== undefined)
+                expense.visState = updateData.visState;
+            const result = await client.executeWithRetry('expense_update', async (fbClient) => {
+                const response = await fbClient.expenses.update(expense, accountId, String(expenseId));
+                if (!response.ok) {
+                    throw response.error;
+                }
+                return response.data;
+            });
+            // FreshBooks returns: { expense: { ... } }
+            const updatedExpense = result.expense ?? result;
+            logger.info('Expense updated successfully', {
+                expenseId,
+            });
+            return updatedExpense;
+        });
+        return handler(input, { accountId: input.accountId });
+    },
+};
+//# sourceMappingURL=expense-update.js.map

package/dist/tools/expense/expense-update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expense-update.js","sourceRoot":"","sources":["../../../src/tools/expense/expense-update.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAEnF,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0CAiC2B;IAExC,WAAW,EAAE,wBAAwB;IACrC,YAAY,EAAE,yBAAyB;IAEvC;;OAEG;IACH,KAAK,CAAC,OAAO,CACX,KAA+C,EAC/C,MAA+B;QAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CACtC,gBAAgB,EAChB,KAAK,EACH,KAA+C,EAC/C,QAAqB,EACrB,EAAE;YACF,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,UAAU,EAAE,GAAG,KAAK,CAAC;YAEtD,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE;gBAC/B,SAAS;gBACT,SAAS;gBACT,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;aAChC,CAAC,CAAC;YAEH,yDAAyD;YACzD,4EAA4E;YAC5E,MAAM,OAAO,GAA4B,EAAE,CAAC;YAE5C,yBAAyB;YACzB,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS;gBAAE,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;YACpF,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS;gBAAE,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;YAClE,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS;gBAAE,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACxE,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS;gBAAE,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACxE,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS;gBAAE,OAAO,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;YACrE,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;gBAAE,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC9E,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS;gBAAE,OAAO,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;YACjF,IAAI,UAAU,CAAC,aAAa,KAAK,SAAS;gBAAE,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;YAC7F,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;gBAAE,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC9E,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS;gBAAE,OAAO,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;YACvF,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;gBAAE,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;YAC9E,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS;gBAAE,OAAO,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;YACvF,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;gBAAE,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;YAE9E,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAC1C,gBAAgB,EAChB,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACjB,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAc,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;gBAE9F,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,QAAQ,CAAC,KAAK,CAAC;gBACvB,CAAC;gBAED,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC,CACF,CAAC;YAEF,2CAA2C;YAC3C,MAAM,cAAc,GAAI,MAAgC,CAAC,OAAO,IAAI,MAAM,CAAC;YAE3E,MAAM,CAAC,IAAI,CAAC,8BAA8B,EAAE;gBAC1C,SAAS;aACV,CAAC,CAAC;YAEH,OAAO,cAA2D,CAAC;QACrE,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IACxD,CAAC;CACF,CAAC"}

package/dist/tools/expense/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Expense Tools - FreshBooks business expense tracking
+ *
+ * Exports all expense-related MCP tools for recording and managing business expenses.
+ */
+export { expenseListTool } from './expense-list.js';
+export { expenseSingleTool } from './expense-single.js';
+export { expenseCreateTool } from './expense-create.js';
+export { expenseUpdateTool } from './expense-update.js';
+export { expenseDeleteTool } from './expense-delete.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/tools/expense/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tools/expense/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/tools/expense/index.js

@@ -0,0 +1,13 @@
+/**
+ * Expense Tools - FreshBooks business expense tracking
+ *
+ * Exports all expense-related MCP tools for recording and managing business expenses.
+ */
+// Export schemas
+// Export tool definitions
+export { expenseListTool } from './expense-list.js';
+export { expenseSingleTool } from './expense-single.js';
+export { expenseCreateTool } from './expense-create.js';
+export { expenseUpdateTool } from './expense-update.js';
+export { expenseDeleteTool } from './expense-delete.js';
+//# sourceMappingURL=index.js.map

package/dist/tools/expense/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tools/expense/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,iBAAiB;AAEjB,0BAA0B;AAC1B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}