conductor-node 9.6.1 → 9.7.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "9.6.1",
+    "version": "9.7.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

@@ -551,6 +551,55 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationConnectionId: string, params: QbdTypes.CreditCardCreditQueryRq) => Promise<NonNullable<QbdTypes.CreditCardCreditQueryRs["CreditCardCreditRet"]>>;
     };
+    creditMemo: {
+        /**
+         * Adds a credit memo. A credit memo specifies an amount that you owe your
+         * customer for some reason, such as overpayment against an invoice,
+         * returned merchandise, or for some pre-payment. It reduces a customer’s
+         * outstanding balance. The `CreditMemo` doesn’t actually get applied until
+         * is referenced in a `ReceivePayment` transaction inside the `SetCredit`
+         * aggregate.
+         *
+         * The `CreditMemo` should not be confused with a `VendorCredit`, which
+         * specifies an amount that a vendor owes you.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.CreditMemoAddRq["CreditMemoAdd"]) => Promise<NonNullable<QbdTypes.CreditMemoAddRs["CreditMemoRet"]>>;
+        /**
+         * Modifies an existing credit memo.
+         *
+         * Some fields in a CreditMemoMod request cannot be cleared. If any of the
+         * following fields is included in a credit-memo modify request, it must
+         * contain a value:
+         * - `CustomerRef`
+         * - `ARAccountRef`
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `IsPending`
+         * - `DueDate`
+         * - `ShipDate`
+         * - `ItemSalesTaxRef`
+         * - `IsToBePrinted`
+         *
+         * Within `CreditMemoLineMod` or `CreditMemoLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `SalesTaxCodeRef`
+         * - `OverrideItemAccountRef`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.CreditMemoModRq["CreditMemoMod"]) => Promise<NonNullable<QbdTypes.CreditMemoModRs["CreditMemoRet"]>>;
+        /**
+         * Queries for the specified credit memo or set of credit memos.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.CreditMemoQueryRq) => Promise<NonNullable<QbdTypes.CreditMemoQueryRs["CreditMemoRet"]>>;
+    };
     customer: {
         /**
          * The customer list includes information about the QuickBooks user’s
@@ -1832,6 +1881,51 @@ export default class QbdIntegration extends BaseIntegration {
          */
         time: (integrationConnectionId: string, params: QbdTypes.TimeReportQueryRq) => Promise<NonNullable<QbdTypes.TimeReportQueryRs["ReportRet"]>>;
     };
