conductor-node-mcp 12.8.1

package/src/tools/qbd/inventory-adjustments/create-qbd-inventory-adjustments.ts

@@ -0,0 +1,212 @@
+// 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.inventory_adjustments',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/quickbooks-desktop/inventory-adjustments',
+};
+
+export const tool: Tool = {
+  name: 'create_qbd_inventory_adjustments',
+  description: 'Creates a new inventory adjustment.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      accountId: {
+        type: 'string',
+        description:
+          'The account to which this inventory adjustment is posted for tracking inventory value changes.',
+      },
+      transactionDate: {
+        type: 'string',
+        description: 'The date of this inventory adjustment, 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}}"`).',
+      },
+      classId: {
+        type: 'string',
+        description:
+          "The inventory adjustment'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. A class defined here is automatically used in this inventory adjustment's line items unless overridden at the line item level.",
+      },
+      customerId: {
+        type: 'string',
+        description: 'The customer or customer-job associated with this inventory adjustment.',
+      },
+      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.',
+      },
+      inventorySiteId: {
+        type: 'string',
+        description:
+          'The site location where inventory for the item associated with this inventory adjustment is stored.',
+      },
+      lines: {
+        type: 'array',
+        description:
+          "The inventory adjustment's item lines, each representing the adjustment of an inventory item's quantity, value, serial number, or lot number.",
+        items: {
+          type: 'object',
+          properties: {
+            adjustLotNumber: {
+              type: 'object',
+              description: 'Adjusts the lot number of this inventory adjustment line.',
+              properties: {
+                adjustCount: {
+                  type: 'number',
+                  description:
+                    'The amount to adjust the count of the inventory item associated with this inventory adjustment line.',
+                },
+                expirationDate: {
+                  type: 'string',
+                  description:
+                    'The expiration date for the serial number or lot number of the item associated with this inventory adjustment line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.',
+                  format: 'date',
+                },
+                inventorySiteLocationId: {
+                  type: 'string',
+                  description:
+                    'The specific location (e.g., bin or shelf) within the inventory site where the item associated with this inventory adjustment line is stored.',
+                },
+                lotNumber: {
+                  type: 'string',
+                  description:
+                    'The lot number of the item associated with this inventory adjustment line. Used for tracking groups of inventory items that are purchased or manufactured together.',
+                },
+              },
+              required: [],
+            },
+            adjustQuantity: {
+              type: 'object',
+              description:
+                'Adjusts the inventory quantity of this inventory item either by setting a new quantity or by adjusting the current quantity up or down.',
+              properties: {
+                expirationDate: {
+                  type: 'string',
+                  description:
+                    'The expiration date for the serial number or lot number of the item associated with this inventory adjustment line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.',
+                  format: 'date',
+                },
+                inventorySiteLocationId: {
+                  type: 'string',
+                  description:
+                    'The specific location (e.g., bin or shelf) within the inventory site where the item associated with this inventory adjustment line is stored.',
+                },
+                lotNumber: {
+                  type: 'string',
+                  description:
+                    'The lot number of the item associated with this inventory adjustment line. Used for tracking groups of inventory items that are purchased or manufactured together.',
+                },
+                newQuantity: {
+                  type: 'number',
+                  description:
+                    'The new quantity for the inventory item associated with this inventory adjustment line.',
+                },
+                quantityDifference: {
+                  type: 'number',
+                  description:
+                    'Either a positive or negative number that shows the change in quantity for the inventory item associated with this inventory adjustment line. A positive number increases the quantity, while a negative number decreases it.',
+                },
+                serialNumber: {
+                  type: 'string',
+                  description:
+                    'The serial number of the item associated with this inventory adjustment line. This is used for tracking individual units of serialized inventory items.',
+                },
+              },
+              required: [],
+            },
+            adjustSerialNumber: {
+              type: 'object',
+              description:
+                'Adjusts the serial number of this inventory adjustment line. This is used for tracking individual units of serialized inventory items.',
+              properties: {
+                addSerialNumber: {
+                  type: 'string',
+                  description:
+                    'The serial number, which represents a unique unit of the inventory item associated with this inventory adjustment line, to add to inventory.',
+                },
+                expirationDate: {
+                  type: 'string',
+                  description:
+                    'The expiration date for the serial number or lot number of the item associated with this inventory adjustment line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.',
+                  format: 'date',
+                },
+                inventorySiteLocationId: {
+                  type: 'string',
+                  description:
+                    'The specific location (e.g., bin or shelf) within the inventory site where the item associated with this inventory adjustment line is stored.',
+                },
+                removeSerialNumber: {
+                  type: 'string',
+                  description:
+                    'The serial number, which represents a unique unit of the inventory item associated with this inventory adjustment line, to remove from inventory.',
+                },
+              },
+              required: [],
+            },
+            adjustValue: {
+              type: 'object',
+              description:
+                'Adjusts the total value of the entire stock of this inventory item by setting a new monetary value, and optionally by setting a new quantity.',
+              properties: {
+                newQuantity: {
+                  type: 'number',
+                  description:
+                    'The new quantity for the inventory item associated with this inventory adjustment line.',
+                },
+                newValue: {
+                  type: 'string',
+                  description:
+                    'The new total value of the entire stock of the inventory item associated with this inventory adjustment line.\n\n**NOTE**: The new value does _not_ have to equal `quantityOnHand` times `purchaseCost`.',
+                },
+                quantityDifference: {
+                  type: 'number',
+                  description:
+                    'Either a positive or negative number that shows the change in quantity for the inventory item associated with this inventory adjustment line. A positive number increases the quantity, while a negative number decreases it.',
+                },
+                valueDifference: {
+                  type: 'number',
+                  description:
+                    'Either a positive or negative number that shows the change in the total value of the entire stock of the inventory item associated with this inventory adjustment line. A positive number increases the value, while a negative number decreases it.',
+                },
+              },
+              required: [],
+            },
+            itemId: {
+              type: 'string',
+              description: 'The inventory item associated with this inventory adjustment line.',
+            },
+          },
+          required: [],
+        },
+      },
+      memo: {
+        type: 'string',
+        description: 'A memo or note for this inventory adjustment.',
+      },
+      refNumber: {
+        type: 'string',
+        description:
+          'The case-sensitive user-defined reference number for this inventory adjustment, 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.inventoryAdjustments.create(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/inventory-adjustments/delete-qbd-inventory-adjustments.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.inventory_adjustments',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'delete',
+  httpPath: '/quickbooks-desktop/inventory-adjustments/{id}',
+};
+
+export const tool: Tool = {
+  name: 'delete_qbd_inventory_adjustments',
+  description:
+    'Permanently deletes a an inventory adjustment. The deletion will fail if the inventory adjustment 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 inventory adjustment 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.inventoryAdjustments.delete(id, body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/inventory-adjustments/list-qbd-inventory-adjustments.ts

@@ -0,0 +1,129 @@
+// 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.inventory_adjustments',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/quickbooks-desktop/inventory-adjustments',
+};
+
+export const tool: Tool = {
+  name: 'list_qbd_inventory_adjustments',
+  description:
+    'Returns a list of inventory adjustments. NOTE: QuickBooks Desktop does not support pagination for inventory adjustments; hence, there is no `cursor` parameter. Users typically have few inventory adjustments.',
+  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 inventory adjustments associated with these accounts.',
+        items: {
+          type: 'string',
+        },
+      },
+      customerIds: {
+        type: 'array',
+        description: 'Filter for inventory adjustments associated with these customers.',
+        items: {
+          type: 'string',
+        },
+      },
+      ids: {
+        type: 'array',
+        description:
+          'Filter for specific inventory adjustments 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`.',
+      },
+      itemIds: {
+        type: 'array',
+        description: 'Filter for inventory adjustments containing these inventory items.',
+        items: {
+          type: 'string',
+        },
+      },
+      limit: {
+        type: 'integer',
+        description:
+          'The maximum number of objects to return.\n\n**IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for inventory adjustments. This parameter will limit the response size, but you cannot fetch subsequent results using a cursor. For pagination, use the name-range parameters instead (e.g., `nameFrom=A&nameTo=B`).\n\nWhen this parameter is omitted, the endpoint returns all inventory adjustments without limit, unlike paginated endpoints which default to 150 records. This is acceptable because inventory adjustments typically have low record counts.',
+      },
+      refNumberContains: {
+        type: 'string',
+        description:
+          'Filter for inventory adjustments whose `refNumber` contains this substring. NOTE: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.',
+      },
+      refNumberEndsWith: {
+        type: 'string',
+        description:
+          'Filter for inventory adjustments 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 inventory adjustments 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 inventory adjustments 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 inventory adjustments 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 inventory adjustments 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 inventory adjustments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD).',
+        format: 'date',
+      },
+      transactionDateTo: {
+        type: 'string',
+        description:
+          'Filter for inventory adjustments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD).',
+        format: 'date',
+      },
+      updatedAfter: {
+        type: 'string',
+        description:
+          'Filter for inventory adjustments 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 inventory adjustments 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.inventoryAdjustments.list(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/inventory-adjustments/retrieve-qbd-inventory-adjustments.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.inventory_adjustments',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/quickbooks-desktop/inventory-adjustments/{id}',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_qbd_inventory_adjustments',
+  description: 'Retrieves an inventory adjustment by ID.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      id: {
+        type: 'string',
+        description: 'The QuickBooks-assigned unique identifier of the inventory adjustment 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.inventoryAdjustments.retrieve(id, body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/qbd/inventory-adjustments/update-qbd-inventory-adjustments.ts

@@ -0,0 +1,133 @@
+// 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.inventory_adjustments',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/quickbooks-desktop/inventory-adjustments/{id}',
+};
+
+export const tool: Tool = {
+  name: 'update_qbd_inventory_adjustments',
+  description: 'Updates an existing inventory adjustment.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      id: {
+        type: 'string',
+        description: 'The QuickBooks-assigned unique identifier of the inventory adjustment to update.',
+      },
+      revisionNumber: {
+        type: 'string',
+        description:
+          "The current QuickBooks-assigned revision number of the inventory adjustment 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}}"`).',
+      },
+      accountId: {
+        type: 'string',
+        description:
+          'The account to which this inventory adjustment is posted for tracking inventory value changes.',
+      },
+      classId: {
+        type: 'string',
+        description:
+          "The inventory adjustment'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. A class defined here is automatically used in this inventory adjustment's line items unless overridden at the line item level.",
+      },
+      customerId: {
+        type: 'string',
+        description: 'The customer or customer-job associated with this inventory adjustment.',
+      },
+      inventorySiteId: {
+        type: 'string',
+        description:
+          'The site location where inventory for the item associated with this inventory adjustment is stored.',
+      },
+      lines: {
+        type: 'array',
+        description:
+          "The inventory adjustment's item lines, each representing the adjustment of an inventory item's quantity, value, serial number, or lot number.\n\n**IMPORTANT**:\n\n1. Including this array in your update request will **REPLACE** all existing item lines for the inventory adjustment with this array. To keep any existing item lines, you must include them in this array even if they have not changed. **Any item lines not included will be removed.**\n\n2. To add a new item line, include it here with the `id` field set to `-1`.\n\n3. If you do not wish to modify any item lines, omit this field entirely to keep them unchanged.",
+        items: {
+          type: 'object',
+          properties: {
+            id: {
+              type: 'string',
+              description:
+                'The QuickBooks-assigned unique identifier of an existing inventory adjustment line you wish to retain or update.\n\n**IMPORTANT**: Set this field to `-1` for new inventory adjustment lines you wish to add.',
+            },
+            adjustCount: {
+              type: 'number',
+              description:
+                'The amount to adjust the count of the inventory item associated with this inventory adjustment line.',
+            },
+            expirationDate: {
+              type: 'string',
+              description:
+                'The expiration date for the serial number or lot number of the item associated with this inventory adjustment line, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for perishable or time-sensitive inventory items. Note that this field is only supported on QuickBooks Desktop 2023 or later.',
+              format: 'date',
+            },
+            inventorySiteLocationId: {
+              type: 'string',
+              description:
+                'The specific location (e.g., bin or shelf) within the inventory site where the item associated with this inventory adjustment line is stored.',
+            },
+            itemId: {
+              type: 'string',
+              description: 'The inventory item associated with this inventory adjustment line.',
+            },
+            lotNumber: {
+              type: 'string',
+              description:
+                'The lot number of the item associated with this inventory adjustment line. Used for tracking groups of inventory items that are purchased or manufactured together.',
+            },
+            quantityDifference: {
+              type: 'number',
+              description:
+                'Either a positive or negative number that shows the change in quantity for the inventory item associated with this inventory adjustment line. A positive number increases the quantity, while a negative number decreases it.',
+            },
+            serialNumber: {
+              type: 'string',
+              description:
+                'The serial number of the item associated with this inventory adjustment line. This is used for tracking individual units of serialized inventory items.',
+            },
+            valueDifference: {
+              type: 'number',
+              description:
+                'Either a positive or negative number that shows the change in the total value of the entire stock of the inventory item associated with this inventory adjustment line. A positive number increases the value, while a negative number decreases it.',
+            },
+          },
+          required: ['id'],
+        },
+      },
+      memo: {
+        type: 'string',
+        description: 'A memo or note for this inventory adjustment.',
+      },
+      refNumber: {
+        type: 'string',
+        description:
+          'The case-sensitive user-defined reference number for this inventory adjustment, 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 inventory adjustment, 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.inventoryAdjustments.update(id, body);
+};
+
+export default { metadata, tool, handler };