conductor-node 3.2.2 → 3.3.0

package/dist/src/qbd/ClientQbd.d.ts

@@ -28,6 +28,261 @@ export default class ClientQbd extends BaseClient {
          */
         query: (integrationUserConnectionId: string, params: qbd.AccountQueryRq) => Promise<NonNullable<qbd.AccountQueryRs["AccountRet"]>>;
     };
+    bill: {
+        /**
+         * This API provides the functionality of the QuickBooks “Enter Bills” form,
+         * which is used when the QuickBooks user owes money to a vendor, either
+         * through expenses incurred by the vendor (specified in the Expenses tab
+         * within the Enter Bills form), or through receiving items (specified in
+         * the Items tab within the Enter Bills form). When a bill is added,
+         * QuickBooks enters the billed amount into the `AccountsPayable` register.
+         *
+         * The Enter Bills form can be reached in the QuickBooks UI by selecting
+         * "Vendors" -> "Enter Bills", or by clicking on the Bill icon on the main
+         * menubar. Notice that the `ExpenseLineAdd` aggregate maps to a line item
+         * inside the Expense tab in the Enter Bills form, and the `ItemLineAdd`
+         * aggregate maps to a line item inside the Item tab.
+         *
+         * If you are receiving items against one or more open `PurchaseOrders` for
+         * the vendor, you can use the `LinkToTxnID` element (links in all line
+         * items from a `PurchaseOrder`) and/or the `LinkToTxn` aggregate within a
+         * line item (links in a specific `PurchaseOrder` line item).
+         * - See the chapter on handling receive payment and bill payment in the QB
+         *   SDK Programmer’s Guide for complete details and rules: "The Life Cycle
+         *   of Inventory Items and Effects of Sales and Purchases".
+         *
+         * The value of inventory is set when an inventory item is created or
+         * bought. QuickBooks uses cost averaging and decreases the value of the
+         * inventory asset account at the price when the sale is recorded.
+         *
+         * So, lets say a company starts carrying widgets as inventory items. First
+         * the inventory item must be created in QuickBooks. If the widgets are
+         * already in inventory based on a purchase made that will not be recorded
+         * in QuickBooks, the user or application would add the inventory item
+         * description along with the quantity on hand and the value (total purchase
+         * price) of the quantity on hand. If the purchase is to be recorded in
+         * QuickBooks the inventory item would be created with quantity and value of
+         * 0 (zero). Then a bill would be added to QB which would increase the
+         * inventory quantity and value. Lets say we bought 10 widgets for $100.
+         * QuickBooks would then consider each widget to be worth $10. The next day
+         * a customer buys 5 widgets for $20 each. A sales receipt or invoice is
+         * created for the purchase, the quantity of widgets is reduced by 5, to 5
+         * and the value is reduced by $50 to $50. The inventory asset account is
+         * reduced by $50 and the undeposited funds or accounts receivable account
+         * is increased by $100. It appears that widgets will be a big seller, so
+         * the small business owner goes out and buys 10 more widgets. However, the
+         * supplier has also noticed a widget buying trend, so he’s increased the
+         * price to $25 each. So now our quantity is increased from 5 to 15 and the
+         * value is increased from $50 to $300, so they are considered to be worth
+         * $20 each. After purchasing the widgets another customer decides to buy 10
+         * widgets but the price has been raised to $50 each. After the sales
+         * receipt or invoice is entered, the inventory is reduced to 5 and the
+         * value
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillAdd
+         */
+        add: (integrationUserConnectionId: string, params: qbd.BillAddRq["BillAdd"]) => Promise<NonNullable<qbd.BillAddRs["BillRet"]>>;
+        /**
+         * Edit an existing Bill, similar to editing a Bill in the Enter Bills form
+         * in the QuickBooks UI.
+         *
+         * Notice that you cannot link a `PurchaseOrder` to an existing Bill using
+         * the `BillMod` request. You can link to a `PurchaseOrder` only in new
+         * Bills, using `BillAdd`.
+         *
+         * Notice also that some fields in a `BillMod` request cannot be cleared. If
+         * any of the following fields is included in a bill modify request, it must
+         * contain a value:
+         * - `VendorRef`
+         * - `APAccountRef`
+         * - `TxnDate`
+         * - `DueDate`
+         * - `ClearExpenseLines`
+         * - `ClearItemLines`
+         *
+         * Within` ExpenseLineMod`:
+         * - `Amount`
+         * - `BillableStatus`
+         *
+         * Within `ItemLineMod` or `ItemGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Cost`
+         * - `Amount`
+         * - `BillableStatus`
+         * - `OverrideItemAccountRef`
+         *
+         * (For more details about what it means for a field to be clearable or not
+         * clearable, see the QB SDK Programmer’s Guide.)
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillMod
+         */
+        mod: (integrationUserConnectionId: string, params: qbd.BillModRq["BillMod"]) => Promise<NonNullable<qbd.BillModRs["BillRet"]>>;
+        /**
+         * Provides functionality found in the Find/Advanced-Find window to find
+         * bills that are to be paid by check. The Find/Advanced-Find windows can be
+         * reached by clicking the Find button on the main QuickBooks menubar, by
+         * selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that
+         * you can use the `metaData` attribute inside the query tag if you want
+         * only a count of the bills that will be returned from the query. If you
+         * know the bill’s transaction ID or reference number, you could use these,
+         * or search by transaction date, or search by the date where the bill was
+         * last modified. You can search for paid/unpaid bills by using the
+         * `PaidStatus` flag.
+         *
+         * If you need additional filters, you can use the entity filter to search
+         * for bills from a specific vendor or vendor sub (using the
+         * `ListIDWithChildren` or `FullNameWithChildren` tags). You can also search
+         * for bills entered against a particular account (the `APAccountRef`
+         * specified in the originating `BillAdd` request). You can specify all
+         * subaccounts by using the various `*WithChildren` tags. For example, to
+         * find all bills entered against Checking where you have multiple checking
+         * accounts, you would use the `ListIDWithChildren` or
+         * `FullNameWithChildren` tags inside your AccountFilter tags. You can
+         * filter on the `RefNumber` or `RefNumber` range. Notice that all of these
+         * filters can be used together (ANDed) if desired.
+         *
+         * If you want bill line items returned from the query, you must use the
+         * `IncludeLineItems` tag. Notice that you don’t specify line item groups.
+         * If line item groups were set up for the line items, the returned line
+         * items are automatically segregated by group.
+         *
+         * You can get all of the linked transactions such as `PurchaseOrders` and
+         * Credits by using the `IncludeLinkedTxns` tag. You can get public data
+         * extensions (these are custom data whose fields can be displayed in
+         * QuickBooks) by supplying the OwnerID tag set to 0. To get private data
+         * extensions (custom data not displayable in QuickBooks) you must use the
+         * `OwnerID` tag set to the known GUID value. You must know the GUID value
+         * in order to access private data extensions.
+         *
+         * To prevent the return of too much data, you can use `MaxReturned` to
+         * limit the total number of bills returned from the query. In addition, you
+         * can limit the type of data that is returned for each bill, using
+         * `IncludeRetElement`. Finally, you can specify whether each bill contains
+         * line items using the `IncludeLineItems`, which by default is False (no
+         * line item data).
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillQuery
+         */
+        query: (integrationUserConnectionId: string, params: qbd.BillQueryRq) => Promise<NonNullable<qbd.BillQueryRs["BillRet"]>>;
+    };
+    billPaymentCheck: {
+        /**
+         * A `BillPaymentCheckAdd` request must include either `PaymentAmount`,
+         * `SetCredit`, or `DiscountAmount` (or more than one of these). If none of
+         * these three is included, the SDK will return an error.
+         *
+         * Also, the `AppliedToTxnAdd` aggregate needs both the `TxnID` and the
+         * payment amount if you are not using the `SetCredit` sub-aggregate or
+         * QuickBooks won’t have an amount to apply. If you are using the
+         * `SetCredit` sub-aggregate, you’ll need to set the amount in the
+         * `AppliedAmount` field.
+         *
+         * `BillPaymentCheckAdd` provides the functionality found in the Pay Bills
+         * form in the QuickBooks UI. You can reach this form by selecting "Retail"
+         * -> "Pay Bills" from the main QuickBooks menubar. `BillPayment` is
+         * described in detail in the chapter on handling receive payment and bill
+         * payment in the QB SDK Programmer’s Guide. Notice that you can supply only
+         * one of these sub aggregates in the request. If you want to pay multiple
+         * bills, you must issue a separate request for each bill pay.
+         *
+         * If you are using more than one A/P account, make sure that the
+         * `APAccountRef` in the `BillPaymentCheckAdd` matches the `APAccountRef`
+         * that was used when the Bill was originally added. That is, the Bill was
+         * entered in a particular account payable: use that same account payable
+         * when you pay the bill using this request.
+         *
+         * Notice that although you can set the `IsToBePrinted` flag, you cannot
+         * print checks using the SDK.
+         *
+         * Notice that you set the check number, if desired, using the `RefNumber`
+         * tags.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckAdd
+         */
+        add: (integrationUserConnectionId: string, params: qbd.BillPaymentCheckAddRq["BillPaymentCheckAdd"]) => Promise<NonNullable<qbd.BillPaymentCheckAddRs["BillPaymentCheckRet"]>>;
+        /**
+         * Modifies the specified bill payment check.
+         *
+         * Note: the `AppliedToTxnMod` aggregate needs both the `TxnID` and the
+         * payment amount if you are not using the `SetCredit` sub-aggregate or
+         * QuickBooks won’t have an amount to apply. If you are using the
+         * `SetCredit` sub-aggregate, you’ll need to set the amount in the
+         * `AppliedAmount` field.
+         *
+         * Generally, this is what you can do with `BillPaymentCheckMod`:
+         * - Modify or clear the `RefNumber` or Memo.
+         * - Modify (not clear) the `TxnDate`.
+         * - Modify (not clear) the `BankAccountRef`
+         * - Modify (not clear) the `IsToBePrinted` flag.
+         * - For a bill payment check transaction that has been applied to several
+         *   existing bills, redistribute the payment amounts applied to the bills.
+         * - Change the discount amount applied to particular bill.
+         * - You CANNOT change the credit amount applied to a particular bill. NOT
+         *   SUPPORTED!
+         * - Apply the payment amount to a different bill. Apply a discount, and a
+         *   credit. The existing distribution is cleared, except for any credit
+         *   that may have been applied.
+         * - Use a `BillPaymentCheckMod` to simply apply an additional credit to a
+         *   bill. Additional payment amount is available as a credit
+         *
+         * Other things you need to know: When a `BillPaymentCheckMod` request is
+         * processed, if the `AppliedToTxnMod` aggregate is specified, then the
+         * existing payments and discounts will be cleared (but not the credits).
+         * The original payment amount will be redistributed according to the
+         * `AppliedToTxnMod` aggregates (0 or more) contained in the
+         * `BillPaymentCheckMod` request. The `AppliedToTxnMod` aggregate may
+         * specify discounts, just as does the `AppliedToTxnAdd` aggregate. These
+         * discounts will replace any original discounts. Credits may also be
+         * specified. But if so, then the credits will be additional credits, and
+         * will not affect any credits that were originally applied. The existing
+         * payments and discounts will be cleared only if `AppliedToTxnMod` is
+         * specified in the request. This will allow clients to modify other
+         * information without modifying the distribution of the payment.
+         *
+         * In summary, in the `BillPaymentCheckMod` request, in the
+         * `AppliedToTxnMod` aggregate, discounts replace those given in the
+         * original payment. However credits simply add to any credits that may have
+         * been applied before.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckMod
+         */
+        mod: (integrationUserConnectionId: string, params: qbd.BillPaymentCheckModRq["BillPaymentCheckMod"]) => Promise<NonNullable<qbd.BillPaymentCheckModRs["BillPaymentCheckRet"]>>;
+        /**
+         * Provides functionality found in the Find/Advanced-Find window to find
+         * bill payments paid by check. The Find/Advanced-Find windows can be
+         * reached by clicking the Find button on the main QuickBooks menubar, by
+         * selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that
+         * you can use the `metaData` attribute inside the query tag if you want
+         * only a count of the bill payments that will be returned from the query.
+         *
+         * If you know the bill payment transaction ID or reference number, you
+         * could use these, or search by transaction date, or search by the date
+         * where the bill was last modified.
+         *
+         * If you need additional filters, you can use the entity filter to search
+         * for bills from a specific vendor or vendor sub (using the
+         * `ListIDWithChildren` or `FullNameWithChildren` tags). You can also search
+         * for bills entered against a particular account (the `APAccountRef`
+         * specified in the originating `BillAdd` request). You can specify all
+         * subaccounts by using the various `*WithChildren` tags. For example, to
+         * find all bills entered against Checking where you have multiple checking
+         * accounts, you would use the `ListIDWithChildren` or
+         * `FullNameWithChildren` tags inside your `AccountFilter` tags. Finally,
+         * you can filter on the `RefNumber` or `RefNumber` range. Notice that all
+         * of these filters can be used together (ANDed) if desired.
+         *
+         * To prevent the return of too much data, you can use `MaxReturned` to limit
+         * the total number of bills returned from the query. In addition, you can
+         * limit the type of data that is returned for each bill, using
+         * `IncludeRetElement`. Finally, you can specify whether each bill contains
+         * line items using the `IncludeLineItems`, which by default is `False` (no
+         * line item data).
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckQuery
+         */
+        query: (integrationUserConnectionId: string, params: qbd.BillPaymentCheckQueryRq) => Promise<NonNullable<qbd.BillPaymentCheckQueryRs["BillPaymentCheckRet"]>>;
+    };
     check: {
         /**
          * The amount of a check is the total of the amounts assigned to expense

package/dist/src/qbd/ClientQbd.js

@@ -32,6 +32,261 @@ class ClientQbd extends BaseClient_1.default {
          */
         query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { AccountQueryRq: params }, "AccountQueryRs", "AccountRet"),
     };
