conductor-node 11.6.8 → 11.6.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "conductor-node",
3
- "version": "11.6.8",
3
+ "version": "11.6.9",
4
4
  "description": "QuickBooks Desktop API for Node.js and TypeScript",
5
5
  "keywords": [
6
6
  "QuickBooks",
@@ -2716,6 +2716,27 @@ export default class QbdIntegration extends BaseIntegration {
2716
2716
  * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransactionQuery
2717
2717
  */
2718
2718
  query: (endUserId: string, params?: QbdTypes.TransactionQueryRq) => Promise<NonNullable<QbdTypes.TransactionQueryRs["TransactionRet"]>>;
2719
+ /**
2720
+ * Deleting a transaction removes it completely and irreversibly. (Using a
2721
+ * TxnVoid request to void a transaction, on the other hand, sets its amount
2722
+ * to zero but keeps a record of it in QuickBooks.)
2723
+ *
2724
+ * If you try to delete or void a transaction while it is in use, you will
2725
+ * get an error. You will also get an error if you try to delete or void a
2726
+ * transaction (say a sales receipt) while a linked transaction (such as a
2727
+ * deposit) is in use. If you try to delete or void a transaction that was
2728
+ * created before the company’s closing date, you might or might not get an
2729
+ * error, depending on the permissions and passwords that are set in
2730
+ * QuickBooks.
2731
+ *
2732
+ * The mode in which a QuickBooks company file is open (single-user or
2733
+ * multi0user) does not impact your application’s ability to delete
2734
+ * transaction objects from it. (List objects can only be deleted if the
2735
+ * company file is open in single-user mode.)
2736
+ *
2737
+ * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDel
2738
+ */
2739
+ delete: (endUserId: string, params: QbdTypes.TxnDelRq) => Promise<NonNullable<QbdTypes.TxnDelRs>>;
2719
2740
  };
2720
2741
  /**
2721
2742
  * A transfer is a transaction that moves money from one account to another
@@ -2721,6 +2721,34 @@ class QbdIntegration extends BaseIntegration_1.default {
2721
2721
  * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransactionQuery
2722
2722
  */
2723
2723
  query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { TransactionQueryRq: params }, "TransactionQueryRs", "TransactionRet"),
2724
+ /**
2725
+ * Deleting a transaction removes it completely and irreversibly. (Using a
2726
+ * TxnVoid request to void a transaction, on the other hand, sets its amount
2727
+ * to zero but keeps a record of it in QuickBooks.)
2728
+ *
2729
+ * If you try to delete or void a transaction while it is in use, you will
2730
+ * get an error. You will also get an error if you try to delete or void a
2731
+ * transaction (say a sales receipt) while a linked transaction (such as a
2732
+ * deposit) is in use. If you try to delete or void a transaction that was
2733
+ * created before the company’s closing date, you might or might not get an
2734
+ * error, depending on the permissions and passwords that are set in
2735
+ * QuickBooks.
2736
+ *
2737
+ * The mode in which a QuickBooks company file is open (single-user or
2738
+ * multi0user) does not impact your application’s ability to delete
2739
+ * transaction objects from it. (List objects can only be deleted if the
2740
+ * company file is open in single-user mode.)
2741
+ *
2742
+ * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDel
2743
+ */
2744
+ delete: async (endUserId, params) =>
2745
+ // Call `this.sendRequest` directly instead of using
2746
+ // `this.sendRequestWrapper` because `TxnDel` has a unique input and
2747
+ // output structure.
2748
+ this.sendRequest(endUserId, "quickbooks_desktop",
2749
+ // We must needlessly assert the type even though `QbdTypes.TxnDelRq` is
2750
+ // a valid form of `Record<string, unknown>`.
2751
+ params),
2724
2752
  };
2725
2753
  /**
2726
2754
  * A transfer is a transaction that moves money from one account to another
@@ -12812,6 +12812,23 @@ export interface TxnDeletedRet {
12812
12812
  /** 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. */
12813
12813
  RefNumber?: string;
12814
12814
  }
12815
+ export interface TxnDelRq {
12816
+ /** The type of transaction to be deleted. */
12817
+ TxnDelType: TxnDelType;
12818
+ /** 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. */
12819
+ TxnID: string;
12820
+ }
12821
+ export interface TxnDelRs {
12822
+ /** The type of transaction to be deleted. */
12823
+ TxnDelType?: TxnDelType;
12824
+ /** 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. */
12825
+ TxnID?: string;
12826
+ /** The time when this list or transaction object was deleted. */
12827
+ TimeDeleted?: string;
12828
+ /** 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. */
12829
+ RefNumber?: string;
12830
+ ErrorRecovery?: ErrorRecovery;
12831
+ }
12815
12832
  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";
12816
12833
  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";
12817
12834
  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";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "conductor-node",
3
- "version": "11.6.8",
3
+ "version": "11.6.9",
4
4
  "description": "QuickBooks Desktop API for Node.js and TypeScript",
5
5
  "keywords": [
6
6
  "QuickBooks",