conductor-node 11.6.9 → 11.6.10

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.9",
3
+ "version": "11.6.10",
4
4
  "description": "QuickBooks Desktop API for Node.js and TypeScript",
5
5
  "keywords": [
6
6
  "QuickBooks",
@@ -2737,6 +2737,26 @@ export default class QbdIntegration extends BaseIntegration {
2737
2737
  * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnDel
2738
2738
  */
2739
2739
  delete: (endUserId: string, params: QbdTypes.TxnDelRq) => Promise<NonNullable<QbdTypes.TxnDelRs>>;
2740
+ /**
2741
+ * Voiding a transaction sets its amount to zero but keeps a record of it
2742
+ * in QuickBooks. (Using `TxnDel` to delete a transaction, on the other
2743
+ * hand, removes the transaction completely.)
2744
+ *
2745
+ * If you try to void or delete a transaction while it is in use, you will
2746
+ * get an error. You will also get an error if you try to void or delete a
2747
+ * transaction (say a sales receipt) while a linked transaction (such as a
2748
+ * deposit) is in use. If you try to void or delete a transaction that was
2749
+ * created before the company’s closing date, you might or might not get
2750
+ * an error, depending on the permissions and passwords that are set in
2751
+ * QuickBooks.
2752
+ *
2753
+ * The mode in which a QuickBooks company file is open (single-user or
2754
+ * multi-user) does not impact your application’s ability to void
2755
+ * transaction objects in it.
2756
+ *
2757
+ * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnVoid
2758
+ */
2759
+ void: (endUserId: string, params: QbdTypes.TxnVoidRq) => Promise<NonNullable<QbdTypes.TxnVoidRs>>;
2740
2760
  };
2741
2761
  /**
2742
2762
  * A transfer is a transaction that moves money from one account to another
@@ -2749,6 +2749,33 @@ class QbdIntegration extends BaseIntegration_1.default {
2749
2749
  // We must needlessly assert the type even though `QbdTypes.TxnDelRq` is
2750
2750
  // a valid form of `Record<string, unknown>`.
2751
2751
  params),
2752
+ /**
2753
+ * Voiding a transaction sets its amount to zero but keeps a record of it
2754
+ * in QuickBooks. (Using `TxnDel` to delete a transaction, on the other
2755
+ * hand, removes the transaction completely.)
2756
+ *
2757
+ * If you try to void or delete a transaction while it is in use, you will
2758
+ * get an error. You will also get an error if you try to void or delete a
2759
+ * transaction (say a sales receipt) while a linked transaction (such as a
2760
+ * deposit) is in use. If you try to void or delete a transaction that was
2761
+ * created before the company’s closing date, you might or might not get
2762
+ * an error, depending on the permissions and passwords that are set in
2763
+ * QuickBooks.
2764
+ *
2765
+ * The mode in which a QuickBooks company file is open (single-user or
2766
+ * multi-user) does not impact your application’s ability to void
2767
+ * transaction objects in it.
2768
+ *
2769
+ * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TxnVoid
2770
+ */
2771
+ void: async (endUserId, params) =>
2772
+ // Call `this.sendRequest` directly instead of using
2773
+ // `this.sendRequestWrapper` because `TxnVoid` has a unique input and
2774
+ // output structure.
2775
+ this.sendRequest(endUserId, "quickbooks_desktop",
2776
+ // We must needlessly assert the type even though `QbdTypes.TxnVoidRq`
2777
+ // is a valid form of `Record<string, unknown>`.
2778
+ params),
2752
2779
  };
2753
2780
  /**
2754
2781
  * A transfer is a transaction that moves money from one account to another
@@ -12832,6 +12832,26 @@ export interface TxnDelRs {
12832
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";
12833
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";
12834
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";
12835
+ export interface TxnVoidRq {
12836
+ /** The type of transaction being voided. */
12837
+ TxnVoidType: TxnVoidType;
12838
+ /** 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. */
12839
+ TxnID: string;
12840
+ }
12841
+ export interface TxnVoidRs {
12842
+ /** The type of transaction being voided. */
12843
+ TxnVoidType?: TxnVoidType;
12844
+ /** 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. */
12845
+ TxnID?: string;
12846
+ /** Time the object was created. */
12847
+ TimeCreated?: string;
12848
+ /** Time the object was last modified. */
12849
+ TimeModified?: string;
12850
+ /** 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. */
12851
+ RefNumber?: string;
12852
+ ErrorRecovery?: ErrorRecovery;
12853
+ }
12854
+ export type TxnVoidType = "ARRefundCreditCard" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "SalesReceipt" | "VendorCredit";
12835
12855
  export interface UnitOfMeasureSetRef {
12836
12856
  /** 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. */
12837
12857
  ListID?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "conductor-node",
3
- "version": "11.6.9",
3
+ "version": "11.6.10",
4
4
  "description": "QuickBooks Desktop API for Node.js and TypeScript",
5
5
  "keywords": [
6
6
  "QuickBooks",