conductor-node-mcp 12.8.1

package/tools/qbd/item-receipts/create-qbd-item-receipts.js

@@ -0,0 +1,305 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.tool = exports.metadata = void 0;
+exports.metadata = {
+    resource: 'qbd.item_receipts',
+    operation: 'write',
+    tags: [],
+    httpMethod: 'post',
+    httpPath: '/quickbooks-desktop/item-receipts',
+};
+exports.tool = {
+    name: 'create_qbd_item_receipts',
+    description: 'Creates a new item receipt.',
+    inputSchema: {
+        type: 'object',
+        properties: {
+            transactionDate: {
+                type: 'string',
+                description: 'The date of this item receipt, in ISO 8601 format (YYYY-MM-DD).',
+                format: 'date',
+            },
+            vendorId: {
+                type: 'string',
+                description: 'The vendor who sent this item receipt for goods or services purchased.',
+            },
+            '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}}"`).',
+            },
+            exchangeRate: {
+                type: 'number',
+                description: "The market exchange rate between this item receipt'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).",
+            },
+            expenseLines: {
+                type: 'array',
+                description: "The item receipt's expense lines, each representing one line in this expense.",
+                items: {
+                    type: 'object',
+                    properties: {
+                        accountId: {
+                            type: 'string',
+                            description: 'The expense account being debited (increased) for this expense line. The corresponding account being credited is usually a liability account (e.g., Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction type.',
+                        },
+                        amount: {
+                            type: 'string',
+                            description: 'The monetary amount of this expense line, represented as a decimal string.',
+                        },
+                        billingStatus: {
+                            type: 'string',
+                            description: 'The billing status of this expense line.',
+                            enum: ['billable', 'has_been_billed', 'not_billable'],
+                        },
+                        classId: {
+                            type: 'string',
+                            description: "The expense 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 expense lines unless overridden here, at the transaction line level.",
+                        },
+                        customFields: {
+                            type: 'array',
+                            description: 'The custom fields for the expense line object, added as user-defined data extensions, not included in the standard QuickBooks object.',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    name: {
+                                        type: 'string',
+                                        description: 'The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI.',
+                                    },
+                                    ownerId: {
+                                        type: 'string',
+                                        description: 'The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects.',
+                                    },
+                                    value: {
+                                        type: 'string',
+                                        description: "The value of this custom field. The maximum length depends on the field's data type.",
+                                    },
+                                },
+                                required: ['name', 'ownerId', 'value'],
+                            },
+                        },
+                        memo: {
+                            type: 'string',
+                            description: 'A memo or note for this expense line.',
+                        },
+                        payeeId: {
+                            type: 'string',
+                            description: "If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the expense's vendor (not the customer). If `account` refers to any other type of account, `payee` refers to the expense's customer (not the vendor).",
+                        },
+                        salesRepresentativeId: {
+                            type: 'string',
+                            description: "The expense line's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.",
+                        },
+                        salesTaxCodeId: {
+                            type: 'string',
+                            description: 'The sales-tax code for this expense line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.\n\nDefault codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.',
+                        },
+                    },
+                    required: [],
+                },
+            },
+            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.',
+            },
+            itemGroupLines: {
+                type: 'array',
+                description: "The item receipt's item group lines, each representing a predefined set of items bundled together because they are commonly purchased together or grouped for faster entry.",
+                items: {
+                    type: 'object',
+                    properties: {
+                        itemGroupId: {
+                            type: 'string',
+                            description: "The item group line's item group, representing a predefined set of items bundled because they are commonly purchased together or grouped for faster entry.",
+                        },
+                        customFields: {
+                            type: 'array',
+                            description: 'The custom fields for the item group line object, added as user-defined data extensions, not included in the standard QuickBooks object.',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    name: {
+                                        type: 'string',
+                                        description: 'The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI.',
+                                    },
+                                    ownerId: {
+                                        type: 'string',
+                                        description: 'The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects.',
+                                    },
+                                    value: {
+                                        type: 'string',
+                                        description: "The value of this custom field. The maximum length depends on the field's data type.",
+                                    },
+                                },
+                                required: ['name', 'ownerId', 'value'],
+                            },
+                        },
+                        inventorySiteId: {
+                            type: 'string',
+                            description: 'The site location where inventory for the item group associated with this item group line is stored.',
+                        },
+                        inventorySiteLocationId: {
+                            type: 'string',
+                            description: 'The specific location (e.g., bin or shelf) within the inventory site where the item group associated with this item group line is stored.',
+                        },
+                        quantity: {
+                            type: 'number',
+                            description: 'The quantity of the item group associated with this item group line. This field cannot be cleared.\n\n**NOTE**: Do not use this field if the associated item group is a discount item group.',
+                        },
+                        unitOfMeasure: {
+                            type: 'string',
+                            description: "The unit-of-measure used for the `quantity` in this item group line. Must be a valid unit within the item's available units of measure.",
+                        },
+                    },
+                    required: ['itemGroupId'],
+                },
+            },
+            itemLines: {
+                type: 'array',
+                description: "The item receipt's item lines, each representing the purchase of a specific item or service.",
+                items: {
+                    type: 'object',
+                    properties: {
+                        amount: {
+                            type: 'string',
+                            description: 'The monetary amount of this item line, represented as a decimal string. If both `quantity` and `cost` are specified but not `amount`, QuickBooks will use them to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified, then QuickBooks will calculate `amount` based on a `quantity` of `1` and the suggested `cost`. This field cannot be cleared.',
+                        },
+                        billingStatus: {
+                            type: 'string',
+                            description: 'The billing status of this item line.',
+                            enum: ['billable', 'has_been_billed', 'not_billable'],
+                        },
+                        classId: {
+                            type: 'string',
+                            description: "The item 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 item lines unless overridden here, at the transaction line level.",
+                        },
+                        cost: {
+                            type: 'string',
+                            description: 'The cost of this item line, represented as a decimal string. If both `quantity` and `amount` are specified but not `cost`, QuickBooks will use them to calculate `cost`.',
+                        },
+                        customerId: {
+                            type: 'string',
+                            description: 'The customer or customer-job associated with this item line.',
+                        },
+                        customFields: {
+                            type: 'array',
+                            description: 'The custom fields for the item line object, added as user-defined data extensions, not included in the standard QuickBooks object.',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    name: {
+                                        type: 'string',
+                                        description: 'The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI.',
+                                    },
+                                    ownerId: {
+                                        type: 'string',
+                                        description: 'The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects.',
+                                    },
+                                    value: {
+                                        type: 'string',
+                                        description: "The value of this custom field. The maximum length depends on the field's data type.",
+                                    },
+                                },
+                                required: ['name', 'ownerId', 'value'],
+                            },
+                        },
+                        description: {
+                            type: 'string',
+                            description: 'A description of this item line.',
+                        },
+                        expirationDate: {
+                            type: 'string',
+                            description: 'The expiration date for the serial number or lot number of the item associated with this item 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',
+                        },
+                        inventorySiteId: {
+                            type: 'string',
+                            description: 'The site location where inventory for the item associated with this item line is stored.',
+                        },
+                        inventorySiteLocationId: {
+                            type: 'string',
+                            description: 'The specific location (e.g., bin or shelf) within the inventory site where the item associated with this item line is stored.',
+                        },
+                        itemId: {
+                            type: 'string',
+                            description: 'The item associated with this item line. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.',
+                        },
+                        linkToTransactionLine: {
+                            type: 'object',
+                            description: "An existing transaction line that you wish to link to this item line. Note that this only links to a single transaction line item, not an entire transaction. If you want to link an entire transaction and bring in all its lines, instead use the field `linkToTransactionIds` on the parent transaction, if available. If the parent transaction is a bill or an item receipt, you can only link to purchase orders; QuickBooks does not support linking these transactions to other transaction types.\n\nTransaction lines can only be linked when creating this item line and cannot be unlinked later.\n\n**IMPORTANT**: If you use `linkToTransactionLine` on this item line, you cannot use the field `item` on this line (QuickBooks will return an error) because this field brings in all of the item information you need. You can, however, specify whatever `quantity` or `rate` that you want, or any other transaction line element other than `item`.\n\nIf the parent transaction supports the `linkToTransactionIds` field, you can use both `linkToTransactionLine` (on this item line) and `linkToTransactionIds` (on its parent transaction) in the same request as long as they do NOT link to the same transaction (otherwise, QuickBooks will return an error). QuickBooks will also return an error if you attempt to link a transaction that is empty or already closed.\n\n**IMPORTANT**: By default, QuickBooks will not return any information about the linked transaction line in this endpoint's response even when this request is successful. To see the transaction line linked via this field, refetch the parent transaction and check the `linkedTransactions` response field. If fetching a list of transactions, you must also specify the parameter `includeLinkedTransactions=true` to see the `linkedTransactions` response field.",
+                            properties: {
+                                transactionId: {
+                                    type: 'string',
+                                    description: 'The ID of the transaction to which to link this transaction.',
+                                },
+                                transactionLineId: {
+                                    type: 'string',
+                                    description: 'The ID of the transaction line to which to link this transaction.',
+                                },
+                            },
+                            required: ['transactionId', 'transactionLineId'],
+                        },
+                        lotNumber: {
+                            type: 'string',
+                            description: 'The lot number of the item associated with this item line. Used for tracking groups of inventory items that are purchased or manufactured together.',
+                        },
+                        overrideItemAccountId: {
+                            type: 'string',
+                            description: 'The account to use for this item line, overriding the default account associated with the item.',
+                        },
+                        quantity: {
+                            type: 'number',
+                            description: 'The quantity of the item associated with this item line. This field cannot be cleared.\n\n**NOTE**: Do not use this field if the associated item is a discount item.',
+                        },
+                        salesRepresentativeId: {
+                            type: 'string',
+                            description: "The item line's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.",
+                        },
+                        salesTaxCodeId: {
+                            type: 'string',
+                            description: 'The sales-tax code for this item line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.\n\nDefault codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.',
+                        },
+                        serialNumber: {
+                            type: 'string',
+                            description: 'The serial number of the item associated with this item line. This is used for tracking individual units of serialized inventory items.',
+                        },
+                        unitOfMeasure: {
+                            type: 'string',
+                            description: "The unit-of-measure used for the `quantity` in this item line. Must be a valid unit within the item's available units of measure.",
+                        },
+                    },
+                    required: [],
+                },
+            },
+            linkToTransactionIds: {
+                type: 'array',
+                description: "IDs of existing purchase orders that you wish to link to this item receipt. Note that this links entire transactions, not individual transaction lines. If you want to link individual lines in a transaction, instead use the field `linkToTransactionLine` on this item receipt's lines, if available.\n\nTransactions can only be linked when creating this item receipt and cannot be unlinked later.\n\nYou can use both `linkToTransactionIds` (on this item receipt) and `linkToTransactionLine` (on its transaction lines) as long as they do NOT link to the same transaction (otherwise, QuickBooks will return an error). QuickBooks will also return an error if you attempt to link a transaction that is empty or already closed.\n\n**IMPORTANT**: By default, QuickBooks will not return any information about the linked transactions in this endpoint's response even when this request is successful. To see the transactions linked via this field, refetch the item receipt and check the `linkedTransactions` response field. If fetching a list of item receipts, you must also specify the parameter `includeLinkedTransactions=true` to see the `linkedTransactions` response field.",
+                items: {
+                    type: 'string',
+                },
+            },
+            memo: {
+                type: 'string',
+                description: 'A memo or note for this item receipt.',
+            },
+            payablesAccountId: {
+                type: 'string',
+                description: 'The Accounts-Payable (A/P) account to which this item receipt is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/P account.\n\n**IMPORTANT**: If this item receipt is linked to other transactions, this A/P account must match the `payablesAccount` used in those other transactions.',
+            },
+            refNumber: {
+                type: 'string',
+                description: 'The case-sensitive user-defined reference number for this item receipt, 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).',
+            },
+            salesTaxCodeId: {
+                type: 'string',
+                description: 'The sales-tax code for this item receipt, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the item receipt\'s individual lines.\n\nDefault codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.',
+            },
+        },
+    },
+};
+const handler = (client, args) => {
+    const body = args;
+    return client.qbd.itemReceipts.create(body);
+};
+exports.handler = handler;
+exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };
+//# sourceMappingURL=create-qbd-item-receipts.js.map

