@goodsamsoftware/freshbooks-mcp 1.0.0

package/dist/tools/project/schemas.js

@@ -0,0 +1,196 @@
+/**
+ * Zod schemas for Project entity
+ *
+ * Project management schemas for FreshBooks API
+ */
+import { z } from 'zod';
+import { createSortSchema, createIncludesSchema } from '../base-tool.js';
+/**
+ * Project sortable fields
+ */
+export const PROJECT_SORTABLE_FIELDS = [
+    'title',
+    'created_at',
+    'due_date',
+];
+/**
+ * Project sort field descriptions
+ */
+export const PROJECT_SORT_FIELD_DESCRIPTIONS = {
+    title: 'Project title/name',
+    created_at: 'When the project was created',
+    due_date: 'Project deadline/due date',
+};
+/**
+ * Project include options
+ */
+export const PROJECT_INCLUDE_OPTIONS = [
+    'client',
+    'services',
+    'group',
+];
+/**
+ * Project include option descriptions
+ */
+export const PROJECT_INCLUDE_DESCRIPTIONS = {
+    client: 'Client details associated with the project',
+    services: 'Services/billing rates configured for the project',
+    group: 'Project group information for organization',
+};
+/**
+ * Project sort schema
+ */
+export const ProjectSortSchema = createSortSchema(PROJECT_SORTABLE_FIELDS, PROJECT_SORT_FIELD_DESCRIPTIONS);
+/**
+ * Project includes schema
+ */
+export const ProjectIncludesSchema = createIncludesSchema(PROJECT_INCLUDE_OPTIONS, PROJECT_INCLUDE_DESCRIPTIONS);
+/**
+ * Billing method enum - how the project is billed
+ */
+export const BillingMethodEnum = z.enum([
+    'project_rate',
+    'service_rate',
+    'flat_rate',
+    'team_member_rate',
+]);
+/**
+ * Project type enum
+ */
+export const ProjectTypeEnum = z.enum(['fixed_price', 'hourly_rate']);
+/**
+ * Billed status enum
+ */
+export const BilledStatusEnum = z.enum(['unbilled', 'partial', 'billed']);
+/**
+ * Full Project schema with all properties
+ */
+export const ProjectSchema = z.object({
+    id: z.number().describe('Unique project identifier'),
+    title: z.string().describe('Project title'),
+    description: z.string().nullable().describe('Project description'),
+    dueDate: z.string().datetime().nullable().describe('Project due date (ISO 8601)'),
+    clientId: z.string().nullable().describe('Associated client ID'),
+    internal: z.boolean().describe('Whether project is internal (non-billable)'),
+    budget: z.string().nullable().describe('Project budget amount'),
+    fixedPrice: z.string().nullable().describe('Fixed price amount for flat-rate projects'),
+    rate: z.string().nullable().describe('Hourly rate for time-based billing'),
+    billingMethod: BillingMethodEnum.nullable().describe('How project is billed'),
+    projectType: ProjectTypeEnum.describe('Type of project (fixed_price or hourly_rate)'),
+    projectManagerId: z.string().nullable().describe('Project manager user ID'),
+    active: z.boolean().describe('Whether project is active'),
+    complete: z.boolean().describe('Whether project is marked complete'),
+    sample: z.boolean().describe('Whether project is a sample/demo'),
+    createdAt: z.string().datetime().describe('Creation timestamp (ISO 8601)'),
+    updatedAt: z.string().datetime().describe('Last update timestamp (ISO 8601)'),
+    loggedDuration: z.number().nullable().describe('Total logged time in seconds'),
+    services: z.array(z.any()).nullable().describe('Associated services'),
+    billedAmount: z.number().describe('Total billed amount'),
+    billedStatus: BilledStatusEnum.describe('Billing status'),
+    retainerId: z.string().nullable().describe('Associated retainer ID'),
+    expenseMarkup: z.number().describe('Expense markup percentage'),
+    groupId: z.string().nullable().describe('Project group ID'),
+    group: z.any().nullable().describe('Project group details'),
+});
+/**
+ * Input schema for creating a project
+ */
+export const ProjectCreateInputSchema = z.object({
+    businessId: z.number().int().positive().describe('FreshBooks business ID (get from user_me -> businessMemberships[].business.id)'),
+    title: z.string().min(1).describe('Project title (required)'),
+    clientId: z.string().optional().describe('Associated client ID'),
+    description: z.string().optional().describe('Project description'),
+    dueDate: z.string().optional().describe('Project due date (YYYY-MM-DD)'),
+    budget: z.string().optional().describe('Project budget amount'),
+    fixedPrice: z.string().optional().describe('Fixed price amount'),
+    rate: z.string().optional().describe('Hourly rate'),
+    billingMethod: BillingMethodEnum.optional().describe('How project is billed'),
+    projectType: ProjectTypeEnum.optional().describe('Type of project'),
+    internal: z.boolean().optional().describe('Whether project is internal'),
+    projectManagerId: z.string().optional().describe('Project manager user ID'),
+});
+/**
+ * Input schema for updating a project
+ */
+export const ProjectUpdateInputSchema = z.object({
+    businessId: z.number().int().positive().describe('FreshBooks business ID (get from user_me -> businessMemberships[].business.id)'),
+    projectId: z.number().describe('Project ID to update'),
+    title: z.string().min(1).optional().describe('Project title'),
+    clientId: z.string().optional().describe('Associated client ID'),
+    description: z.string().optional().describe('Project description'),
+    dueDate: z.string().optional().describe('Project due date (YYYY-MM-DD)'),
+    budget: z.string().optional().describe('Project budget amount'),
+    fixedPrice: z.string().optional().describe('Fixed price amount'),
+    rate: z.string().optional().describe('Hourly rate'),
+    billingMethod: BillingMethodEnum.optional().describe('How project is billed'),
+    projectType: ProjectTypeEnum.optional().describe('Type of project'),
+    internal: z.boolean().optional().describe('Whether project is internal'),
+    projectManagerId: z.string().optional().describe('Project manager user ID'),
+    active: z.boolean().optional().describe('Whether project is active'),
+    complete: z.boolean().optional().describe('Whether project is complete'),
+});
+/**
+ * Input schema for listing projects
+ */
+export const ProjectListInputSchema = z.object({
+    businessId: z.number().int().positive().describe('FreshBooks business ID (get from user_me -> businessMemberships[].business.id)'),
+    page: z.number().int().min(1).default(1).optional().describe('Page number (1-indexed)'),
+    perPage: z
+        .number()
+        .int()
+        .min(1)
+        .max(100)
+        .default(30)
+        .optional()
+        .describe('Number of results per page (max 100)'),
+    clientId: z.string().optional().describe('Filter by client ID'),
+    active: z.boolean().optional().describe('Filter by active status'),
+    complete: z.boolean().optional().describe('Filter by completion status'),
+    internal: z.boolean().optional().describe('Filter by internal status'),
+    title: z.string().optional().describe('Filter by title (partial match)'),
+})
+    .merge(ProjectSortSchema)
+    .merge(ProjectIncludesSchema);
+/**
+ * Input schema for getting a single project
+ */
+export const ProjectSingleInputSchema = z.object({
+    businessId: z.number().int().positive().describe('FreshBooks business ID (get from user_me -> businessMemberships[].business.id)'),
+    projectId: z.number().describe('Project ID to retrieve'),
+    includes: z.array(z.enum(['client', 'services', 'group'])).optional().describe('Related data to include'),
+});
+/**
+ * Input schema for deleting a project
+ */
+export const ProjectDeleteInputSchema = z.object({
+    businessId: z.number().int().positive().describe('FreshBooks business ID (get from user_me -> businessMemberships[].business.id)'),
+    projectId: z.number().describe('Project ID to delete'),
+});
+/**
+ * Pagination metadata schema
+ */
+export const PaginationMetadataSchema = z.object({
+    page: z.number().describe('Current page number'),
+    pages: z.number().describe('Total number of pages'),
+    perPage: z.number().describe('Results per page'),
+    total: z.number().describe('Total number of results'),
+});
+/**
+ * Output schema for project list
+ */
+export const ProjectListOutputSchema = z.object({
+    projects: z.array(ProjectSchema).describe('Array of projects'),
+    pagination: PaginationMetadataSchema.describe('Pagination information'),
+});
+/**
+ * Output schema for single project operations
+ */
+export const ProjectSingleOutputSchema = ProjectSchema;
+/**
+ * Output schema for project deletion
+ */
+export const ProjectDeleteOutputSchema = z.object({
+    success: z.boolean().describe('Whether deletion was successful'),
+    projectId: z.number().describe('ID of deleted project'),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/tools/project/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/tools/project/schemas.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEzE;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,OAAO;IACP,YAAY;IACZ,UAAU;CACF,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAA2D;IACrG,KAAK,EAAE,oBAAoB;IAC3B,UAAU,EAAE,8BAA8B;IAC1C,QAAQ,EAAE,2BAA2B;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,QAAQ;IACR,UAAU;IACV,OAAO;CACC,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAA2D;IAClG,MAAM,EAAE,4CAA4C;IACpD,QAAQ,EAAE,mDAAmD;IAC7D,KAAK,EAAE,4CAA4C;CACpD,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAAgB,CAC/C,uBAAuB,EACvB,+BAA+B,CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CACvD,uBAAuB,EACvB,4BAA4B,CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC;IACtC,cAAc;IACd,cAAc;IACd,WAAW;IACX,kBAAkB;CACnB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AAE1E;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IACpD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC3C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IAClE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IACjF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;IAChE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;IAC5E,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IAC/D,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2CAA2C,CAAC;IACvF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IAC1E,aAAa,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IAC7E,WAAW,EAAE,eAAe,CAAC,QAAQ,CAAC,8CAA8C,CAAC;IACrF,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IAC3E,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IACzD,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IACpE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IAChE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC1E,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IAC7E,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAC9E,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IACrE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IACxD,YAAY,EAAE,gBAAgB,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACzD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACpE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IAC/D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAC3D,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;CAC5D,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gFAAgF,CAAC;IAClI,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IAC7D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;IAChE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IAClE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACxE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IAC/D,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAChE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;IACnD,aAAa,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IAC7E,WAAW,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACnE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IACxE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CAC5E,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gFAAgF,CAAC;IAClI,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;IACtD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC7D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;IAChE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IAClE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACxE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IAC/D,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAChE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;IACnD,aAAa,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IAC7E,WAAW,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACnE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IACxE,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IAC3E,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IACpE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC;CACzE,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gFAAgF,CAAC;IAClI,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IACvF,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,GAAG,CAAC;SACR,OAAO,CAAC,EAAE,CAAC;SACX,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC;IACnD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IAC/D,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IAClE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IACxE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IACtE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;CACzE,CAAC;KACC,KAAK,CAAC,iBAAiB,CAAC;KACxB,KAAK,CAAC,qBAAqB,CAAC,CAAC;AAEhC;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gFAAgF,CAAC;IAClI,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACxD,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CAC1G,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gFAAgF,CAAC;IAClI,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;CACvD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IAChD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IACnD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAChD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CACtD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IAC9D,UAAU,EAAE,wBAAwB,CAAC,QAAQ,CAAC,wBAAwB,CAAC;CACxE,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,aAAa,CAAC;AAEvD;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IAChE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;CACxD,CAAC,CAAC"}

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

@@ -0,0 +1,9 @@
+/**
+ * Report Tools - FreshBooks financial reports
+ *
+ * Exports all report-related MCP tools for financial reporting.
+ */
+export { paymentsCollectedReportTool } from "./report-payments-collected.js";
+export { profitLossReportTool } from "./report-profit-loss.js";
+export { taxSummaryReportTool } from "./report-tax-summary.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tools/report/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/tools/report/index.js

@@ -0,0 +1,11 @@
+/**
+ * Report Tools - FreshBooks financial reports
+ *
+ * Exports all report-related MCP tools for financial reporting.
+ */
+// Export schemas
+// Export tool definitions
+export { paymentsCollectedReportTool } from "./report-payments-collected.js";
+export { profitLossReportTool } from "./report-profit-loss.js";
+export { taxSummaryReportTool } from "./report-tax-summary.js";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tools/report/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,iBAAiB;AAEjB,0BAA0B;AAC1B,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/tools/report/report-payments-collected.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Payments Collected Report Tool
+ *
+ * Generate a report of payments collected during a date range.
+ */
+import { z } from "zod";
+import { PaymentsCollectedReportInputSchema, PaymentsCollectedReportOutputSchema } from "./schemas.js";
+import { FreshBooksClientWrapper } from "../../client/index.js";
+/**
+ * Tool definition for report_payments_collected
+ */
+export declare const paymentsCollectedReportTool: {
+    name: string;
+    description: string;
+    inputSchema: 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;
+    }>;
+    outputSchema: 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;
+        };
+    }>;
+    execute(input: z.infer<typeof PaymentsCollectedReportInputSchema>, client: FreshBooksClientWrapper): Promise<z.infer<typeof PaymentsCollectedReportOutputSchema>>;
+};
+//# sourceMappingURL=report-payments-collected.d.ts.map