+    bill = {
+        /**
+         * This API provides the functionality of the QuickBooks “Enter Bills” form,
+         * which is used when the QuickBooks user owes money to a vendor, either
+         * through expenses incurred by the vendor (specified in the Expenses tab
+         * within the Enter Bills form), or through receiving items (specified in
+         * the Items tab within the Enter Bills form). When a bill is added,
+         * QuickBooks enters the billed amount into the `AccountsPayable` register.
+         *
+         * The Enter Bills form can be reached in the QuickBooks UI by selecting
+         * "Vendors" -> "Enter Bills", or by clicking on the Bill icon on the main
+         * menubar. Notice that the `ExpenseLineAdd` aggregate maps to a line item
+         * inside the Expense tab in the Enter Bills form, and the `ItemLineAdd`
+         * aggregate maps to a line item inside the Item tab.
+         *
+         * If you are receiving items against one or more open `PurchaseOrders` for
+         * the vendor, you can use the `LinkToTxnID` element (links in all line
+         * items from a `PurchaseOrder`) and/or the `LinkToTxn` aggregate within a
+         * line item (links in a specific `PurchaseOrder` line item).
+         * - See the chapter on handling receive payment and bill payment in the QB
+         *   SDK Programmer’s Guide for complete details and rules: "The Life Cycle
+         *   of Inventory Items and Effects of Sales and Purchases".
+         *
+         * The value of inventory is set when an inventory item is created or
+         * bought. QuickBooks uses cost averaging and decreases the value of the
+         * inventory asset account at the price when the sale is recorded.
+         *
+         * So, lets say a company starts carrying widgets as inventory items. First
+         * the inventory item must be created in QuickBooks. If the widgets are
+         * already in inventory based on a purchase made that will not be recorded
+         * in QuickBooks, the user or application would add the inventory item
+         * description along with the quantity on hand and the value (total purchase
+         * price) of the quantity on hand. If the purchase is to be recorded in
+         * QuickBooks the inventory item would be created with quantity and value of
+         * 0 (zero). Then a bill would be added to QB which would increase the
+         * inventory quantity and value. Lets say we bought 10 widgets for $100.
+         * QuickBooks would then consider each widget to be worth $10. The next day
+         * a customer buys 5 widgets for $20 each. A sales receipt or invoice is
+         * created for the purchase, the quantity of widgets is reduced by 5, to 5
+         * and the value is reduced by $50 to $50. The inventory asset account is
+         * reduced by $50 and the undeposited funds or accounts receivable account
+         * is increased by $100. It appears that widgets will be a big seller, so
+         * the small business owner goes out and buys 10 more widgets. However, the
+         * supplier has also noticed a widget buying trend, so he’s increased the
+         * price to $25 each. So now our quantity is increased from 5 to 15 and the
+         * value is increased from $50 to $300, so they are considered to be worth
+         * $20 each. After purchasing the widgets another customer decides to buy 10
+         * widgets but the price has been raised to $50 each. After the sales
+         * receipt or invoice is entered, the inventory is reduced to 5 and the
+         * value
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillAdd
+         */
+        add: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { BillAddRq: { BillAdd: params } }, "BillAddRs", "BillRet"),
+        /**
+         * Edit an existing Bill, similar to editing a Bill in the Enter Bills form
+         * in the QuickBooks UI.
+         *
+         * Notice that you cannot link a `PurchaseOrder` to an existing Bill using
+         * the `BillMod` request. You can link to a `PurchaseOrder` only in new
+         * Bills, using `BillAdd`.
+         *
+         * Notice also that some fields in a `BillMod` request cannot be cleared. If
+         * any of the following fields is included in a bill modify request, it must
+         * contain a value:
+         * - `VendorRef`
+         * - `APAccountRef`
+         * - `TxnDate`
+         * - `DueDate`
+         * - `ClearExpenseLines`
+         * - `ClearItemLines`
+         *
+         * Within` ExpenseLineMod`:
+         * - `Amount`
+         * - `BillableStatus`
+         *
+         * Within `ItemLineMod` or `ItemGroupMod`:
+         * - `ItemRef`
+         * - `Quantity`
+         * - `Cost`
+         * - `Amount`
+         * - `BillableStatus`
+         * - `OverrideItemAccountRef`
+         *
+         * (For more details about what it means for a field to be clearable or not
+         * clearable, see the QB SDK Programmer’s Guide.)
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillMod
+         */
+        mod: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { BillModRq: { BillMod: params } }, "BillModRs", "BillRet"),
+        /**
+         * Provides functionality found in the Find/Advanced-Find window to find
+         * bills that are to be paid by check. The Find/Advanced-Find windows can be
+         * reached by clicking the Find button on the main QuickBooks menubar, by
+         * selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that
+         * you can use the `metaData` attribute inside the query tag if you want
+         * only a count of the bills that will be returned from the query. If you
+         * know the bill’s transaction ID or reference number, you could use these,
+         * or search by transaction date, or search by the date where the bill was
+         * last modified. You can search for paid/unpaid bills by using the
+         * `PaidStatus` flag.
+         *
+         * If you need additional filters, you can use the entity filter to search
+         * for bills from a specific vendor or vendor sub (using the
+         * `ListIDWithChildren` or `FullNameWithChildren` tags). You can also search
+         * for bills entered against a particular account (the `APAccountRef`
+         * specified in the originating `BillAdd` request). You can specify all
+         * subaccounts by using the various `*WithChildren` tags. For example, to
+         * find all bills entered against Checking where you have multiple checking
+         * accounts, you would use the `ListIDWithChildren` or
+         * `FullNameWithChildren` tags inside your AccountFilter tags. You can
+         * filter on the `RefNumber` or `RefNumber` range. Notice that all of these
+         * filters can be used together (ANDed) if desired.
+         *
+         * If you want bill line items returned from the query, you must use the
+         * `IncludeLineItems` tag. Notice that you don’t specify line item groups.
+         * If line item groups were set up for the line items, the returned line
+         * items are automatically segregated by group.
+         *
+         * You can get all of the linked transactions such as `PurchaseOrders` and
+         * Credits by using the `IncludeLinkedTxns` tag. You can get public data
+         * extensions (these are custom data whose fields can be displayed in
+         * QuickBooks) by supplying the OwnerID tag set to 0. To get private data
+         * extensions (custom data not displayable in QuickBooks) you must use the
+         * `OwnerID` tag set to the known GUID value. You must know the GUID value
+         * in order to access private data extensions.
+         *
+         * To prevent the return of too much data, you can use `MaxReturned` to
+         * limit the total number of bills returned from the query. In addition, you
+         * can limit the type of data that is returned for each bill, using
+         * `IncludeRetElement`. Finally, you can specify whether each bill contains
+         * line items using the `IncludeLineItems`, which by default is False (no
+         * line item data).
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillQuery
+         */
+        query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { BillQueryRq: params }, "BillQueryRs", "BillRet"),
+    };
+    billPaymentCheck = {
+        /**
+         * A `BillPaymentCheckAdd` request must include either `PaymentAmount`,
+         * `SetCredit`, or `DiscountAmount` (or more than one of these). If none of
+         * these three is included, the SDK will return an error.
+         *
+         * Also, the `AppliedToTxnAdd` aggregate needs both the `TxnID` and the
+         * payment amount if you are not using the `SetCredit` sub-aggregate or
+         * QuickBooks won’t have an amount to apply. If you are using the
+         * `SetCredit` sub-aggregate, you’ll need to set the amount in the
+         * `AppliedAmount` field.
+         *
+         * `BillPaymentCheckAdd` provides the functionality found in the Pay Bills
+         * form in the QuickBooks UI. You can reach this form by selecting "Retail"
+         * -> "Pay Bills" from the main QuickBooks menubar. `BillPayment` is
+         * described in detail in the chapter on handling receive payment and bill
+         * payment in the QB SDK Programmer’s Guide. Notice that you can supply only
+         * one of these sub aggregates in the request. If you want to pay multiple
+         * bills, you must issue a separate request for each bill pay.
+         *
+         * If you are using more than one A/P account, make sure that the
+         * `APAccountRef` in the `BillPaymentCheckAdd` matches the `APAccountRef`
+         * that was used when the Bill was originally added. That is, the Bill was
+         * entered in a particular account payable: use that same account payable
+         * when you pay the bill using this request.
+         *
+         * Notice that although you can set the `IsToBePrinted` flag, you cannot
+         * print checks using the SDK.
+         *
+         * Notice that you set the check number, if desired, using the `RefNumber`
+         * tags.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckAdd
+         */
+        add: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { BillPaymentCheckAddRq: { BillPaymentCheckAdd: params } }, "BillPaymentCheckAddRs", "BillPaymentCheckRet"),
+        /**
+         * Modifies the specified bill payment check.
+         *
+         * Note: the `AppliedToTxnMod` aggregate needs both the `TxnID` and the
+         * payment amount if you are not using the `SetCredit` sub-aggregate or
+         * QuickBooks won’t have an amount to apply. If you are using the
+         * `SetCredit` sub-aggregate, you’ll need to set the amount in the
+         * `AppliedAmount` field.
+         *
+         * Generally, this is what you can do with `BillPaymentCheckMod`:
+         * - Modify or clear the `RefNumber` or Memo.
+         * - Modify (not clear) the `TxnDate`.
+         * - Modify (not clear) the `BankAccountRef`
+         * - Modify (not clear) the `IsToBePrinted` flag.
+         * - For a bill payment check transaction that has been applied to several
+         *   existing bills, redistribute the payment amounts applied to the bills.
+         * - Change the discount amount applied to particular bill.
+         * - You CANNOT change the credit amount applied to a particular bill. NOT
+         *   SUPPORTED!
+         * - Apply the payment amount to a different bill. Apply a discount, and a
+         *   credit. The existing distribution is cleared, except for any credit
+         *   that may have been applied.
+         * - Use a `BillPaymentCheckMod` to simply apply an additional credit to a
+         *   bill. Additional payment amount is available as a credit
+         *
+         * Other things you need to know: When a `BillPaymentCheckMod` request is
+         * processed, if the `AppliedToTxnMod` aggregate is specified, then the
+         * existing payments and discounts will be cleared (but not the credits).
+         * The original payment amount will be redistributed according to the
+         * `AppliedToTxnMod` aggregates (0 or more) contained in the
+         * `BillPaymentCheckMod` request. The `AppliedToTxnMod` aggregate may
+         * specify discounts, just as does the `AppliedToTxnAdd` aggregate. These
+         * discounts will replace any original discounts. Credits may also be
+         * specified. But if so, then the credits will be additional credits, and
+         * will not affect any credits that were originally applied. The existing
+         * payments and discounts will be cleared only if `AppliedToTxnMod` is
+         * specified in the request. This will allow clients to modify other
+         * information without modifying the distribution of the payment.
+         *
+         * In summary, in the `BillPaymentCheckMod` request, in the
+         * `AppliedToTxnMod` aggregate, discounts replace those given in the
+         * original payment. However credits simply add to any credits that may have
+         * been applied before.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckMod
+         */
+        mod: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { BillPaymentCheckModRq: { BillPaymentCheckMod: params } }, "BillPaymentCheckModRs", "BillPaymentCheckRet"),
+        /**
+         * Provides functionality found in the Find/Advanced-Find window to find
+         * bill payments paid by check. The Find/Advanced-Find windows can be
+         * reached by clicking the Find button on the main QuickBooks menubar, by
+         * selecting Edit->Find, or simply by using the shortcut CTRL-F. Notice that
+         * you can use the `metaData` attribute inside the query tag if you want
+         * only a count of the bill payments that will be returned from the query.
+         *
+         * If you know the bill payment transaction ID or reference number, you
+         * could use these, or search by transaction date, or search by the date
+         * where the bill was last modified.
+         *
+         * If you need additional filters, you can use the entity filter to search
+         * for bills from a specific vendor or vendor sub (using the
+         * `ListIDWithChildren` or `FullNameWithChildren` tags). You can also search
+         * for bills entered against a particular account (the `APAccountRef`
+         * specified in the originating `BillAdd` request). You can specify all
+         * subaccounts by using the various `*WithChildren` tags. For example, to
+         * find all bills entered against Checking where you have multiple checking
+         * accounts, you would use the `ListIDWithChildren` or
+         * `FullNameWithChildren` tags inside your `AccountFilter` tags. Finally,
+         * you can filter on the `RefNumber` or `RefNumber` range. Notice that all
+         * of these filters can be used together (ANDed) if desired.
+         *
+         * To prevent the return of too much data, you can use `MaxReturned` to limit
+         * the total number of bills returned from the query. In addition, you can
+         * limit the type of data that is returned for each bill, using
+         * `IncludeRetElement`. Finally, you can specify whether each bill contains
+         * line items using the `IncludeLineItems`, which by default is `False` (no
+         * line item data).
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCheckQuery
+         */
+        query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { BillPaymentCheckQueryRq: params }, "BillPaymentCheckQueryRs", "BillPaymentCheckRet"),
+    };
     check = {
         /**
          * The amount of a check is the total of the amounts assigned to expense