package/tools/qbd/item-receipts/create-qbd-item-receipts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-qbd-item-receipts.js","sourceRoot":"","sources":["../../../src/tools/qbd/item-receipts/create-qbd-item-receipts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAMzE,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,mBAAmB;IAC7B,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,mCAAmC;CAC9C,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,0BAA0B;IAChC,WAAW,EAAE,6BAA6B;IAC1C,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,eAAe,EAAE;gBACf,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iEAAiE;gBAC9E,MAAM,EAAE,MAAM;aACf;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,wEAAwE;aACtF;YACD,uBAAuB,EAAE;gBACvB,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,mGAAmG;aACtG;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,sOAAsO;aACzO;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,+EAA+E;gBAC5F,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,SAAS,EAAE;4BACT,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,4OAA4O;yBAC/O;wBACD,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,4EAA4E;yBAC1F;wBACD,aAAa,EAAE;4BACb,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,0CAA0C;4BACvD,IAAI,EAAE,CAAC,UAAU,EAAE,iBAAiB,EAAE,cAAc,CAAC;yBACtD;wBACD,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,kWAAkW;yBACrW;wBACD,YAAY,EAAE;4BACZ,IAAI,EAAE,OAAO;4BACb,WAAW,EACT,uIAAuI;4BACzI,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,IAAI,EAAE;wCACJ,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,mJAAmJ;qCACtJ;oCACD,OAAO,EAAE;wCACP,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,mdAAmd;qCACtd;oCACD,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,sFAAsF;qCACzF;iCACF;gCACD,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;6BACvC;yBACF;wBACD,IAAI,EAAE;4BACJ,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,uCAAuC;yBACrD;wBACD,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,mOAAmO;yBACtO;wBACD,qBAAqB,EAAE;4BACrB,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,yHAAyH;yBAC5H;wBACD,cAAc,EAAE;4BACd,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,mdAAmd;yBACtd;qBACF;oBACD,QAAQ,EAAE,EAAE;iBACb;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,uSAAuS;aAC1S;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,6KAA6K;gBAC/K,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,WAAW,EAAE;4BACX,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,4JAA4J;yBAC/J;wBACD,YAAY,EAAE;4BACZ,IAAI,EAAE,OAAO;4BACb,WAAW,EACT,0IAA0I;4BAC5I,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,IAAI,EAAE;wCACJ,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,mJAAmJ;qCACtJ;oCACD,OAAO,EAAE;wCACP,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,mdAAmd;qCACtd;oCACD,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,sFAAsF;qCACzF;iCACF;gCACD,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;6BACvC;yBACF;wBACD,eAAe,EAAE;4BACf,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,sGAAsG;yBACzG;wBACD,uBAAuB,EAAE;4BACvB,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,2IAA2I;yBAC9I;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,8LAA8L;yBACjM;wBACD,aAAa,EAAE;4BACb,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,yIAAyI;yBAC5I;qBACF;oBACD,QAAQ,EAAE,CAAC,aAAa,CAAC;iBAC1B;aACF;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,8FAA8F;gBAChG,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,6WAA6W;yBAChX;wBACD,aAAa,EAAE;4BACb,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,uCAAuC;4BACpD,IAAI,EAAE,CAAC,UAAU,EAAE,iBAAiB,EAAE,cAAc,CAAC;yBACtD;wBACD,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,4VAA4V;yBAC/V;wBACD,IAAI,EAAE;4BACJ,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,0KAA0K;yBAC7K;wBACD,UAAU,EAAE;4BACV,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,8DAA8D;yBAC5E;wBACD,YAAY,EAAE;4BACZ,IAAI,EAAE,OAAO;4BACb,WAAW,EACT,oIAAoI;4BACtI,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,IAAI,EAAE;wCACJ,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,mJAAmJ;qCACtJ;oCACD,OAAO,EAAE;wCACP,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,mdAAmd;qCACtd;oCACD,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,WAAW,EACT,sFAAsF;qCACzF;iCACF;gCACD,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;6BACvC;yBACF;wBACD,WAAW,EAAE;4BACX,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,kCAAkC;yBAChD;wBACD,cAAc,EAAE;4BACd,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,kSAAkS;4BACpS,MAAM,EAAE,MAAM;yBACf;wBACD,eAAe,EAAE;4BACf,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,0FAA0F;yBAC7F;wBACD,uBAAuB,EAAE;4BACvB,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,+HAA+H;yBAClI;wBACD,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,kPAAkP;yBACrP;wBACD,qBAAqB,EAAE;4BACrB,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,ixDAAixD;4BACnxD,UAAU,EAAE;gCACV,aAAa,EAAE;oCACb,IAAI,EAAE,QAAQ;oCACd,WAAW,EAAE,8DAA8D;iCAC5E;gCACD,iBAAiB,EAAE;oCACjB,IAAI,EAAE,QAAQ;oCACd,WAAW,EAAE,mEAAmE;iCACjF;6BACF;4BACD,QAAQ,EAAE,CAAC,eAAe,EAAE,mBAAmB,CAAC;yBACjD;wBACD,SAAS,EAAE;4BACT,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,qJAAqJ;yBACxJ;wBACD,qBAAqB,EAAE;4BACrB,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,iGAAiG;yBACpG;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,sKAAsK;yBACzK;wBACD,qBAAqB,EAAE;4BACrB,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,sHAAsH;yBACzH;wBACD,cAAc,EAAE;4BACd,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,gdAAgd;yBACnd;wBACD,YAAY,EAAE;4BACZ,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,yIAAyI;yBAC5I;wBACD,aAAa,EAAE;4BACb,IAAI,EAAE,QAAQ;4BACd,WAAW,EACT,mIAAmI;yBACtI;qBACF;oBACD,QAAQ,EAAE,EAAE;iBACb;aACF;YACD,oBAAoB,EAAE;gBACpB,IAAI,EAAE,OAAO;gBACb,WAAW,EACT,+oCAA+oC;gBACjpC,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,uCAAuC;aACrD;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,8UAA8U;aACjV;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,+VAA+V;aAClW;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,gfAAgf;aACnf;SACF;KACF;CACF,CAAC;AAEK,MAAM,OAAO,GAAG,CAAC,MAAiB,EAAE,IAAyC,EAAE,EAAE;IACtF,MAAM,IAAI,GAAG,IAAW,CAAC;IACzB,OAAO,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC9C,CAAC,CAAC;AAHW,QAAA,OAAO,WAGlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}