package/dist/tools/report/report-payments-collected.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report-payments-collected.d.ts","sourceRoot":"","sources":["../../../src/tools/report/report-payments-collected.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kCAAkC,EAAE,mCAAmC,EAAE,MAAM,cAAc,CAAC;AAGvG,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAGhE;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAiD7B,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,UACjD,uBAAuB,GAC9B,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;CA+ChE,CAAC"}

package/dist/tools/report/report-payments-collected.js

@@ -0,0 +1,89 @@
+/**
+ * Payments Collected Report Tool
+ *
+ * Generate a report of payments collected during a date range.
+ */
+import { PaymentsCollectedReportInputSchema, PaymentsCollectedReportOutputSchema } from "./schemas.js";
+import { ErrorHandler } from "../../errors/error-handler.js";
+import { SearchQueryBuilder } from "@freshbooks/api/dist/models/builders/SearchQueryBuilder.js";
+/**
+ * Tool definition for report_payments_collected
+ */
+export const paymentsCollectedReportTool = {
+    name: "report_payments_collected",
+    description: `Generate a payments collected report for a date range.
+
+WHEN TO USE:
+- User wants to see payments received during a period
+- User asks "how much was collected", "show payment history"
+- Need cash flow or collection analysis
+- Preparing financial statements
+
+REQUIRED INFO:
+- Start date (YYYY-MM-DD format)
+- End date (YYYY-MM-DD format)
+- Account ID
+
+WHAT IT RETURNS:
+Detailed payment report including:
+- Each payment with date, client, invoice number
+- Payment amounts and methods
+- Payment notes
+- Total amount collected in the period
+
+COMMON DATE RANGES:
+- This month: Start of current month to today
+- Last month: First to last day of previous month
+- This quarter: Start of quarter to today
+- This year: January 1 to today
+- Custom: Any date range you specify
+
+EXAMPLE PROMPTS:
+- "Show payments collected in January 2024"
+- "How much did we collect last month?"
+- "Payment report from 2024-01-01 to 2024-03-31"
+- "Show me Q1 2024 payment collections"
+
+USE CASES:
+- Cash flow analysis
+- Revenue tracking
+- Collection performance
+- Financial reporting
+- Tax preparation
+
+RETURNS:
+List of all payments collected with totals and payment details.`,
+    inputSchema: PaymentsCollectedReportInputSchema,
+    outputSchema: PaymentsCollectedReportOutputSchema,
+    async execute(input, client) {
+        const handler = ErrorHandler.wrapHandler('report_payments_collected', async (input, _context) => {
+            const { accountId, startDate, endDate } = input;
+            // Validate date range
+            if (new Date(startDate) > new Date(endDate)) {
+                throw ErrorHandler.createValidationError('Start date must be before or equal to end date', { tool: 'report_payments_collected', accountId });
+            }
+            // Execute the API call
+            const result = await client.executeWithRetry("report_payments_collected", async (fbClient) => {
+                // Build query with date range
+                const search = new SearchQueryBuilder()
+                    .equals('start_date', startDate)
+                    .equals('end_date', endDate);
+                const response = await fbClient.reports.paymentsCollected(accountId, [search]);
+                if (!response.ok) {
+                    throw response.error;
+                }
+                return response.data;
+            });
+            // Extract report data
+            const reportData = result;
+            return {
+                startDate,
+                endDate,
+                payments: reportData.payments || [],
+                totalAmount: reportData.totalAmount || reportData.total || { amount: "0", code: "USD" },
+            };
+        });
+        return handler(input, { accountId: input.accountId });
+    },
+};
+//# sourceMappingURL=report-payments-collected.js.map

