conductor-node 8.0.3 → 8.1.0

package/README.md

@@ -59,7 +59,7 @@ The response looks like the following:
 {
   // ❗ Save this `id` to your database for executing requests to this
   // end-user's integration in the future.
-  id: '{UUID}',
+  id: 'int_conn_1234abcd',
   integrationKey: 'quickbooks-desktop',
   endUserSourceId: "1234-abcd",
   endUserEmail: 'danny@constructionco.com',

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "8.0.3",
+    "version": "8.1.0",
     "description": "Easily integrate with the entire QuickBooks Desktop API with fully-typed async TypeScript",
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",

package/dist/src/integrations/qbd/QbdIntegration.d.ts

@@ -454,6 +454,165 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationConnectionId: string, params: QbdTypes.EmployeeQueryRq) => Promise<NonNullable<QbdTypes.EmployeeQueryRs["EmployeeRet"]>>;
     };
+    invoice: {
+        /**
+         * Adds an invoice.
+         *
+         * An invoice records the amount owed by a customer who purchased goods or
+         * services but did not pay in full at the time of the sale. If full payment
+         * is received at the time of the sale, it is recorded as a sales receipt,
+         * not an invoice.
+         *
+         * In QuickBooks, invoices and estimates use similar fields, and an estimate
+         * can be converted into an invoice after the customer accepts the estimate.
+         * However, in the SDK, there is currently no ability to create an invoice
+         * directly from an estimate (you cannot link an invoice to an estimate).
+         *
+         * If you Add an invoice that has an inventory item on it, QB will
+         * automatically calculate COGS and post it to the COGS account. (The
+         * inventory item will need to be setup to post to the COGS account and must
+         * have a unit cost in it.) However, notice that such an InvoiceAdd has
+         * sales prices, not cost, so the Add is not impacting the cost of the item.
+         * The cost of the item is only affected by purchases (bills and item
+         * receipts) sales and inventory adjustments.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.InvoiceAddRq["InvoiceAdd"]) => Promise<NonNullable<QbdTypes.InvoiceAddRs["InvoiceRet"]>>;
+        /**
+         * Modifies an existing invoice. If you are modifying existing line items,
+         * supply an `InvoiceLineMod` and `TxnLineID` for each line you want to
+         * modify. If you want to add a new line, supply an `InvoiceLineMod` with
+         * its `TxnLineID` value set to -1.
+         *
+         * Some fields in an `InvoiceMod` request cannot be cleared. If any of the
+         * following fields is included in an invoice modify request, it must
+         * contain a value:
+         * - `CustomerRef`
+         * - `ARAccountRef`
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `IsPending`
+         * - `DueDate`
+         * - `ItemSalesTaxRef`
+         * - `ShipDate`
+         * - `IsToBePrinted`
+         *
+         * Within `InvoiceLineMod` or `InvoiceLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `SalesTaxCodeRef`
+         * - `OverrideItemAccountRef`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.InvoiceModRq["InvoiceMod"]) => Promise<NonNullable<QbdTypes.InvoiceModRs["InvoiceRet"]>>;
+        /**
+         * Returns invoice data.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.InvoiceQueryRq) => Promise<NonNullable<QbdTypes.InvoiceQueryRs["InvoiceRet"]>>;
+    };
+    itemInventory: {
+        /**
+         * Adds an inventory item. An inventory item is any merchandise or part that
+         * a business purchases, tracks as inventory, and then resells. In
+         * QuickBooks, information about an inventory item is grouped into three
+         * categories:
+         * 1. Purchase Information includes `PurchaseDesc`, `PurchaseCost`,
+         *    `COGSAccountRef`, and `PrefVendorRef`.
+         * 2. Sales Information includes `SalesDesc`, `SalesPrice`, and
+         *    `SalesTaxCodeRef`.
+         * 3. Inventory Information includes `AssetAccountRef`, `ReorderPoint`,
+         *    `QuantityOnHand`, `TotalValue`, and `InventoryDate`.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.ItemInventoryAddRq["ItemInventoryAdd"]) => Promise<NonNullable<QbdTypes.ItemInventoryAddRs["ItemInventoryRet"]>>;
+        /**
+         * Modifies an inventory item.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.ItemInventoryModRq["ItemInventoryMod"]) => Promise<NonNullable<QbdTypes.ItemInventoryModRs["ItemInventoryRet"]>>;
+        /**
+         * Queries for the specified inventory item or set of items.
+         *
+         * Notice that certain modifications to the item can be caused by other
+         * transactions, such as `ItemReceipts` where the item’s on hand quantity is
+         * increased. Modifications through these transactions do not result in
+         * changing the `TimeModified` stamp (only the `Mod` operation will do
+         * that), but those changes will be detected when you use the
+         * `FromModifiedDate`/`ToModifiedDate` filters in your query. Notice that
+         * you cannot get an inventory asset value from QuickBooks using this query.
+         * Instead, you need to use the General Summary Report query (which
+         * currently doesn’t include Assembly Items). Suppose you needed a way to
+         * search for the amount on hand of items that have had their amount changed
+         * since a certain date. Again, you would not use this query, but a
+         * `GeneralDetailReportQuery` that has its `GeneralDetailReportType` set to
+         * “InventoryValuationDetail”. This will tell you which items changed by how
+         * much. Also, suppose you wanted the on-hand quantity from QB as of a
+         * specific date. You would use a General Summary Report of the type
+         * Inventory Valuation Summary. (Again, this report doesn’t include
+         * Inventory Assemblies.)
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.ItemInventoryQueryRq) => Promise<NonNullable<QbdTypes.ItemInventoryQueryRs["ItemInventoryRet"]>>;
+    };
+    itemNonInventory: {
+        /**
+         * Adds a non-inventory item, which is any material or part that a business
+         * buys but does not keep on hand as inventory. There are two types of
+         * non-inventory items:
+         * 1. Materials or parts that are part of the business’s overhead (for
+         *    example, office supplies
+         * 2. Materials or parts that the business buys to finish a specific job and
+         *    then charges back to the customer.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.ItemNonInventoryAddRq["ItemNonInventoryAdd"]) => Promise<NonNullable<QbdTypes.ItemNonInventoryAddRs["ItemNonInventoryRet"]>>;
+        /**
+         * Modifies a non inventory item.
+         *
+         * About `SalesOrPurchaseMod` versus `SalesAndPurchaseMod` in an
+         * `ItemNonInventoryMod` request: You cannot change the reimbursable status
+         * of a non-inventory item through the SDK. For example, if a non-inventory
+         * item is marked as non-reimbursable in QuickBooks, you cannot send a
+         * modify request that includes a `SalesAndPurchaseMod` aggregate.
+         * Similarly, if you send an `ItemNonInventoryAdd` request that includes a
+         * `SalesOrPurchase` aggregate, you cannot later modify that item using a
+         * `SalesAndPurchaseMod` aggregate.
+         *
+         * You can modify the various account references using the appropriate
+         * account reference aggregate and the matching Apply Account
+         * `RefToExistingTxns` boolean. You need to use the boolean when you change
+         * an account ref because the QuickBooks UI displays a prompt asking whether
+         * the change should apply to existing transactions or not. Specifying True
+         * for the boolean basically dismisses this with a “Yes” answer, allowing
+         * your changes to be made and changes any existing transactions that use
+         * the item with that `AccountRef`. Specifying “False” means that the mod will
+         * not take affect if there are existing transactions. Setting this to
+         * “True” should be used with caution and normally only after some user has
+         * indicated that they want those changes made to all those existing
+         * transactions! If any affected transactions are protected by a closing
+         * date and password, the `AccountRef` changes will not be made and so the Mod
+         * request will return an error without making the requested Mod.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.ItemNonInventoryModRq["ItemNonInventoryMod"]) => Promise<NonNullable<QbdTypes.ItemNonInventoryModRs["ItemNonInventoryRet"]>>;
+        /**
+         * Queries for the specified non-inventory item or set of items.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.ItemNonInventoryQueryRq) => Promise<NonNullable<QbdTypes.ItemNonInventoryQueryRs["ItemNonInventoryRet"]>>;
+    };
     itemService: {
         /**
          * Adds a service item, which is an item that refers to services that a

package/dist/src/integrations/qbd/QbdIntegration.js

@@ -458,6 +458,165 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { EmployeeQueryRq: params }, "EmployeeQueryRs", "EmployeeRet"),
     };
+    invoice = {
+        /**
+         * Adds an invoice.
+         *
+         * An invoice records the amount owed by a customer who purchased goods or
+         * services but did not pay in full at the time of the sale. If full payment
+         * is received at the time of the sale, it is recorded as a sales receipt,
+         * not an invoice.
+         *
+         * In QuickBooks, invoices and estimates use similar fields, and an estimate
+         * can be converted into an invoice after the customer accepts the estimate.
+         * However, in the SDK, there is currently no ability to create an invoice
+         * directly from an estimate (you cannot link an invoice to an estimate).
+         *
+         * If you Add an invoice that has an inventory item on it, QB will
+         * automatically calculate COGS and post it to the COGS account. (The
+         * inventory item will need to be setup to post to the COGS account and must
+         * have a unit cost in it.) However, notice that such an InvoiceAdd has
+         * sales prices, not cost, so the Add is not impacting the cost of the item.
+         * The cost of the item is only affected by purchases (bills and item
+         * receipts) sales and inventory adjustments.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { InvoiceAddRq: { InvoiceAdd: params } }, "InvoiceAddRs", "InvoiceRet"),
+        /**
+         * Modifies an existing invoice. If you are modifying existing line items,
+         * supply an `InvoiceLineMod` and `TxnLineID` for each line you want to
+         * modify. If you want to add a new line, supply an `InvoiceLineMod` with
+         * its `TxnLineID` value set to -1.
+         *
+         * Some fields in an `InvoiceMod` request cannot be cleared. If any of the
+         * following fields is included in an invoice modify request, it must
+         * contain a value:
+         * - `CustomerRef`
+         * - `ARAccountRef`
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `IsPending`
+         * - `DueDate`
+         * - `ItemSalesTaxRef`
+         * - `ShipDate`
+         * - `IsToBePrinted`
+         *
+         * Within `InvoiceLineMod` or `InvoiceLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `SalesTaxCodeRef`
+         * - `OverrideItemAccountRef`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { InvoiceModRq: { InvoiceMod: params } }, "InvoiceModRs", "InvoiceRet"),
+        /**
+         * Returns invoice data.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/InvoiceQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { InvoiceQueryRq: params }, "InvoiceQueryRs", "InvoiceRet"),
+    };
+    itemInventory = {
+        /**
+         * Adds an inventory item. An inventory item is any merchandise or part that
+         * a business purchases, tracks as inventory, and then resells. In
+         * QuickBooks, information about an inventory item is grouped into three
+         * categories:
+         * 1. Purchase Information includes `PurchaseDesc`, `PurchaseCost`,
+         *    `COGSAccountRef`, and `PrefVendorRef`.
+         * 2. Sales Information includes `SalesDesc`, `SalesPrice`, and
+         *    `SalesTaxCodeRef`.
+         * 3. Inventory Information includes `AssetAccountRef`, `ReorderPoint`,
+         *    `QuantityOnHand`, `TotalValue`, and `InventoryDate`.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemInventoryAddRq: { ItemInventoryAdd: params } }, "ItemInventoryAddRs", "ItemInventoryRet"),
+        /**
+         * Modifies an inventory item.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemInventoryModRq: { ItemInventoryMod: params } }, "ItemInventoryModRs", "ItemInventoryRet"),
+        /**
+         * Queries for the specified inventory item or set of items.
+         *
+         * Notice that certain modifications to the item can be caused by other
+         * transactions, such as `ItemReceipts` where the item’s on hand quantity is
+         * increased. Modifications through these transactions do not result in
+         * changing the `TimeModified` stamp (only the `Mod` operation will do
+         * that), but those changes will be detected when you use the
+         * `FromModifiedDate`/`ToModifiedDate` filters in your query. Notice that
+         * you cannot get an inventory asset value from QuickBooks using this query.
+         * Instead, you need to use the General Summary Report query (which
+         * currently doesn’t include Assembly Items). Suppose you needed a way to
+         * search for the amount on hand of items that have had their amount changed
+         * since a certain date. Again, you would not use this query, but a
+         * `GeneralDetailReportQuery` that has its `GeneralDetailReportType` set to
+         * “InventoryValuationDetail”. This will tell you which items changed by how
+         * much. Also, suppose you wanted the on-hand quantity from QB as of a
+         * specific date. You would use a General Summary Report of the type
+         * Inventory Valuation Summary. (Again, this report doesn’t include
+         * Inventory Assemblies.)
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemInventoryQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemInventoryQueryRq: params }, "ItemInventoryQueryRs", "ItemInventoryRet"),
+    };
+    itemNonInventory = {
+        /**
+         * Adds a non-inventory item, which is any material or part that a business
+         * buys but does not keep on hand as inventory. There are two types of
+         * non-inventory items:
+         * 1. Materials or parts that are part of the business’s overhead (for
+         *    example, office supplies
+         * 2. Materials or parts that the business buys to finish a specific job and
+         *    then charges back to the customer.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemNonInventoryAddRq: { ItemNonInventoryAdd: params } }, "ItemNonInventoryAddRs", "ItemNonInventoryRet"),
+        /**
+         * Modifies a non inventory item.
+         *
+         * About `SalesOrPurchaseMod` versus `SalesAndPurchaseMod` in an
+         * `ItemNonInventoryMod` request: You cannot change the reimbursable status
+         * of a non-inventory item through the SDK. For example, if a non-inventory
+         * item is marked as non-reimbursable in QuickBooks, you cannot send a
+         * modify request that includes a `SalesAndPurchaseMod` aggregate.
+         * Similarly, if you send an `ItemNonInventoryAdd` request that includes a
+         * `SalesOrPurchase` aggregate, you cannot later modify that item using a
+         * `SalesAndPurchaseMod` aggregate.
+         *
+         * You can modify the various account references using the appropriate
+         * account reference aggregate and the matching Apply Account
+         * `RefToExistingTxns` boolean. You need to use the boolean when you change
+         * an account ref because the QuickBooks UI displays a prompt asking whether
+         * the change should apply to existing transactions or not. Specifying True
+         * for the boolean basically dismisses this with a “Yes” answer, allowing
+         * your changes to be made and changes any existing transactions that use
+         * the item with that `AccountRef`. Specifying “False” means that the mod will
+         * not take affect if there are existing transactions. Setting this to
+         * “True” should be used with caution and normally only after some user has
+         * indicated that they want those changes made to all those existing
+         * transactions! If any affected transactions are protected by a closing
+         * date and password, the `AccountRef` changes will not be made and so the Mod
+         * request will return an error without making the requested Mod.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemNonInventoryModRq: { ItemNonInventoryMod: params } }, "ItemNonInventoryModRs", "ItemNonInventoryRet"),
+        /**
+         * Queries for the specified non-inventory item or set of items.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestBase(integrationConnectionId, { ItemNonInventoryQueryRq: params }, "ItemNonInventoryQueryRs", "ItemNonInventoryRet"),
+    };
     itemService = {
         /**
          * Adds a service item, which is an item that refers to services that a