conductor-node 11.6.8 → 11.6.10

package/dist/package.json

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

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

@@ -2716,6 +2716,47 @@ export default class QbdIntegration extends BaseIntegration {
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransactionQuery
          */
         query: (endUserId: string, params?: QbdTypes.TransactionQueryRq) => Promise<NonNullable<QbdTypes.TransactionQueryRs["TransactionRet"]>>;
+        /**
+         * Deleting a transaction removes it completely and irreversibly. (Using a
+         * TxnVoid request to void a transaction, on the other hand, sets its amount
+         * to zero but keeps a record of it in QuickBooks.)
+         *
+         * If you try to delete or void a transaction while it is in use, you will
+         * get an error. You will also get an error if you try to delete or void a
+         * transaction (say a sales receipt) while a linked transaction (such as a
+         * deposit) is in use. If you try to delete or void a transaction that was
+         * created before the company’s closing date, you might or might not get an
+         * error, depending on the permissions and passwords that are set in
+         * QuickBooks.
+         *
+         * The mode in which a QuickBooks company file is open (single-user or
+         * multi0user) does not impact your application’s ability to delete
+         * transaction objects from it. (List objects can only be deleted if the
+         * company file is open in single-user mode.)
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDel
+         */
+        delete: (endUserId: string, params: QbdTypes.TxnDelRq) => Promise<NonNullable<QbdTypes.TxnDelRs>>;
+        /**
+         * Voiding a transaction sets its amount to zero but keeps a record of it
+         * in QuickBooks. (Using `TxnDel` to delete a transaction, on the other
+         * hand, removes the transaction completely.)
+         *
+         * If you try to void or delete a transaction while it is in use, you will
+         * get an error. You will also get an error if you try to void or delete a
+         * transaction (say a sales receipt) while a linked transaction (such as a
+         * deposit) is in use. If you try to void or delete a transaction that was
+         * created before the company’s closing date, you might or might not get
+         * an error, depending on the permissions and passwords that are set in
+         * QuickBooks.
+         *
+         * The mode in which a QuickBooks company file is open (single-user or
+         * multi-user) does not impact your application’s ability to void
+         * transaction objects in it.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnVoid
+         */
+        void: (endUserId: string, params: QbdTypes.TxnVoidRq) => Promise<NonNullable<QbdTypes.TxnVoidRs>>;
     };
     /**
      * A transfer is a transaction that moves money from one account to another

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

@@ -2721,6 +2721,61 @@ class QbdIntegration extends BaseIntegration_1.default {
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransactionQuery
          */
         query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { TransactionQueryRq: params }, "TransactionQueryRs", "TransactionRet"),
+        /**
+         * Deleting a transaction removes it completely and irreversibly. (Using a
+         * TxnVoid request to void a transaction, on the other hand, sets its amount
+         * to zero but keeps a record of it in QuickBooks.)
+         *
+         * If you try to delete or void a transaction while it is in use, you will
+         * get an error. You will also get an error if you try to delete or void a
+         * transaction (say a sales receipt) while a linked transaction (such as a
+         * deposit) is in use. If you try to delete or void a transaction that was
+         * created before the company’s closing date, you might or might not get an
+         * error, depending on the permissions and passwords that are set in
+         * QuickBooks.
+         *
+         * The mode in which a QuickBooks company file is open (single-user or
+         * multi0user) does not impact your application’s ability to delete
+         * transaction objects from it. (List objects can only be deleted if the
+         * company file is open in single-user mode.)
+         *
+         * 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.
+        this.sendRequest(endUserId, "quickbooks_desktop", 
+        // We must needlessly assert the type even though `QbdTypes.TxnDelRq` is
+        // a valid form of `Record<string, unknown>`.
+        params),
+        /**
+         * Voiding a transaction sets its amount to zero but keeps a record of it
+         * in QuickBooks. (Using `TxnDel` to delete a transaction, on the other
+         * hand, removes the transaction completely.)
+         *
+         * If you try to void or delete a transaction while it is in use, you will
+         * get an error. You will also get an error if you try to void or delete a
+         * transaction (say a sales receipt) while a linked transaction (such as a
+         * deposit) is in use. If you try to void or delete a transaction that was
+         * created before the company’s closing date, you might or might not get
+         * an error, depending on the permissions and passwords that are set in
+         * QuickBooks.
+         *
+         * The mode in which a QuickBooks company file is open (single-user or
+         * multi-user) does not impact your application’s ability to void
+         * transaction objects in it.
+         *
+         * 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.
+        this.sendRequest(endUserId, "quickbooks_desktop", 
+        // We must needlessly assert the type even though `QbdTypes.TxnVoidRq`
+        // is a valid form of `Record<string, unknown>`.
+        params),
     };
     /**
      * A transfer is a transaction that moves money from one account to another

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

@@ -12812,9 +12812,46 @@ export interface TxnDeletedRet {
     /** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
     RefNumber?: string;
 }
+export interface TxnDelRq {
+    /** The type of transaction to be deleted. */
+    TxnDelType: TxnDelType;
+    /** 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;
+}
+export interface TxnDelRs {
+    /** The type of transaction to be deleted. */
+    TxnDelType?: TxnDelType;
+    /** 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;
+    /** The time when this list or transaction object was deleted. */
+    TimeDeleted?: string;
+    /** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
+    RefNumber?: string;
+    ErrorRecovery?: ErrorRecovery;
+}
 export type TxnDelType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "PayrollLiabilityAdjustment [PRIVATE]" | "PayrollPriorPayment [PRIVATE]" | "PayrollYearToDateAdjustment [PRIVATE]" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "TimeTracking" | "TransferInventory" | "VehicleMileage" | "VendorCredit";
 export type TxnType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "LiabilityAdjustment" | "Paycheck" | "PayrollLiabilityCheck" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Transfer" | "VendorCredit" | "YTDAdjustment";
 export type TxnTypeFilter = "All" | "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "LiabilityAdjustment" | "Paycheck" | "PayrollLiabilityCheck" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Transfer" | "VendorCredit" | "YTDAdjustment";
+export interface TxnVoidRq {
+    /** The type of transaction being voided. */
+    TxnVoidType: TxnVoidType;
+    /** 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;
+}
+export interface TxnVoidRs {
+    /** The type of transaction being voided. */
+    TxnVoidType?: TxnVoidType;
+    /** 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;
+    /** Time the object was created. */
+    TimeCreated?: string;
+    /** Time the object was last modified. */
+    TimeModified?: string;
+    /** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
+    RefNumber?: string;
+    ErrorRecovery?: ErrorRecovery;
+}
+export type TxnVoidType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "SalesReceipt" | "VendorCredit";
 export interface UnitOfMeasureSetRef {
     /** 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;

package/package.json

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