conductor-node-mcp 12.8.1

package/src/tools/qbd/item-sites/retrieve-qbd-item-sites.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Conductor from 'conductor-node';
+
+export const metadata: Metadata = {
+  resource: 'qbd.item_sites',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/quickbooks-desktop/item-sites/{id}',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_qbd_item_sites',
+  description: 'Retrieves an item site by ID.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      id: {
+        type: 'string',
+        description: 'The QuickBooks-assigned unique identifier of the item site to retrieve.',
+      },
+      'Conductor-End-User-Id': {
+        type: 'string',
+        description:
+          'The ID of the EndUser to receive this request (e.g., `"Conductor-End-User-Id: {{END_USER_ID}}"`).',
+      },
+    },
+  },
+};
+
+export const handler = (client: Conductor, args: Record<string, unknown> | undefined) => {
+  const { id, ...body } = args as any;
+  return client.qbd.itemSites.retrieve(id, body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/journal-entries/create-qbd-journal-entries.ts

@@ -0,0 +1,162 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Conductor from 'conductor-node';
+
+export const metadata: Metadata = {
+  resource: 'qbd.journal_entries',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/quickbooks-desktop/journal-entries',
+};
+
+export const tool: Tool = {
+  name: 'create_qbd_journal_entries',
+  description: 'Creates a new journal entry.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      transactionDate: {
+        type: 'string',
+        description: 'The date of this journal entry, in ISO 8601 format (YYYY-MM-DD).',
+        format: 'date',
+      },
+      'Conductor-End-User-Id': {
+        type: 'string',
+        description:
+          'The ID of the EndUser to receive this request (e.g., `"Conductor-End-User-Id: {{END_USER_ID}}"`).',
+      },
+      areAmountsEnteredInHomeCurrency: {
+        type: 'boolean',
+        description:
+          "Indicates whether the amounts in this journal entry were entered in the company's home currency rather than a foreign currency. When `true`, amounts are in the home currency regardless of the `currency` field.",
+      },
+      creditLines: {
+        type: 'array',
+        description: "The journal entry's credit lines.",
+        items: {
+          type: 'object',
+          properties: {
+            accountId: {
+              type: 'string',
+              description:
+                'The account to which this journal credit line is being credited. This will increase the balance of this account.',
+            },
+            amount: {
+              type: 'string',
+              description:
+                'The monetary amount of this journal credit line, represented as a decimal string.',
+            },
+            billingStatus: {
+              type: 'string',
+              description: 'The billing status of this journal credit line.',
+              enum: ['billable', 'has_been_billed', 'not_billable'],
+            },
+            classId: {
+              type: 'string',
+              description:
+                "The journal credit line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. If a class is specified for the entire parent transaction, it is automatically applied to all journal credit lines unless overridden here, at the transaction line level.",
+            },
+            entityId: {
+              type: 'string',
+              description:
+                "The customer, vendor, employee, or other entity associated with this journal credit line.\n\n**IMPORTANT**: If the journal credit line's `account` is an Accounts Receivable (A/R) account, this field must refer to a customer. If the journal credit line's `account` is an Accounts Payable (A/P) account, this field must refer to a vendor. If these requirements are not met, QuickBooks Desktop will not record the transaction.",
+            },
+            memo: {
+              type: 'string',
+              description: 'A memo or note for this journal credit line.',
+            },
+            salesTaxItemId: {
+              type: 'string',
+              description:
+                "The sales-tax item used to calculate the actual tax amount for this journal credit line's transactions by applying a specific tax rate collected for a single tax agency. Unlike `salesTaxCode`, which only indicates general taxability, this field drives the actual tax calculation and reporting.",
+            },
+          },
+          required: ['accountId'],
+        },
+      },
+      currencyId: {
+        type: 'string',
+        description:
+          "The journal entry's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.",
+      },
+      debitLines: {
+        type: 'array',
+        description: "The journal entry's debit lines.",
+        items: {
+          type: 'object',
+          properties: {
+            accountId: {
+              type: 'string',
+              description:
+                'The account to which this journal debit line is being debited. This will decrease the balance of this account.',
+            },
+            amount: {
+              type: 'string',
+              description: 'The monetary amount of this journal debit line, represented as a decimal string.',
+            },
+            billingStatus: {
+              type: 'string',
+              description: 'The billing status of this journal debit line.',
+              enum: ['billable', 'has_been_billed', 'not_billable'],
+            },
+            classId: {
+              type: 'string',
+              description:
+                "The journal debit line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. If a class is specified for the entire parent transaction, it is automatically applied to all journal debit lines unless overridden here, at the transaction line level.",
+            },
+            entityId: {
+              type: 'string',
+              description:
+                "The customer, vendor, employee, or other entity associated with this journal debit line.\n\n**IMPORTANT**: If the journal debit line's `account` is an Accounts Receivable (A/R) account, this field must refer to a customer. If the journal debit line's `account` is an Accounts Payable (A/P) account, this field must refer to a vendor. If these requirements are not met, QuickBooks Desktop will not record the transaction.",
+            },
+            memo: {
+              type: 'string',
+              description: 'A memo or note for this journal debit line.',
+            },
+            salesTaxItemId: {
+              type: 'string',
+              description:
+                "The sales-tax item used to calculate the actual tax amount for this journal debit line's transactions by applying a specific tax rate collected for a single tax agency. Unlike `salesTaxCode`, which only indicates general taxability, this field drives the actual tax calculation and reporting.",
+            },
+          },
+          required: ['accountId'],
+        },
+      },
+      exchangeRate: {
+        type: 'number',
+        description:
+          "The market exchange rate between this journal entry's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).",
+      },
+      externalId: {
+        type: 'string',
+        description:
+          'A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.\n\n**IMPORTANT**: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.',
+      },
+      isAdjustment: {
+        type: 'boolean',
+        description:
+          'Indicates whether this journal entry is an adjustment entry. When `true`, QuickBooks retains the original entry information to maintain an audit trail of the adjustments.',
+      },
+      isHomeCurrencyAdjustment: {
+        type: 'boolean',
+        description:
+          "Indicates whether this journal entry is an adjustment made in the company's home currency for a transaction that was originally recorded in a foreign currency.",
+      },
+      refNumber: {
+        type: 'string',
+        description:
+          'The case-sensitive user-defined reference number for this journal entry, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does *not* auto-increment).',
+      },
+    },
+  },
+};
+
+export const handler = (client: Conductor, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.qbd.journalEntries.create(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/journal-entries/delete-qbd-journal-entries.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Conductor from 'conductor-node';
+
+export const metadata: Metadata = {
+  resource: 'qbd.journal_entries',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'delete',
+  httpPath: '/quickbooks-desktop/journal-entries/{id}',
+};
+
+export const tool: Tool = {
+  name: 'delete_qbd_journal_entries',
+  description:
+    'Permanently deletes a a journal entry. The deletion will fail if the journal entry is currently in use or has any linked transactions that are in use.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      id: {
+        type: 'string',
+        description: 'The QuickBooks-assigned unique identifier of the journal entry to delete.',
+      },
+      'Conductor-End-User-Id': {
+        type: 'string',
+        description:
+          'The ID of the EndUser to receive this request (e.g., `"Conductor-End-User-Id: {{END_USER_ID}}"`).',
+      },
+    },
+  },
+};
+
+export const handler = (client: Conductor, args: Record<string, unknown> | undefined) => {
+  const { id, ...body } = args as any;
+  return client.qbd.journalEntries.delete(id, body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/journal-entries/list-qbd-journal-entries.ts

@@ -0,0 +1,135 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Conductor from 'conductor-node';
+
+export const metadata: Metadata = {
+  resource: 'qbd.journal_entries',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/quickbooks-desktop/journal-entries',
+};
+
+export const tool: Tool = {
+  name: 'list_qbd_journal_entries',
+  description:
+    'Returns a list of journal entries. Use the `cursor` parameter to paginate through the results.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      'Conductor-End-User-Id': {
+        type: 'string',
+        description:
+          'The ID of the EndUser to receive this request (e.g., `"Conductor-End-User-Id: {{END_USER_ID}}"`).',
+      },
+      accountIds: {
+        type: 'array',
+        description: 'Filter for journal entries associated with these accounts.',
+        items: {
+          type: 'string',
+        },
+      },
+      currencyIds: {
+        type: 'array',
+        description: 'Filter for journal entries in these currencies.',
+        items: {
+          type: 'string',
+        },
+      },
+      cursor: {
+        type: 'string',
+        description:
+          'The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.',
+      },
+      entityIds: {
+        type: 'array',
+        description:
+          'Filter for journal entries associated with these entities (customers, vendors, employees, etc.).',
+        items: {
+          type: 'string',
+        },
+      },
+      ids: {
+        type: 'array',
+        description:
+          'Filter for specific journal entries by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.',
+        items: {
+          type: 'string',
+        },
+      },
+      includeLineItems: {
+        type: 'boolean',
+        description: 'Whether to include line items in the response. Defaults to `true`.',
+      },
+      limit: {
+        type: 'integer',
+        description:
+          'The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.',
+      },
+      refNumberContains: {
+        type: 'string',
+        description:
+          'Filter for journal entries whose `refNumber` contains this substring. NOTE: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.',
+      },
+      refNumberEndsWith: {
+        type: 'string',
+        description:
+          'Filter for journal entries whose `refNumber` ends with this substring. NOTE: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.',
+      },
+      refNumberFrom: {
+        type: 'string',
+        description:
+          'Filter for journal entries whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.',
+      },
+      refNumbers: {
+        type: 'array',
+        description:
+          'Filter for specific journal entries by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.',
+        items: {
+          type: 'string',
+        },
+      },
+      refNumberStartsWith: {
+        type: 'string',
+        description:
+          'Filter for journal entries whose `refNumber` starts with this substring. NOTE: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`.',
+      },
+      refNumberTo: {
+        type: 'string',
+        description:
+          'Filter for journal entries whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.',
+      },
+      transactionDateFrom: {
+        type: 'string',
+        description:
+          'Filter for journal entries whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).',
+        format: 'date',
+      },
+      transactionDateTo: {
+        type: 'string',
+        description:
+          'Filter for journal entries whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).',
+        format: 'date',
+      },
+      updatedAfter: {
+        type: 'string',
+        description:
+          'Filter for journal entries updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.',
+      },
+      updatedBefore: {
+        type: 'string',
+        description:
+          'Filter for journal entries updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.',
+      },
+    },
+  },
+};
+
+export const handler = (client: Conductor, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.qbd.journalEntries.list(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/journal-entries/retrieve-qbd-journal-entries.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Conductor from 'conductor-node';
+
+export const metadata: Metadata = {
+  resource: 'qbd.journal_entries',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/quickbooks-desktop/journal-entries/{id}',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_qbd_journal_entries',
+  description: 'Retrieves a journal entry by ID.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      id: {
+        type: 'string',
+        description: 'The QuickBooks-assigned unique identifier of the journal entry to retrieve.',
+      },
+      'Conductor-End-User-Id': {
+        type: 'string',
+        description:
+          'The ID of the EndUser to receive this request (e.g., `"Conductor-End-User-Id: {{END_USER_ID}}"`).',
+      },
+    },
+  },
+};
+
+export const handler = (client: Conductor, args: Record<string, unknown> | undefined) => {
+  const { id, ...body } = args as any;
+  return client.qbd.journalEntries.retrieve(id, body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/journal-entries/update-qbd-journal-entries.ts

@@ -0,0 +1,127 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Conductor from 'conductor-node';
+
+export const metadata: Metadata = {
+  resource: 'qbd.journal_entries',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/quickbooks-desktop/journal-entries/{id}',
+};
+
+export const tool: Tool = {
+  name: 'update_qbd_journal_entries',
+  description: 'Updates an existing journal entry.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      id: {
+        type: 'string',
+        description: 'The QuickBooks-assigned unique identifier of the journal entry to update.',
+      },
+      revisionNumber: {
+        type: 'string',
+        description:
+          "The current QuickBooks-assigned revision number of the journal entry object you are updating, which you can get by fetching the object first. Provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error.",
+      },
+      'Conductor-End-User-Id': {
+        type: 'string',
+        description:
+          'The ID of the EndUser to receive this request (e.g., `"Conductor-End-User-Id: {{END_USER_ID}}"`).',
+      },
+      areAmountsEnteredInHomeCurrency: {
+        type: 'boolean',
+        description:
+          "Indicates whether the amounts in this journal entry were entered in the company's home currency rather than a foreign currency. When `true`, amounts are in the home currency regardless of the `currency` field.",
+      },
+      currencyId: {
+        type: 'string',
+        description:
+          "The journal entry's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.",
+      },
+      exchangeRate: {
+        type: 'number',
+        description:
+          "The market exchange rate between this journal entry's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).",
+      },
+      isAdjustment: {
+        type: 'boolean',
+        description:
+          'Indicates whether this journal entry is an adjustment entry. When `true`, QuickBooks retains the original entry information to maintain an audit trail of the adjustments.',
+      },
+      lines: {
+        type: 'array',
+        description:
+          "The journal entry's credit and debit lines.\n\n**IMPORTANT**: When updating journal entries, you must include ALL existing journal lines (both credit and debit) in your update request, even if you only want to modify a single line. QuickBooks will automatically delete any existing lines that are not included in the update request, which is why all lines must be provided in a single array when updating.",
+        items: {
+          type: 'object',
+          properties: {
+            id: {
+              type: 'string',
+              description:
+                'The QuickBooks-assigned unique identifier of an existing journal line you wish to retain or update.\n\n**IMPORTANT**: Set this field to `-1` for new journal lines you wish to add.',
+            },
+            accountId: {
+              type: 'string',
+              description: 'The account to which this journal line is being credited or debited.',
+            },
+            amount: {
+              type: 'string',
+              description: 'The monetary amount of this journal line, represented as a decimal string.',
+            },
+            billingStatus: {
+              type: 'string',
+              description: 'The billing status of this journal line.',
+              enum: ['billable', 'has_been_billed', 'not_billable'],
+            },
+            classId: {
+              type: 'string',
+              description:
+                "The journal line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. If a class is specified for the entire parent transaction, it is automatically applied to all journal lines unless overridden here, at the transaction line level.",
+            },
+            entityId: {
+              type: 'string',
+              description:
+                "The customer, vendor, employee, or other entity associated with this journal line.\n\n**IMPORTANT**: If the journal line's `account` is an Accounts Receivable (A/R) account, this field must refer to a customer. If the journal line's `account` is an Accounts Payable (A/P) account, this field must refer to a vendor. If these requirements are not met, QuickBooks Desktop will not record the transaction.",
+            },
+            journalLineType: {
+              type: 'string',
+              description: 'The type of journal line (debit or credit).',
+              enum: ['debit', 'credit'],
+            },
+            memo: {
+              type: 'string',
+              description: 'A memo or note for this journal line.',
+            },
+            salesTaxItemId: {
+              type: 'string',
+              description:
+                "The sales-tax item used to calculate the actual tax amount for this journal line's transactions by applying a specific tax rate collected for a single tax agency. Unlike `salesTaxCode`, which only indicates general taxability, this field drives the actual tax calculation and reporting.",
+            },
+          },
+          required: ['id'],
+        },
+      },
+      refNumber: {
+        type: 'string',
+        description:
+          'The case-sensitive user-defined reference number for this journal entry, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.',
+      },
+      transactionDate: {
+        type: 'string',
+        description: 'The date of this journal entry, in ISO 8601 format (YYYY-MM-DD).',
+        format: 'date',
+      },
+    },
+  },
+};
+
+export const handler = (client: Conductor, args: Record<string, unknown> | undefined) => {
+  const { id, ...body } = args as any;
+  return client.qbd.journalEntries.update(id, body);
+};
+
+export default { metadata, tool, handler };