+    salesOrder: {
+        /**
+         * Adds a sales order.
+         *
+         * A sales order tracks inventory that is on back order for a customer. In
+         * QuickBooks, sales orders and invoices use similar fields, and a sales
+         * order can be “converted” into an invoice (by linking the invoice to the
+         * sales order) once the inventory is in stock.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.SalesOrderAddRq["SalesOrderAdd"]) => Promise<NonNullable<QbdTypes.SalesOrderAddRs["SalesOrderRet"]>>;
+        /**
+         * Modifies a sales order.
+         *
+         * Some fields in a `SalesOrderMod` request cannot be cleared. If any of the
+         * following fields is included in a sales-order modify request, it must
+         * contain a value:
+         * - `CustomerRef`
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `DueDate`
+         * - `ShipDate`
+         * - `ItemSalesTaxRef`
+         * - `IsManuallyClosed`
+         * - `IsToBePrinted`
+         *
+         * Within `SalesOrderLineMod` or `SalesOrderLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `SalesTaxCodeRef`
+         * - `IsManuallyClosed`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.SalesOrderModRq["SalesOrderMod"]) => Promise<NonNullable<QbdTypes.SalesOrderModRs["SalesOrderRet"]>>;
+        /**
+         * Queries for the specified sales order or set of sales orders.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.SalesOrderQueryRq) => Promise<NonNullable<QbdTypes.SalesOrderQueryRs["SalesOrderRet"]>>;
+    };
     salesReceipt: {
         /**
          * Adds a sales receipt to QuickBooks.
@@ -1902,6 +1996,50 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationConnectionId: string, params: QbdTypes.SalesRepQueryRq) => Promise<NonNullable<QbdTypes.SalesRepQueryRs["SalesRepRet"]>>;
     };
+    salesTaxCode: {
+        /**
+         * Adds a sales tax code.
+         *
+         * Each item on a sales form is assigned a sales-tax code that indicates
+         * whether the item is taxable or non-taxable, and why. Two general codes,
+         * which can be modified but not deleted, appear on the sales-tax code list
+         * by default:
+         * - Non-taxable `(Name = NON; Desc = Non-Taxable; IsTaxable = false)`
+         * - Taxable `(Name = TAX; Desc = Taxable; IsTaxable = true)`
+         *
+         * A sales-tax code can be deleted only if it is no longer associated with
+         * any customer, item, or transaction. If the “Do You Charge Sales Tax?”
+         * preference within QuickBooks is set to No, QuickBooks will assign the
+         * default non-taxable sales-tax code to all sales.
+         *
+         * A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a
+         * request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and
+         * `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef`
+         * refers to the sales-tax code that will be used for items related to this
+         * customer. In an ItemInventory message, `SalesTaxCodeRef` refers to the type
+         * of sales tax that will be charged for this item, if it is a taxable item
+         * and if sales tax is set up within QuickBooks.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeAdd
+         */
+        add: (integrationConnectionId: string, params: QbdTypes.SalesTaxCodeAddRq["SalesTaxCodeAdd"]) => Promise<NonNullable<QbdTypes.SalesTaxCodeAddRs["SalesTaxCodeRet"]>>;
+        /**
+         * Modifies the specified sales tax code, subject to a few limitations. You
+         * cannot use it to change a tax code’s `IsTaxable` property after the code
+         * has been used in any transaction. For the default QuickBooks taxable
+         * (Tax) and exempt (Non) tax codes, you can’t use this request to change
+         * the `IsTaxable` property at all, even before any transactions.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeMod
+         */
+        mod: (integrationConnectionId: string, params: QbdTypes.SalesTaxCodeModRq["SalesTaxCodeMod"]) => Promise<NonNullable<QbdTypes.SalesTaxCodeModRs["SalesTaxCodeRet"]>>;
+        /**
+         * Queries for the specified sales tax code or set of codes.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeQuery
+         */
+        query: (integrationConnectionId: string, params: QbdTypes.SalesTaxCodeQueryRq) => Promise<NonNullable<QbdTypes.SalesTaxCodeQueryRs["SalesTaxCodeRet"]>>;
+    };
     timeTracking: {
         /**
          * The time-tracking transactions that are returned in this query include

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

@@ -556,6 +556,55 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { CreditCardCreditQueryRq: params }, "CreditCardCreditQueryRs", "CreditCardCreditRet"),
     };
+    creditMemo = {
+        /**
+         * Adds a credit memo. A credit memo specifies an amount that you owe your
+         * customer for some reason, such as overpayment against an invoice,
+         * returned merchandise, or for some pre-payment. It reduces a customer’s
+         * outstanding balance. The `CreditMemo` doesn’t actually get applied until
+         * is referenced in a `ReceivePayment` transaction inside the `SetCredit`
+         * aggregate.
+         *
+         * The `CreditMemo` should not be confused with a `VendorCredit`, which
+         * specifies an amount that a vendor owes you.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { CreditMemoAddRq: { CreditMemoAdd: params } }, "CreditMemoAddRs", "CreditMemoRet"),
+        /**
+         * Modifies an existing credit memo.
+         *
+         * Some fields in a CreditMemoMod request cannot be cleared. If any of the
+         * following fields is included in a credit-memo modify request, it must
+         * contain a value:
+         * - `CustomerRef`
+         * - `ARAccountRef`
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `IsPending`
+         * - `DueDate`
+         * - `ShipDate`
+         * - `ItemSalesTaxRef`
+         * - `IsToBePrinted`
+         *
+         * Within `CreditMemoLineMod` or `CreditMemoLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `SalesTaxCodeRef`
+         * - `OverrideItemAccountRef`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { CreditMemoModRq: { CreditMemoMod: params } }, "CreditMemoModRs", "CreditMemoRet"),
+        /**
+         * Queries for the specified credit memo or set of credit memos.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CreditMemoQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { CreditMemoQueryRq: params }, "CreditMemoQueryRs", "CreditMemoRet"),
+    };
     customer = {
         /**
          * The customer list includes information about the QuickBooks user’s
@@ -1837,6 +1886,51 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         time: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TimeReportQueryRq: params }, "TimeReportQueryRs", "ReportRet"),
     };
+    salesOrder = {
+        /**
+         * Adds a sales order.
+         *
+         * A sales order tracks inventory that is on back order for a customer. In
+         * QuickBooks, sales orders and invoices use similar fields, and a sales
+         * order can be “converted” into an invoice (by linking the invoice to the
+         * sales order) once the inventory is in stock.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { SalesOrderAddRq: { SalesOrderAdd: params } }, "SalesOrderAddRs", "SalesOrderRet"),
+        /**
+         * Modifies a sales order.
+         *
+         * Some fields in a `SalesOrderMod` request cannot be cleared. If any of the
+         * following fields is included in a sales-order modify request, it must
+         * contain a value:
+         * - `CustomerRef`
+         * - `TemplateRef`
+         * - `TxnDate`
+         * - `DueDate`
+         * - `ShipDate`
+         * - `ItemSalesTaxRef`
+         * - `IsManuallyClosed`
+         * - `IsToBePrinted`
+         *
+         * Within `SalesOrderLineMod` or `SalesOrderLineGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Rate`
+         * - `Amount`
+         * - `SalesTaxCodeRef`
+         * - `IsManuallyClosed`
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { SalesOrderModRq: { SalesOrderMod: params } }, "SalesOrderModRs", "SalesOrderRet"),
+        /**
+         * Queries for the specified sales order or set of sales orders.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesOrderQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { SalesOrderQueryRq: params }, "SalesOrderQueryRs", "SalesOrderRet"),
+    };
     salesReceipt = {
         /**
          * Adds a sales receipt to QuickBooks.
@@ -1907,6 +2001,50 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { SalesRepQueryRq: params }, "SalesRepQueryRs", "SalesRepRet"),
     };
+    salesTaxCode = {
+        /**
+         * Adds a sales tax code.
+         *
+         * Each item on a sales form is assigned a sales-tax code that indicates
+         * whether the item is taxable or non-taxable, and why. Two general codes,
+         * which can be modified but not deleted, appear on the sales-tax code list
+         * by default:
+         * - Non-taxable `(Name = NON; Desc = Non-Taxable; IsTaxable = false)`
+         * - Taxable `(Name = TAX; Desc = Taxable; IsTaxable = true)`
+         *
+         * A sales-tax code can be deleted only if it is no longer associated with
+         * any customer, item, or transaction. If the “Do You Charge Sales Tax?”
+         * preference within QuickBooks is set to No, QuickBooks will assign the
+         * default non-taxable sales-tax code to all sales.
+         *
+         * A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a
+         * request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and
+         * `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef`
+         * refers to the sales-tax code that will be used for items related to this
+         * customer. In an ItemInventory message, `SalesTaxCodeRef` refers to the type
+         * of sales tax that will be charged for this item, if it is a taxable item
+         * and if sales tax is set up within QuickBooks.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { SalesTaxCodeAddRq: { SalesTaxCodeAdd: params } }, "SalesTaxCodeAddRs", "SalesTaxCodeRet"),
+        /**
+         * Modifies the specified sales tax code, subject to a few limitations. You
+         * cannot use it to change a tax code’s `IsTaxable` property after the code
+         * has been used in any transaction. For the default QuickBooks taxable
+         * (Tax) and exempt (Non) tax codes, you can’t use this request to change
+         * the `IsTaxable` property at all, even before any transactions.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { SalesTaxCodeModRq: { SalesTaxCodeMod: params } }, "SalesTaxCodeModRs", "SalesTaxCodeRet"),
+        /**
+         * Queries for the specified sales tax code or set of codes.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { SalesTaxCodeQueryRq: params }, "SalesTaxCodeQueryRs", "SalesTaxCodeRet"),
+    };
     timeTracking = {
         /**
          * The time-tracking transactions that are returned in this query include