package/dist/tools/report/report-payments-collected.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report-payments-collected.js","sourceRoot":"","sources":["../../../src/tools/report/report-payments-collected.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,kCAAkC,EAAE,mCAAmC,EAAE,MAAM,cAAc,CAAC;AACvG,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAG7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4DAA4D,CAAC;AAEhG;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,IAAI,EAAE,2BAA2B;IACjC,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gEAyCiD;IAE9D,WAAW,EAAE,kCAAkC;IAC/C,YAAY,EAAE,mCAAmC;IAEjD,KAAK,CAAC,OAAO,CACX,KAAyD,EACzD,MAA+B;QAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CACtC,2BAA2B,EAC3B,KAAK,EAAE,KAAyD,EAAE,QAAqB,EAAE,EAAE;YACzF,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;YAEhD,sBAAsB;YACtB,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC5C,MAAM,YAAY,CAAC,qBAAqB,CACtC,gDAAgD,EAChD,EAAE,IAAI,EAAE,2BAA2B,EAAE,SAAS,EAAE,CACjD,CAAC;YACJ,CAAC;YAED,uBAAuB;YACvB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAC1C,2BAA2B,EAC3B,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACjB,8BAA8B;gBAC9B,MAAM,MAAM,GAAG,IAAI,kBAAkB,EAAE;qBACpC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC;qBAC/B,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAE/B,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;gBAE/E,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,sBAAsB;YACtB,MAAM,UAAU,GAAG,MAAa,CAAC;YAEjC,OAAO;gBACL,SAAS;gBACT,OAAO;gBACP,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,EAAE;gBACnC,WAAW,EAAE,UAAU,CAAC,WAAW,IAAI,UAAU,CAAC,KAAK,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;aACxF,CAAC;QACJ,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/report/report-profit-loss.d.ts

@@ -0,0 +1,139 @@
+/**
+ * Profit & Loss Report Tool
+ *
+ * Generate a profit and loss (P&L) statement for a date range.
+ */
+import { z } from "zod";
+import { ProfitLossReportInputSchema, ProfitLossReportOutputSchema } from "./schemas.js";
+import { FreshBooksClientWrapper } from "../../client/index.js";
+/**
+ * Tool definition for report_profit_loss
+ */
+export declare const profitLossReportTool: {
+    name: string;
+    description: string;
+    inputSchema: 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;
+    }>;
+    outputSchema: 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;
+    }>;
+    execute(input: z.infer<typeof ProfitLossReportInputSchema>, client: FreshBooksClientWrapper): Promise<z.infer<typeof ProfitLossReportOutputSchema>>;
+};
+//# sourceMappingURL=report-profit-loss.d.ts.map

package/dist/tools/report/report-profit-loss.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report-profit-loss.d.ts","sourceRoot":"","sources":["../../../src/tools/report/report-profit-loss.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,2BAA2B,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAC;AAGzF,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAGhE;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAwDtB,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,UAC1C,uBAAuB,GAC9B,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;CAiDzD,CAAC"}