conductor-node 11.6.11 → 11.6.12

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "11.6.11",
+    "version": "11.6.12",
     "description": "QuickBooks Desktop API for Node.js and TypeScript",
     "keywords": [
         "QuickBooks",

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

@@ -862,6 +862,67 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CustomerTypeQueryRq) => Promise<NonNullable<QbdTypes.CustomerTypeQueryRs["CustomerTypeRet"]>>;
     };
+    /**
+     * A data extension is a custom field that you can add to a list object,
+     * transaction, or transaction line item.
+     */
+    dataExt: {
+        /**
+         * Writes data to one data extension (i.e., custom field in QuickBooks).
+         * This request can only be invoked if a data extension definition has
+         * already been defined for the target object type. That is, before you can
+         * perform the `DataExtAdd` on a particular customer, say John Henry, the
+         * data extension must already be defined for the `Customer` object. Notice
+         * that a data extension definition can be defined in either of two ways:
+         * via `DataExtDefAdd` as already described, or via the QuickBooks UI by the
+         * user specifying a custom field. Only custom fields can be defined through
+         * the UI, not private data extensions.
+         *
+         * `DataExtAdd` adds a custom field (if `OwnerID` is set to 0) or a private
+         * data extension (if `OwnerID` is set to a GUID) containing the specified
+         * value. The custom field or private data extension and value is added to
+         * the specified list object, or transaction, or transaction line item.
+         *
+         * `DataExtAdd` will return error 3180 if you invoke this on a custom data
+         * ext definition that has been deleted and then re-added from the UI. (You
+         * can’t re-add a deleted data ext def via the SDK.) However, you can use
+         * `DataExtMod` to write data to that re-added data ext def.
+         *
+         * Important: If you want to perform a `DataExtAdd` on a transaction line
+         * item, you should use custom fields instead of private data extensions
+         * because only custom field data will be returned in queries. Currently,
+         * private data is not returned.
+         *
+         * Both `DataExtAdd` and `DataExtMod` cause a Modify event to be generated
+         * for the parent object. For example invoking one of these on a `Customer`
+         * causes a `Customer` Modify event. The Time Modified value for that parent
+         * object is also updated.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DataExtAdd
+         */
+        add: (endUserId: string, params: QbdTypes.DataExtAddRq["DataExtAdd"]) => Promise<NonNullable<QbdTypes.DataExtAddRs["DataExtRet"]>>;
+        /**
+         * This request can only be invoked if a data extension definition has
+         * already been added to the target object (for example, the customer John
+         * Henry) by a `DataExtDefAdd` or by the user specifying a custom field
+         * value for that object via the QuickBooks UI.
+         *
+         * If you want to clear the data extension value (to make the custom field
+         * or private extension blank), you must use `DataExtDel`. The `DataExtMod`
+         * request cannot be used to clear the field.
+         *
+         * Both `DataExtAdd` and `DataExtMod` cause a Modify event to be generated
+         * for the parent object. For example invoking one of these on a `Customer`
+         * causes a `Customer` Modify event. The Time Modified value for that parent
+         * object is also updated.
+         *
+         * Notice that the Mod operation does not support macros like `DataExtAdd`
+         * does.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DataExtMod
+         */
+        mod: (endUserId: string, params: QbdTypes.DataExtModRq["DataExtMod"]) => Promise<NonNullable<QbdTypes.DataExtModRs["DataExtRet"]>>;
+    };
     /**
      * Date-driven terms show the day of the month by which payment is due and can
      * include a discount for early payment. Payments with standard terms, on the

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

@@ -867,6 +867,67 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { CustomerTypeQueryRq: params }, "CustomerTypeQueryRs", "CustomerTypeRet"),
     };
+    /**
+     * A data extension is a custom field that you can add to a list object,
+     * transaction, or transaction line item.
+     */
+    dataExt = {
+        /**
+         * Writes data to one data extension (i.e., custom field in QuickBooks).
+         * This request can only be invoked if a data extension definition has
+         * already been defined for the target object type. That is, before you can
+         * perform the `DataExtAdd` on a particular customer, say John Henry, the
+         * data extension must already be defined for the `Customer` object. Notice
+         * that a data extension definition can be defined in either of two ways:
+         * via `DataExtDefAdd` as already described, or via the QuickBooks UI by the
+         * user specifying a custom field. Only custom fields can be defined through
+         * the UI, not private data extensions.
+         *
+         * `DataExtAdd` adds a custom field (if `OwnerID` is set to 0) or a private
+         * data extension (if `OwnerID` is set to a GUID) containing the specified
+         * value. The custom field or private data extension and value is added to
+         * the specified list object, or transaction, or transaction line item.
+         *
+         * `DataExtAdd` will return error 3180 if you invoke this on a custom data
+         * ext definition that has been deleted and then re-added from the UI. (You
+         * can’t re-add a deleted data ext def via the SDK.) However, you can use
+         * `DataExtMod` to write data to that re-added data ext def.
+         *
+         * Important: If you want to perform a `DataExtAdd` on a transaction line
+         * item, you should use custom fields instead of private data extensions
+         * because only custom field data will be returned in queries. Currently,
+         * private data is not returned.
+         *
+         * Both `DataExtAdd` and `DataExtMod` cause a Modify event to be generated
+         * for the parent object. For example invoking one of these on a `Customer`
+         * causes a `Customer` Modify event. The Time Modified value for that parent
+         * object is also updated.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DataExtAdd
+         */
+        add: async (endUserId, params) => this.sendRequestWrapper(endUserId, { DataExtAddRq: { DataExtAdd: params } }, "DataExtAddRs", "DataExtRet"),
+        /**
+         * This request can only be invoked if a data extension definition has
+         * already been added to the target object (for example, the customer John
+         * Henry) by a `DataExtDefAdd` or by the user specifying a custom field
+         * value for that object via the QuickBooks UI.
+         *
+         * If you want to clear the data extension value (to make the custom field
+         * or private extension blank), you must use `DataExtDel`. The `DataExtMod`
+         * request cannot be used to clear the field.
+         *
+         * Both `DataExtAdd` and `DataExtMod` cause a Modify event to be generated
+         * for the parent object. For example invoking one of these on a `Customer`
+         * causes a `Customer` Modify event. The Time Modified value for that parent
+         * object is also updated.
+         *
+         * Notice that the Mod operation does not support macros like `DataExtAdd`
+         * does.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DataExtMod
+         */
+        mod: async (endUserId, params) => this.sendRequestWrapper(endUserId, { DataExtModRq: { DataExtMod: params } }, "DataExtModRs", "DataExtRet"),
+    };
     /**
      * Date-driven terms show the day of the month by which payment is due and can
      * include a discount for early payment. Payments with standard terms, on the
@@ -2742,9 +2803,8 @@ class QbdIntegration extends BaseIntegration_1.default {
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDel
          */
         delete: async (endUserId, params) => 