package/tools/qbd/item-receipts/create-qbd-item-receipts.mjs

@@ -0,0 +1,301 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export const metadata = {
+    resource: 'qbd.item_receipts',
+    operation: 'write',
+    tags: [],
+    httpMethod: 'post',
+    httpPath: '/quickbooks-desktop/item-receipts',
+};
+export const tool = {
+    name: 'create_qbd_item_receipts',
+    description: 'Creates a new item receipt.',
+    inputSchema: {
+        type: 'object',
+        properties: {
+            transactionDate: {
+                type: 'string',
+                description: 'The date of this item receipt, in ISO 8601 format (YYYY-MM-DD).',
+                format: 'date',
+            },
+            vendorId: {
+                type: 'string',
+                description: 'The vendor who sent this item receipt for goods or services purchased.',
+            },
+            '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}}"`).',
+            },
+            exchangeRate: {
+                type: 'number',
+                description: "The market exchange rate between this item receipt'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).",
+            },
+            expenseLines: {
+                type: 'array',
+                description: "The item receipt's expense lines, each representing one line in this expense.",
+                items: {
+                    type: 'object',
+                    properties: {
+                        accountId: {
+                            type: 'string',
+                            description: 'The expense account being debited (increased) for this expense line. The corresponding account being credited is usually a liability account (e.g., Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction type.',
+                        },
+                        amount: {
+                            type: 'string',
+                            description: 'The monetary amount of this expense line, represented as a decimal string.',
+                        },
+                        billingStatus: {
+                            type: 'string',
+                            description: 'The billing status of this expense line.',
+                            enum: ['billable', 'has_been_billed', 'not_billable'],
+                        },
+                        classId: {
+                            type: 'string',
+                            description: "The expense 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 expense lines unless overridden here, at the transaction line level.",
+                        },
+                        customFields: {
+                            type: 'array',
+                            description: 'The custom fields for the expense line object, added as user-defined data extensions, not included in the standard QuickBooks object.',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    name: {
+                                        type: 'string',
+                                        description: 'The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI.',
+                                    },
+                                    ownerId: {
+                                        type: 'string',
+                                        description: 'The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects.',
+                                    },
+                                    value: {
+                                        type: 'string',
+                                        description: "The value of this custom field. The maximum length depends on the field's data type.",
+                                    },
+                                },
+                                required: ['name', 'ownerId', 'value'],
+                            },
+                        },
+                        memo: {
+                            type: 'string',
+                            description: 'A memo or note for this expense line.',
+                        },
+                        payeeId: {
+                            type: 'string',
+                            description: "If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the expense's vendor (not the customer). If `account` refers to any other type of account, `payee` refers to the expense's customer (not the vendor).",
+                        },
+                        salesRepresentativeId: {
+                            type: 'string',
+                            description: "The expense line's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.",
+                        },
+                        salesTaxCodeId: {
+                            type: 'string',
+                            description: 'The sales-tax code for this expense line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.\n\nDefault codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.',
+                        },
+                    },
+                    required: [],
+                },
+            },
+            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.',
+            },
+            itemGroupLines: {
+                type: 'array',
+                description: "The item receipt's item group lines, each representing a predefined set of items bundled together because they are commonly purchased together or grouped for faster entry.",
+                items: {
+                    type: 'object',
+                    properties: {
+                        itemGroupId: {
+                            type: 'string',
+                            description: "The item group line's item group, representing a predefined set of items bundled because they are commonly purchased together or grouped for faster entry.",
+                        },
+                        customFields: {
+                            type: 'array',
+                            description: 'The custom fields for the item group line object, added as user-defined data extensions, not included in the standard QuickBooks object.',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    name: {
+                                        type: 'string',
+                                        description: 'The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI.',
+                                    },
+                                    ownerId: {
+                                        type: 'string',
+                                        description: 'The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects.',
+                                    },
+                                    value: {
+                                        type: 'string',
+                                        description: "The value of this custom field. The maximum length depends on the field's data type.",
+                                    },
+                                },
+                                required: ['name', 'ownerId', 'value'],
+                            },
+                        },
+                        inventorySiteId: {
+                            type: 'string',
+                            description: 'The site location where inventory for the item group associated with this item group line is stored.',
+                        },
+                        inventorySiteLocationId: {
+                            type: 'string',
+                            description: 'The specific location (e.g., bin or shelf) within the inventory site where the item group associated with this item group line is stored.',
+                        },
+                        quantity: {
+                            type: 'number',
+                            description: 'The quantity of the item group associated with this item group line. This field cannot be cleared.\n\n**NOTE**: Do not use this field if the associated item group is a discount item group.',
+                        },
+                        unitOfMeasure: {
+                            type: 'string',
+                            description: "The unit-of-measure used for the `quantity` in this item group line. Must be a valid unit within the item's available units of measure.",
+                        },
+                    },
+                    required: ['itemGroupId'],
+                },
+            },
+            itemLines: {
+                type: 'array',
+                description: "The item receipt's item lines, each representing the purchase of a specific item or service.",
+                items: {
+                    type: 'object',
+                    properties: {
+                        amount: {
+                            type: 'string',
+                            description: 'The monetary amount of this item line, represented as a decimal string. If both `quantity` and `cost` are specified but not `amount`, QuickBooks will use them to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified, then QuickBooks will calculate `amount` based on a `quantity` of `1` and the suggested `cost`. This field cannot be cleared.',
+                        },
+                        billingStatus: {
+                            type: 'string',
+                            description: 'The billing status of this item line.',
+                            enum: ['billable', 'has_been_billed', 'not_billable'],
+                        },
+                        classId: {
+                            type: 'string',
+                            description: "The item 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 item lines unless overridden here, at the transaction line level.",
+                        },
+                        cost: {
+                            type: 'string',
+                            description: 'The cost of this item line, represented as a decimal string. If both `quantity` and `amount` are specified but not `cost`, QuickBooks will use them to calculate `cost`.',
+                        },
+                        customerId: {
+                            type: 'string',
+                            description: 'The customer or customer-job associated with this item line.',
+                        },
+                        customFields: {
+                            type: 'array',
+                            description: 'The custom fields for the item line object, added as user-defined data extensions, not included in the standard QuickBooks object.',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    name: {
+                                        type: 'string',
+                                        description: 'The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI.',
+                                    },
+                                    ownerId: {
+                                        type: 'string',
+                                        description: 'The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects.',
+                                    },
+                                    value: {
+                                        type: 'string',
+                                        description: "The value of this custom field. The maximum length depends on the field's data type.",
+                                    },
+                                },
+                                required: ['name', 'ownerId', 'value'],
+                            },
+                        },
+                        description: {
+                            type: 'string',
+                            description: 'A description of this item line.',
+                        },
+                        expirationDate: {
+                            type: 'string',
+                            description: 'The expiration date for the serial number or lot number of the item associated with this item 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',
+                        },
+                        inventorySiteId: {
+                            type: 'string',
+                            description: 'The site location where inventory for the item associated with this item line is stored.',
+                        },
+                        inventorySiteLocationId: {
+                            type: 'string',
+                            description: 'The specific location (e.g., bin or shelf) within the inventory site where the item associated with this item line is stored.',
+                        },
+                        itemId: {
+                            type: 'string',
+                            description: 'The item associated with this item line. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.',
+                        },
+                        linkToTransactionLine: {
+                            type: 'object',
+                            description: "An existing transaction line that you wish to link to this item line. Note that this only links to a single transaction line item, not an entire transaction. If you want to link an entire transaction and bring in all its lines, instead use the field `linkToTransactionIds` on the parent transaction, if available. If the parent transaction is a bill or an item receipt, you can only link to purchase orders; QuickBooks does not support linking these transactions to other transaction types.\n\nTransaction lines can only be linked when creating this item line and cannot be unlinked later.\n\n**IMPORTANT**: If you use `linkToTransactionLine` on this item line, you cannot use the field `item` on this line (QuickBooks will return an error) because this field brings in all of the item information you need. You can, however, specify whatever `quantity` or `rate` that you want, or any other transaction line element other than `item`.\n\nIf the parent transaction supports the `linkToTransactionIds` field, you can use both `linkToTransactionLine` (on this item line) and `linkToTransactionIds` (on its parent transaction) in the same request as long as they do NOT link to the same transaction (otherwise, QuickBooks will return an error). QuickBooks will also return an error if you attempt to link a transaction that is empty or already closed.\n\n**IMPORTANT**: By default, QuickBooks will not return any information about the linked transaction line in this endpoint's response even when this request is successful. To see the transaction line linked via this field, refetch the parent transaction and check the `linkedTransactions` response field. If fetching a list of transactions, you must also specify the parameter `includeLinkedTransactions=true` to see the `linkedTransactions` response field.",
+                            properties: {
+                                transactionId: {
+                                    type: 'string',
+                                    description: 'The ID of the transaction to which to link this transaction.',
+                                },
+                                transactionLineId: {
+                                    type: 'string',
+                                    description: 'The ID of the transaction line to which to link this transaction.',
+                                },
+                            },
+                            required: ['transactionId', 'transactionLineId'],
+                        },
+                        lotNumber: {
+                            type: 'string',
+                            description: 'The lot number of the item associated with this item line. Used for tracking groups of inventory items that are purchased or manufactured together.',
+                        },
+                        overrideItemAccountId: {
+                            type: 'string',
+                            description: 'The account to use for this item line, overriding the default account associated with the item.',
+                        },
+                        quantity: {
+                            type: 'number',
+                            description: 'The quantity of the item associated with this item line. This field cannot be cleared.\n\n**NOTE**: Do not use this field if the associated item is a discount item.',
+                        },
+                        salesRepresentativeId: {
+                            type: 'string',
+                            description: "The item line's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.",
+                        },
+                        salesTaxCodeId: {
+                            type: 'string',
+                            description: 'The sales-tax code for this item line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.\n\nDefault codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.',
+                        },
+                        serialNumber: {
+                            type: 'string',
+                            description: 'The serial number of the item associated with this item line. This is used for tracking individual units of serialized inventory items.',
+                        },
+                        unitOfMeasure: {
+                            type: 'string',
+                            description: "The unit-of-measure used for the `quantity` in this item line. Must be a valid unit within the item's available units of measure.",
+                        },
+                    },
+                    required: [],
+                },
+            },
+            linkToTransactionIds: {
+                type: 'array',
+                description: "IDs of existing purchase orders that you wish to link to this item receipt. Note that this links entire transactions, not individual transaction lines. If you want to link individual lines in a transaction, instead use the field `linkToTransactionLine` on this item receipt's lines, if available.\n\nTransactions can only be linked when creating this item receipt and cannot be unlinked later.\n\nYou can use both `linkToTransactionIds` (on this item receipt) and `linkToTransactionLine` (on its transaction lines) as long as they do NOT link to the same transaction (otherwise, QuickBooks will return an error). QuickBooks will also return an error if you attempt to link a transaction that is empty or already closed.\n\n**IMPORTANT**: By default, QuickBooks will not return any information about the linked transactions in this endpoint's response even when this request is successful. To see the transactions linked via this field, refetch the item receipt and check the `linkedTransactions` response field. If fetching a list of item receipts, you must also specify the parameter `includeLinkedTransactions=true` to see the `linkedTransactions` response field.",
+                items: {
+                    type: 'string',
+                },
+            },
+            memo: {
+                type: 'string',
+                description: 'A memo or note for this item receipt.',
+            },
+            payablesAccountId: {
+                type: 'string',
+                description: 'The Accounts-Payable (A/P) account to which this item receipt is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/P account.\n\n**IMPORTANT**: If this item receipt is linked to other transactions, this A/P account must match the `payablesAccount` used in those other transactions.',
+            },
+            refNumber: {
+                type: 'string',
+                description: 'The case-sensitive user-defined reference number for this item receipt, 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).',
+            },
+            salesTaxCodeId: {
+                type: 'string',
+                description: 'The sales-tax code for this item receipt, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the item receipt\'s individual lines.\n\nDefault codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.',
+            },
+        },
+    },
+};
+export const handler = (client, args) => {
+    const body = args;
+    return client.qbd.itemReceipts.create(body);
+};
+export default { metadata, tool, handler };
+//# sourceMappingURL=create-qbd-item-receipts.mjs.map