-        // Call `this.sendRequest()` directly instead of using
-        // `this.sendRequestWrapper()` because `TxnDel` has a unique input and
-        // output structure.
+        // Call `this.sendRequest()` instead of `this.sendRequestWrapper()`
+        // because `TxnDel` has a unique input and output structure.
         this.sendRequest(endUserId, "quickbooks_desktop", {
             TxnDelRq: params,
         }),
@@ -2768,9 +2828,8 @@ class QbdIntegration extends BaseIntegration_1.default {
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnVoid
          */
         void: async (endUserId, params) => 
-        // Call `this.sendRequest()` directly instead of using
-        // `this.sendRequestWrapper()` because `TxnVoid` has a unique input and
-        // output structure.
+        // Call `this.sendRequest()` instead of `this.sendRequestWrapper()`
+        // because `TxnVoid` has a unique input and output structure.
         this.sendRequest(endUserId, "quickbooks_desktop", {
             TxnVoidRq: params,
         }),

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

@@ -3646,6 +3646,60 @@ export interface DataExt {
     /** The data in this field. The maximum length of `DataExtValue` will depend on the `DataExtType` of this data extension. For example, if `DataExtType` is `STR255TYPE`, the maximum length of `DataExtValue` is 255 characters. If `DataExtType` is `STR1024TYPE`, the maximum size of `DataExtValue` is `1KB`. */
     DataExtValue: string;
 }
+export interface DataExtAdd {
+    /** `OwnerID` refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an `OwnerID` of 0. ) Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.) When you share a data extension with another application, the other application must know both the `OwnerID` and the `DataExtName`, as these together form a data extension’s unique name. */
+    OwnerID: string;
+    /** The name of the data extension. If this is a custom field, `DataExtName` will be visible as a label in the QuickBooks user interface. Also because `OwnerID` and `DataExtName` together make the data extension unique, and because custom fields all have the same `OwnerID` of zero, the `DataExtName` must be a unique value among existing custom fields. In contrast, the `DataExtName` for private data extensions must be unique only for the specified `OwnerID` GUID. */
+    DataExtName: string;
+    /** The type of list object (e.g. Customer) that this data extension is attached to. */
+    ListDataExtType: ListDataExtType;
+    /** Refers to a list object. In a `DataExtAdd` request, the list object ref must be the same type as the type specified in `ListDataExtType`.If a `ListObjRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    ListObjRef: ListObjRef;
+    /** The type of transaction that the data extension belongs to. */
+    TxnDataExtType: TxnDataExtType;
+    /** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
+    TxnID: string;
+    /** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
+    TxnLineID?: string;
+    /** Not supported. */
+    OtherDataExtType?: OtherDataExtType;
+    /** The data in this field. The maximum length of `DataExtValue` will depend on the `DataExtType` of this data extension. For example, if `DataExtType` is `STR255TYPE`, the maximum length of `DataExtValue` is 255 characters. If `DataExtType` is `STR1024TYPE`, the maximum size of `DataExtValue` is `1KB`. */
+    DataExtValue: string;
+}
+export interface DataExtAddRq {
+    DataExtAdd: DataExtAdd;
+}
+export interface DataExtAddRs {
+    DataExtRet?: DataExtRet;
+    ErrorRecovery?: ErrorRecovery;
+}
+export interface DataExtMod {
+    /** `OwnerID` refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an `OwnerID` of 0. ) Usually you would keep your application’s GUID confidential to prevent other applications from accessing your data extensions. But if you want to share data extensions with another application, the applications need to use the same GUID. In this case, each application could use two GUIDs, one for shared data extensions and one for confidential data extensions. (An application can have any number of GUIDs.) When you share a data extension with another application, the other application must know both the `OwnerID` and the `DataExtName`, as these together form a data extension’s unique name. */
+    OwnerID: string;
+    /** The name of the data extension. If this is a custom field, `DataExtName` will be visible as a label in the QuickBooks user interface. Also because `OwnerID` and `DataExtName` together make the data extension unique, and because custom fields all have the same `OwnerID` of zero, the `DataExtName` must be a unique value among existing custom fields. In contrast, the `DataExtName` for private data extensions must be unique only for the specified `OwnerID` GUID. */
+    DataExtName: string;
+    /** The type of list object (e.g. Customer) that this data extension is attached to. */
+    ListDataExtType: ListDataExtType;
+    /** Refers to a list object. In a `DataExtAdd` request, the list object ref must be the same type as the type specified in `ListDataExtType`.If a `ListObjRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    ListObjRef: ListObjRef;
+    /** The type of transaction that the data extension belongs to. */
+    TxnDataExtType: TxnDataExtType;
+    /** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
+    TxnID: string;
+    /** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
+    TxnLineID?: string;
+    /** Not supported. */
+    OtherDataExtType?: OtherDataExtType;
+    /** The data in this field. The maximum length of `DataExtValue` will depend on the `DataExtType` of this data extension. For example, if `DataExtType` is `STR255TYPE`, the maximum length of `DataExtValue` is 255 characters. If `DataExtType` is `STR1024TYPE`, the maximum size of `DataExtValue` is `1KB`. */
+    DataExtValue: string;
+}
+export interface DataExtModRq {
+    DataExtMod: DataExtMod;
+}
+export interface DataExtModRs {
+    DataExtRet?: DataExtRet;
+    ErrorRecovery?: ErrorRecovery;
+}
 export interface DataExtRet {
     /** `OwnerID` refers to the owner of a data extension, and must be 0 or a valid GUID. (Custom fields, which are visible in the QuickBooks UI, always have an `OwnerID` of 0. )
   
@@ -8930,6 +8984,7 @@ export interface LinkToTxn {
     TxnLineID: string;
 }
 export type LinkType = "AMTTYPE" | "QUANTYPE";
+export type ListDataExtType = "Account" | "Customer" | "Employee" | "Item" | "OtherName" | "Vendor";
 export interface ListDeletedQueryRq {
     /** A list of enum values showing which types of deleted lists the query will return. */
     ListDelType: ListDelType | ListDelType[];
@@ -8954,6 +9009,12 @@ export interface ListDeletedRet {
     FullName?: string;
 }
 export type ListDelType = "Account" | "BillingRate" | "Class" | "Currency" | "Customer" | "CustomerMsg" | "CustomerType" | "DateDrivenTerms" | "Employee" | "InventorySite" | "ItemDiscount" | "ItemFixedAsset" | "ItemGroup" | "ItemInventory" | "ItemInventoryAssembly" | "ItemNonInventory" | "ItemOtherCharge" | "ItemPayment" | "ItemSalesTax" | "ItemSalesTaxGroup" | "ItemService" | "ItemSubtotal" | "JobType" | "OtherName" | "PaymentMethod" | "PayrollItemNonWage" | "PayrollItemWage" | "PriceLevel" | "SalesRep" | "SalesTaxCode" | "ShipMethod" | "StandardTerms" | "ToDo" | "UnitOfMeasureSet" | "Vehicle" | "Vendor" | "VendorType" | "WorkersCompCode";
+export interface ListObjRef {
+    /** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
+    ListID?: string;
+    /** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
+    FullName?: string;
+}
 export interface Locations {
     /** Where the asset is located or has been placed into service. */
     Location: string;
@@ -9023,6 +9084,7 @@ export interface NameRangeFilter {
 export type OnFile = "No" | "Yes";
 export type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
 export type OptionForPriceRuleConflict = "BasePrice" | "Zero";
+export type OtherDataExtType = "Company";
 export interface OtherNameAdd {
     /** The case-insensitive name of a list object, not including the names of its ancestors. `Name` must be unique, unless it is the `Name` of a “hierarchical” list object. List objects in different hierarchies can have duplicate names because their `FullNames` will still be unique. For example, two objects could both have the `Name` kitchen, but they could have unique `FullNames`, such as Job12:kitchen and Baker:kitchen. For built-in currencies, `Name` is the internationally accepted currency name and is not editable. */
     Name: string;
@@ -12773,6 +12835,7 @@ export interface TransferToAccountRef {
     /** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
     FullName?: string;
 }
+export type TxnDataExtType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "VendorCredit";
 export interface TxnDateRangeFilter {
     /** Selects transactions created on or after this date. Both `FromTxnDate` and `ToTxnDate` must be between 01/01/1901 and 12/31/9999.
   

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "11.6.11",
+  "version": "11.6.12",
   "description": "QuickBooks Desktop API for Node.js and TypeScript",
   "keywords": [
     "QuickBooks",