conductor-node 11.0.2 → 11.0.4

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

@@ -1,6 +1,10 @@
 import BaseIntegration from "../../integrations/BaseIntegration";
 import type * as QbdTypes from "../../integrations/qbd/qbdTypes";
 export default class QbdIntegration extends BaseIntegration {
+    /**
+     * An account represents a financial account, allowing customization like
+     * sub-accounting, account numbering, and initial balance setting.
+     */
     account: {
         /**
          * Perform the same activities as a user does in the QB New Account form,
@@ -28,6 +32,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.AccountQueryRq) => Promise<NonNullable<QbdTypes.AccountQueryRs["AccountRet"]>>;
     };
+    /**
+     * A bill is a transaction that represents a request-for-payment from a vendor
+     * for goods or services that it has provided.
+     */
     bill: {
         /**
          * This API provides the functionality of the QuickBooks “Enter Bills” form,
@@ -163,6 +171,42 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.BillQueryRq) => Promise<NonNullable<QbdTypes.BillQueryRs["BillRet"]>>;
     };
+    /**
+     * A billing rate is a predefined cost rate assigned to vendors or employees.
+     */
+    billingRate: {
+        /**
+         * Adds a billing rate to the billing rate level list.
+         *
+         * After a billing rate is created, it can be assigned to an employee or
+         * vendor (`VendorAdd`/`VendorMod`, `EmployeeAdd`/`EmployeeMod`) via the
+         * `BillingRateRef` element in the appropriate request. Then, once the
+         * billing rate is assigned to an employee or vendor, if you use that
+         * employee or vendor in a time transaction (`TimeTrackingAdd`), then the
+         * billing rate will override the rate specified by the service item used in
+         * the time transaction.
+         *
+         * Use `FixedBillingRate` to override all service items with a fixed rate.
+         * Use `BillingRatePerItem` to override a specific service item. If you want
+         * to specify more than one service item, you’ll need to use one
+         * `BillingRatePerItem` aggregate for each service item.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillingRateAdd
+         */
+        add: (endUserId: string, params: QbdTypes.BillingRateAddRq["BillingRateAdd"]) => Promise<NonNullable<QbdTypes.BillingRateAddRs["BillingRateRet"]>>;
+        /**
+         * Returns all billing rates, or billing rates filtered by modified date, or
+         * filtered by billing rate name, or filtered by the service item referenced
+         * in the billing rate.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillingRateQuery
+         */
+        query: (endUserId: string, params?: QbdTypes.BillingRateQueryRq) => Promise<NonNullable<QbdTypes.BillingRateQueryRs["BillingRateRet"]>>;
+    };
+    /**
+     * A bill payment check is a transaction that represents a payment by check
+     * for a bill.
+     */
     billPaymentCheck: {
         /**
          * A `BillPaymentCheckAdd` request must include either `PaymentAmount`,
@@ -269,9 +313,9 @@ export default class QbdIntegration extends BaseIntegration {
          * 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
+         * 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).
@@ -280,35 +324,46 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.BillPaymentCheckQueryRq) => Promise<NonNullable<QbdTypes.BillPaymentCheckQueryRs["BillPaymentCheckRet"]>>;
     };
-    billingRate: {
+    /**
+     * A build assembly represents an inventory item created from other inventory
+     * items or assemblies.
+     */
+    buildAssembly: {
         /**
-         * Adds a billing rate to the billing rate level list.
+         * Adds a build assembly transaction to QuickBooks, where the specified
+         * quantity of the specified inventory assembly item is built. If there are
+         * insufficient quantities of items required for the build, you can have the
+         * build marked as a pending build by using setting `MarkPendingIfRequired`
+         * to `True`. (If you don’t and there aren’t enough quantities on hand for
+         * the build, this request will fail.) If successful, this request results
+         * in the decrementing of the quantities on hand amounts of each item used
+         * in the build, and the incrementing of the on hand quantities of the built
+         * assembly item.
          *
-         * After a billing rate is created, it can be assigned to an employee or
-         * vendor (`VendorAdd`/`VendorMod`, `EmployeeAdd`/`EmployeeMod`) via the
-         * `BillingRateRef` element in the appropriate request. Then, once the
-         * billing rate is assigned to an employee or vendor, if you use that
-         * employee or vendor in a time transaction (`TimeTrackingAdd`), then the
-         * billing rate will override the rate specified by the service item used in
-         * the time transaction.
+         * This request is supported only in Premier and Enterprise.
          *
-         * Use `FixedBillingRate` to override all service items with a fixed rate.
-         * Use `BillingRatePerItem` to override a specific service item. If you want
-         * to specify more than one service item, you’ll need to use one
-         * `BillingRatePerItem` aggregate for each service item.
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyAdd
+         */
+        add: (endUserId: string, params: QbdTypes.BuildAssemblyAddRq["BuildAssemblyAdd"]) => Promise<NonNullable<QbdTypes.BuildAssemblyAddRs["BuildAssemblyRet"]>>;
+        /**
+         * Modifies an existing build assembly transaction in the QuickBooks
+         * company.
          *
-         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillingRateAdd
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyMod
          */
-        add: (endUserId: string, params: QbdTypes.BillingRateAddRq["BillingRateAdd"]) => Promise<NonNullable<QbdTypes.BillingRateAddRs["BillingRateRet"]>>;
+        mod: (endUserId: string, params: QbdTypes.BuildAssemblyModRq["BuildAssemblyMod"]) => Promise<NonNullable<QbdTypes.BuildAssemblyModRs["BuildAssemblyRet"]>>;
         /**
-         * Returns all billing rates, or billing rates filtered by modified date, or
-         * filtered by billing rate name, or filtered by the service item referenced
-         * in the billing rate.
+         * Filters build assembly transactions by the specified filter criteria.
          *
-         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillingRateQuery
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyQuery
          */
-        query: (endUserId: string, params?: QbdTypes.BillingRateQueryRq) => Promise<NonNullable<QbdTypes.BillingRateQueryRs["BillingRateRet"]>>;
+        query: (endUserId: string, params?: QbdTypes.BuildAssemblyQueryRq) => Promise<NonNullable<QbdTypes.BuildAssemblyQueryRs["BuildAssemblyRet"]>>;
     };
+    /**
+     * A charge contains information about a statement charge. (A credit card
+     * charge, on the other hand, refers to a credit card charge incurred by the
+     * QuickBooks user.)
+     */
     charge: {
         /**
          * Adds a customer charge. A `Charge` contains information about a statement
@@ -343,36 +398,9 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ChargeQueryRq) => Promise<NonNullable<QbdTypes.ChargeQueryRs["ChargeRet"]>>;
     };
-    buildAssembly: {
-        /**
-         * Adds a build assembly transaction to QuickBooks, where the specified
-         * quantity of the specified inventory assembly item is built. If there are
-         * insufficient quantities of items required for the build, you can have the
-         * build marked as a pending build by using setting `MarkPendingIfRequired`
-         * to `True`. (If you don’t and there aren’t enough quantities on hand for
-         * the build, this request will fail.) If successful, this request results
-         * in the decrementing of the quantities on hand amounts of each item used
-         * in the build, and the incrementing of the on hand quantities of the built
-         * assembly item.
-         *
-         * This request is supported only in Premier and Enterprise.
-         *
-         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyAdd
-         */
-        add: (endUserId: string, params: QbdTypes.BuildAssemblyAddRq["BuildAssemblyAdd"]) => Promise<NonNullable<QbdTypes.BuildAssemblyAddRs["BuildAssemblyRet"]>>;
-        /**
-         * Modifies an existing build assembly transaction in the QuickBooks company.
-         *
-         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyMod
-         */
-        mod: (endUserId: string, params: QbdTypes.BuildAssemblyModRq["BuildAssemblyMod"]) => Promise<NonNullable<QbdTypes.BuildAssemblyModRs["BuildAssemblyRet"]>>;
-        /**
-         * Filters build assembly transactions by the specified filter criteria.
-         *
-         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyQuery
-         */
-        query: (endUserId: string, params?: QbdTypes.BuildAssemblyQueryRq) => Promise<NonNullable<QbdTypes.BuildAssemblyQueryRs["BuildAssemblyRet"]>>;
-    };
+    /**
+     * A check is a transaction that represents a paper check.
+     */
     check: {
         /**
          * The amount of a check is the total of the amounts assigned to expense
@@ -394,7 +422,8 @@ export default class QbdIntegration extends BaseIntegration {
          */
         add: (endUserId: string, params: QbdTypes.CheckAddRq["CheckAdd"]) => Promise<NonNullable<QbdTypes.CheckAddRs["CheckRet"]>>;
         /**
-         * Modifies an existing Check. Notice that you cannot use this to modify BillPaymentChecks.
+         * Modifies an existing Check. Notice that you cannot use this to modify
+         * BillPaymentChecks.
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CheckMod
          */
@@ -408,6 +437,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CheckQueryRq) => Promise<NonNullable<QbdTypes.CheckQueryRs["CheckRet"]>>;
     };
+    /**
+     * Classes can be used to separate transactions into meaningful categories.
+     * (For example, transactions could be classified according to department,
+     * business location, or type of work.)
+     */
     class: {
         /**
          * Classes can be used to separate transactions into meaningful categories.
@@ -442,6 +476,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ClassQueryRq) => Promise<NonNullable<QbdTypes.ClassQueryRs["ClassRet"]>>;
     };
+    /**
+     * The company refers to the end-user's business entity within QuickBooks
+     * Desktop.
+     */
     company: {
         /**
          * Returns detailed information about a QuickBooks company file, such as the
@@ -456,6 +494,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CompanyQueryRq) => Promise<NonNullable<QbdTypes.CompanyQueryRs["CompanyRet"]>>;
     };
+    /**
+     * A credit card charge is a general charge incurred when a QuickBooks user
+     * makes a purchase using a credit card. Credit card charges for purchases can
+     * be tracked as expenses (in expense accounts) or as items.
+     */
     creditCardCharge: {
         /**
          * A credit card charge is a general charge incurred when a QuickBooks user
@@ -504,6 +547,9 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CreditCardChargeQueryRq) => Promise<NonNullable<QbdTypes.CreditCardChargeQueryRs["CreditCardChargeRet"]>>;
     };
+    /**
+     * A credit card credit is a credit card refund issued to a customer.
+     */
     creditCardCredit: {
         /**
          * If a QuickBooks user returns merchandise and receives credit, the credit
@@ -551,6 +597,14 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CreditCardCreditQueryRq) => Promise<NonNullable<QbdTypes.CreditCardCreditQueryRs["CreditCardCreditRet"]>>;
     };
+    /**
+     * A credit memo specifies an amount that you owe your customer for some
+     * reason, such as overpayment against an invoice, returned merchandise, or
+     * for some pre-payment. It reduces a customer’s outstanding balance.
+     *
+     * Do not confuse a credit memo with a vendor credit, which specifies an
+     * amount that a vendor owes you.
+     */
     creditMemo: {
         /**
          * Adds a credit memo. A credit memo specifies an amount that you owe your
@@ -600,10 +654,12 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CreditMemoQueryRq) => Promise<NonNullable<QbdTypes.CreditMemoQueryRs["CreditMemoRet"]>>;
     };
+    /**
+     * A currency is custom currency defined by the user.
+     */
     currency: {
         /**
-         * Adds a user-defined currency with the specified name and currency
-         * code.
+         * Adds a user-defined currency with the specified name and currency code.
          *
          * Currencies created by users are distinguished from the built-in QB
          * currencies in the `CurrencyRet` object: they are identified as
@@ -636,6 +692,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CurrencyQueryRq) => Promise<NonNullable<QbdTypes.CurrencyQueryRs["CurrencyRet"]>>;
     };
+    /**
+     * Customers refer to both the QuickBooks user’s customers and the individual
+     * jobs that are being performed for them.
+     */
     customer: {
         /**
          * The customer list includes information about the QuickBooks user’s
@@ -680,6 +740,12 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CustomerQueryRq) => Promise<NonNullable<QbdTypes.CustomerQueryRs["CustomerRet"]>>;
     };
+    /**
+     * Customer types allow business owners to categorize customers in ways that
+     * are meaningful for their businesses. For example, a customer type might
+     * indicate which industry a customer represents, or which part of the country
+     * a customer is in.
+     */
     customerType: {
         /**
          * Customer types allow business owners to categorize customers in ways that
@@ -701,6 +767,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.CustomerTypeQueryRq) => Promise<NonNullable<QbdTypes.CustomerTypeQueryRs["CustomerTypeRet"]>>;
     };
+    /**
+     * 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
+     * other hand, are due within a certain number of days.
+     */
     dateDrivenTerms: {
         /**
          * Date-driven terms show the day of the month by which payment is due and
@@ -721,6 +792,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.DateDrivenTermsQueryRq) => Promise<NonNullable<QbdTypes.DateDrivenTermsQueryRs["DateDrivenTermsRet"]>>;
     };
+    /**
+     * A deposit is a non-posting transaction that you can use to group payments
+     * together. You can also use a deposit to deposit payments directly into a
+     * QuickBooks bank account.
+     */
     deposit: {
         /**
          * After you receive payments from customers (see `ReceivePayment`), you can
@@ -744,6 +820,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.DepositQueryRq) => Promise<NonNullable<QbdTypes.DepositQueryRs["DepositRet"]>>;
     };
+    /**
+     * An employee is a person who works for a company. An employee can be a
+     * salaried employee, an hourly employee, or a contractor. An employee can
+     * also be a vendor.
+     */
     employee: {
         /**
          * Adds an employee with personal data about the employee as well as certain
@@ -765,6 +846,16 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.EmployeeQueryRq) => Promise<NonNullable<QbdTypes.EmployeeQueryRs["EmployeeRet"]>>;
     };
+    /**
+     * A QuickBooks estimate is a description of a sale that the QuickBooks user
+     * proposes to make to a current or prospective customer. An estimate might
+     * also be called a “bid” or a “proposal.” In QuickBooks, estimates and
+     * invoices use similar fields, and an estimate can be converted into an
+     * invoice after the customer accepts the estimate.
+     *
+     * An estimate is a non-posting transaction, so it does not affect a company’s
+     * balance sheet or income statement.
+     */
     estimate: {
         /**
          * Adds an estimate. A QuickBooks estimate is a description of a sale that
@@ -811,6 +902,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.EstimateQueryRq) => Promise<NonNullable<QbdTypes.EstimateQueryRs["EstimateRet"]>>;
     };
+    /**
+     * An inventory adjustment is a non-posting transaction that you can use to
+     * adjust the quantity or value of an inventory item
+     */
     inventoryAdjustment: {
         /**
          * Adds an inventory adjustment.
@@ -845,6 +940,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.InventoryAdjustmentQueryRq) => Promise<NonNullable<QbdTypes.InventoryAdjustmentQueryRs["InventoryAdjustmentRet"]>>;
     };
+    /**
+     * An inventory site is a location where inventory is stored. For example, a
+     * company might have a warehouse, a stockroom, and a showroom, each of which
+     * is an inventory site.
+     */
     inventorySite: {
         /**
          * Adds an inventory site.
@@ -865,6 +965,17 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.InventorySiteQueryRq) => Promise<NonNullable<QbdTypes.InventorySiteQueryRs["InventorySiteRet"]>>;
     };
+    /**
+     * An invoice records the amount owed by a customer who purchased goods or
+     * services but did not pay in full at the time of the sale. If full payment
+     * is received at the time of the sale, it is recorded as a sales receipt, not
+     * an invoice.
+     *
+     * In QuickBooks, invoices and estimates use similar fields, and an estimate
+     * can be converted into an invoice after the customer accepts the estimate.
+     * However, in the SDK, there is currently no ability to create an invoice
+     * directly from an estimate (you cannot link an invoice to an estimate).
+     */
     invoice: {
         /**
          * Adds an invoice.
@@ -927,6 +1038,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.InvoiceQueryRq) => Promise<NonNullable<QbdTypes.InvoiceQueryRs["InvoiceRet"]>>;
     };
+    /**
+     * A discount item is a percentage or a fixed amount that will be subtracted
+     * from a total or subtotal.
+     */
     itemDiscount: {
         /**
          * Adds a discount item. A discount item is a percentage or a fixed amount
@@ -1002,6 +1117,12 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemDiscountQueryRq) => Promise<NonNullable<QbdTypes.ItemDiscountQueryRs["ItemDiscountRet"]>>;
     };
+    /**
+     * Fixed-asset items represent assets that will benefit a business for longer
+     * than one year. The purchase price of these fixed assets is typically
+     * expensed over a period of years, rather than in the year the purchase was
+     * made.
+     */
     itemFixedAsset: {
         /**
          * Adds a fixed-asset item. Fixed-asset items represent assets that will
@@ -1028,6 +1149,9 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemFixedAssetQueryRq) => Promise<NonNullable<QbdTypes.ItemFixedAssetQueryRs["ItemFixedAssetRet"]>>;
     };
+    /**
+     * An item group represents items that are grouped together for fast entry.
+     */
     itemGroup: {
         /**
          * Adds an item group. `ItemGroup` objects represent items that are grouped
@@ -1054,6 +1178,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemGroupQueryRq) => Promise<NonNullable<QbdTypes.ItemGroupQueryRs["ItemGroupRet"]>>;
     };
+    /**
+     * An inventory item is any merchandise or part that a business purchases,
+     * tracks as inventory, and then resells.
+     */
     itemInventory: {
         /**
          * Adds an inventory item. An inventory item is any merchandise or part that
@@ -1101,6 +1229,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemInventoryQueryRq) => Promise<NonNullable<QbdTypes.ItemInventoryQueryRs["ItemInventoryRet"]>>;
     };
+    /**
+     * An inventory assembly item is an item that is assembled or manufactured
+     * from other inventory items. The items and/or assemblies that make up the
+     * assembly are called components.
+     */
     itemInventoryAssembly: {
         /**
          * Adds an inventory assembly item, which is an item that is assembled or
@@ -1141,6 +1274,14 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemInventoryAssemblyQueryRq) => Promise<NonNullable<QbdTypes.ItemInventoryAssemblyQueryRs["ItemInventoryAssemblyRet"]>>;
     };
+    /**
+     * A non-inventory item is any material or part that a business buys but does
+     * not keep on hand as inventory. There are two types of non-inventory items:
+     * 1. Materials or parts that are part of the business’s overhead (for
+     *    example, office supplies
+     * 2. Materials or parts that the business buys to finish a specific job and
+     *    then charges back to the customer.
+     */
     itemNonInventory: {
         /**
          * Adds a non-inventory item, which is any material or part that a business
@@ -1173,13 +1314,13 @@ export default class QbdIntegration extends BaseIntegration {
          * the change should apply to existing transactions or not. Specifying True
          * for the boolean basically dismisses this with a “Yes” answer, allowing
          * your changes to be made and changes any existing transactions that use
-         * the item with that `AccountRef`. Specifying “False” means that the mod will
-         * not take affect if there are existing transactions. Setting this to
+         * the item with that `AccountRef`. Specifying “False” means that the mod
+         * will not take affect if there are existing transactions. Setting this to
          * “True” should be used with caution and normally only after some user has
          * indicated that they want those changes made to all those existing
          * transactions! If any affected transactions are protected by a closing
-         * date and password, the `AccountRef` changes will not be made and so the Mod
-         * request will return an error without making the requested Mod.
+         * date and password, the `AccountRef` changes will not be made and so the
+         * Mod request will return an error without making the requested Mod.
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemNonInventoryMod
          */
@@ -1191,6 +1332,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemNonInventoryQueryRq) => Promise<NonNullable<QbdTypes.ItemNonInventoryQueryRs["ItemNonInventoryRet"]>>;
     };
+    /**
+     * An other charge item are miscellaneous charges that do not fall into the
+     * categories of service, labor, materials, or parts. Examples include
+     * delivery charges, setup fees, and service charges.
+     */
     itemOtherCharge: {
         /**
          * Adds an other charge item, which are miscellaneous charges that do not
@@ -1237,6 +1383,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemOtherChargeQueryRq) => Promise<NonNullable<QbdTypes.ItemOtherChargeQueryRs["ItemOtherChargeRet"]>>;
     };
+    /**
+     * A payment item is a type of item that is used to record a payment that is
+     * received from a customer.
+     */
     itemPayment: {
         /**
          * Adds an item payment or set of payments. You can use this request to
@@ -1268,6 +1418,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemPaymentQueryRq) => Promise<NonNullable<QbdTypes.ItemPaymentQueryRs["ItemPaymentRet"]>>;
     };
+    /**
+     * An item receipt transaction is a transaction entered in QuickBooks when a
+     * shipment is received from a vendor.
+     */
     itemReceipt: {
         /**
          * Adds an item receipt transaction, which is a transaction entered in
@@ -1296,6 +1450,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemReceiptQueryRq) => Promise<NonNullable<QbdTypes.ItemReceiptQueryRs["ItemReceiptRet"]>>;
     };
+    /**
+     * A sales-tax item is an item used to calculate a single sales tax that is
+     * collected at a specified rate and paid to a single agency.
+     */
     itemSalesTax: {
         /**
          * Adds a sales-tax item, which is an item used to calculate a single sales
@@ -1351,6 +1509,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemSalesTaxQueryRq) => Promise<NonNullable<QbdTypes.ItemSalesTaxQueryRs["ItemSalesTaxRet"]>>;
     };
+    /**
+     * A sales-tax group item is an item used for calculating two or more sales
+     * taxes grouped together and applied to the same sale. For example, local and
+     * state taxes could be tracked separately but applied to a sale as one tax.
+     */
     itemSalesTaxGroup: {
         /**
          * Adds a sales-tax group item, which is an item used for calculating two or
@@ -1403,6 +1566,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemSalesTaxGroupQueryRq) => Promise<NonNullable<QbdTypes.ItemSalesTaxGroupQueryRs["ItemSalesTaxGroupRet"]>>;
     };
+    /**
+     * A service item is an item that refers to services that a business charges
+     * for or purchases. Examples include specialized labor, consulting hours, and
+     * professional fees.
+     */
     itemService: {
         /**
          * Adds a service item, which is an item that refers to services that a
@@ -1415,8 +1583,8 @@ export default class QbdIntegration extends BaseIntegration {
          * In a `TimeTracking` message, `ItemServiceRef` refers to the type of work.
          * If no `CustomerRef` is specified, then `ItemServiceRef` is not needed. If
          * `IsBillable` is set to true, then `TimeTrackingAdd` must include both
-         * `ItemServiceRef` and `CustomerRef`.
-         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
+         * `ItemServiceRef` and `CustomerRef`. See more:
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemServiceAdd
          */
         add: (endUserId: string, params: QbdTypes.ItemServiceAddRq["ItemServiceAdd"]) => Promise<NonNullable<QbdTypes.ItemServiceAddRs["ItemServiceRet"]>>;
         /**
@@ -1458,6 +1626,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemServiceQueryRq) => Promise<NonNullable<QbdTypes.ItemServiceQueryRs["ItemServiceRet"]>>;
     };
+    /**
+     * A subtotal item is used on a sales form to add up the amounts of the item
+     * lines above it, up to the previous subtotal.
+     */
     itemSubtotal: {
         /**
          * Adds a subtotal item. On a sales form, a subtotal item will add up the
@@ -1481,6 +1653,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ItemSubtotalQueryRq) => Promise<NonNullable<QbdTypes.ItemSubtotalQueryRs["ItemSubtotalRet"]>>;
     };
+    /**
+     * A job type can be used to separate jobs into any categories that are
+     * meaningful to the business.
+     */
     jobType: {
         /**
          * Adds a job type. A job type can be used to separate jobs into any
@@ -1500,6 +1676,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.JobTypeQueryRq) => Promise<NonNullable<QbdTypes.JobTypeQueryRs["JobTypeRet"]>>;
     };
+    /**
+     * A journal entry is used for recording transactions directly in the general
+     * journal, particularly for activities like depreciation. It requires paired
+     * credit and debit lines in one request to balance the monetary amounts.
+     */
     journalEntry: {
         /**
          * The debit and credit lines can be intermingled. A credit line can legally
@@ -1569,6 +1750,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.JournalEntryQueryRq) => Promise<NonNullable<QbdTypes.JournalEntryQueryRs["JournalEntryRet"]>>;
     };
+    /**
+     * A lead is a potential customer or sales opportunity that a business might
+     * have.
+     */
     lead: {
         /**
          * Adds a lead.
@@ -1589,6 +1774,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.LeadQueryRq) => Promise<NonNullable<QbdTypes.LeadQueryRs["LeadRet"]>>;
     };
+    /**
+     * The “other names” list contains any names that do not appear on customer,
+     * vendor, or employee lists.
+     */
     otherName: {
         /**
          * Adds an other name. In QuickBooks, the “other names” list contains any
@@ -1610,6 +1799,12 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.OtherNameQueryRq) => Promise<NonNullable<QbdTypes.OtherNameQueryRs["OtherNameRet"]>>;
     };
+    /**
+     * A price level is used to specify custom pricing for specific customers.
+     * Once you create a price level for a customer, QuickBooks will automatically
+     * use the custom price in new invoices, sales receipts, sales orders or
+     * credit memos for that customer.
+     */
     priceLevel: {
         /**
          * Adds a price level. You can use price levels to specify custom pricing
@@ -1644,6 +1839,9 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.PriceLevelQueryRq) => Promise<NonNullable<QbdTypes.PriceLevelQueryRs["PriceLevelRet"]>>;
     };
+    /**
+     * A purchase order is an order submitted to a vendor.
+     */
     purchaseOrder: {
         /**
          * Adds a purchase order, which is an order submitted to a vendor. You can
@@ -1685,6 +1883,15 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.PurchaseOrderQueryRq) => Promise<NonNullable<QbdTypes.PurchaseOrderQueryRs["PurchaseOrderRet"]>>;
     };
+    /**
+     * A receive payment transaction is used for one or more of these purposes:
+     * 1. To record a customer’s payment against an invoice for one or more jobs,
+     * 2. To set a discount (for early payment, for example),
+     * 3. To set a credit (from previously returned merchandise, for example).
+     *
+     * If full payment is received at the time of sale, it is recorded using a
+     * sales receipt transaction, not a receive payments transaction.
+     */
     receivePayment: {
         /**
          * Receives a customer payment into QuickBooks. A receive payment
@@ -1777,6 +1984,12 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.ReceivePaymentQueryRq) => Promise<NonNullable<QbdTypes.ReceivePaymentQueryRs["ReceivePaymentRet"]>>;
     };
+    /**
+     * A report in QuickBooks Desktop is a tool that allows users to generate
+     * detailed financial statements and overviews, such as Profit and Loss
+     * statements or General Ledger detail reports, tailored to their specific
+     * needs.
+     */
     report: {
         /**
          * Generates budget reports similar to the budget report functionality that
@@ -1978,6 +2191,12 @@ export default class QbdIntegration extends BaseIntegration {
          */
         time: (endUserId: string, params: QbdTypes.TimeReportQueryRq) => Promise<NonNullable<QbdTypes.TimeReportQueryRs["ReportRet"]>>;
     };
+    /**
+     * A sales order tracks inventory that is on back order for a customer. In
+     * QuickBooks, sales orders and invoices use similar fields, and a sales order
+     * can be “converted” into an invoice (by linking the invoice to the sales
+     * order) once the inventory is in stock.
+     */
     salesOrder: {
         /**
          * Adds a sales order.
@@ -2023,6 +2242,9 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.SalesOrderQueryRq) => Promise<NonNullable<QbdTypes.SalesOrderQueryRs["SalesOrderRet"]>>;
     };
+    /**
+     * Sales receipts include payments by cash, check, or credit card.
+     */
     salesReceipt: {
         /**
          * Adds a sales receipt to QuickBooks.
@@ -2065,6 +2287,9 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.SalesReceiptQueryRq) => Promise<NonNullable<QbdTypes.SalesReceiptQueryRs["SalesReceiptRet"]>>;
     };
+    /**
+     * A sales rep is a sales representative listed on sales forms.
+     */
     salesRep: {
         /**
          * Adds a sales rep.
@@ -2093,6 +2318,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.SalesRepQueryRq) => Promise<NonNullable<QbdTypes.SalesRepQueryRs["SalesRepRet"]>>;
     };
+    /**
+     * A sales tax code helps categorize items on a sales form as taxable or
+     * non-taxable, detailing reasons and associating tax codes with customers,
+     * items, or transactions.
+     */
     salesTaxCode: {
         /**
          * Adds a sales tax code.
@@ -2109,13 +2339,14 @@ export default class QbdIntegration extends BaseIntegration {
          * preference within QuickBooks is set to No, QuickBooks will assign the
          * default non-taxable sales-tax code to all sales.
          *
-         * A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In a
-         * request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and
-         * `ListID`, `FullName` will be ignored. In a Customer message, `SalesTaxCodeRef`
-         * refers to the sales-tax code that will be used for items related to this
-         * customer. In an ItemInventory message, `SalesTaxCodeRef` refers to the type
-         * of sales tax that will be charged for this item, if it is a taxable item
-         * and if sales tax is set up within QuickBooks.
+         * A `SalesTaxCodeRef` aggregate refers to a sales-tax code on the list. In
+         * a request, if a `SalesTaxCodeRef` aggregate includes both `FullName` and
+         * `ListID`, `FullName` will be ignored. In a Customer message,
+         * `SalesTaxCodeRef` refers to the sales-tax code that will be used for
+         * items related to this customer. In an ItemInventory message,
+         * `SalesTaxCodeRef` refers to the type of sales tax that will be charged
+         * for this item, if it is a taxable item and if sales tax is set up within
+         * QuickBooks.
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxCodeAdd
          */
@@ -2137,9 +2368,14 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.SalesTaxCodeQueryRq) => Promise<NonNullable<QbdTypes.SalesTaxCodeQueryRs["SalesTaxCodeRet"]>>;
     };
+    /**
+     * A sales tax payment check is a payment made for sales tax owed (for
+     * example, to a state sales tax authority).
+     */
     salesTaxPaymentCheck: {
         /**
-         * Adds a payment made for sales tax owed (for example, to a state sales tax authority).
+         * Adds a payment made for sales tax owed (for example, to a state sales tax
+         * authority).
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxPaymentCheckAdd
          */
@@ -2151,12 +2387,18 @@ export default class QbdIntegration extends BaseIntegration {
          */
         mod: (endUserId: string, params: QbdTypes.SalesTaxPaymentCheckModRq["SalesTaxPaymentCheckMod"]) => Promise<NonNullable<QbdTypes.SalesTaxPaymentCheckModRs["SalesTaxPaymentCheckRet"]>>;
         /**
-         * Queries for payments that have been made for sales tax owed (for example, to a state sales tax authority).
+         * Queries for payments that have been made for sales tax owed (for example,
+         * to a state sales tax authority).
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/SalesTaxPaymentCheckQuery
          */
         query: (endUserId: string, params?: QbdTypes.SalesTaxPaymentCheckQueryRq) => Promise<NonNullable<QbdTypes.SalesTaxPaymentCheckQueryRs["SalesTaxPaymentCheckRet"]>>;
     };
+    /**
+     * Standard terms show the number of days within which payment is due and can
+     * include a discount for early payment. Payments with date-driven terms, on
+     * the other hand, are due by a certain date.
+     */
     standardTerms: {
         /**
          * Adds a standard term. Standard terms show the number of days within which
@@ -2164,7 +2406,8 @@ export default class QbdIntegration extends BaseIntegration {
          * the following standard term means that payment is due in 30 days, with a
          * 1% discount if payment is made within 10 days: "1% 10 Net 30".
          *
-         * Payments with date-driven terms, on the other hand, are due by a certain date.
+         * Payments with date-driven terms, on the other hand, are due by a certain
+         * date.
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/StandardTermsAdd
          */
@@ -2176,6 +2419,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.StandardTermsQueryRq) => Promise<NonNullable<QbdTypes.StandardTermsQueryRs["StandardTermsRet"]>>;
     };
+    /**
+     * The time-tracking object facilitates payroll and invoicing based on work
+     * hours, assignable to vendors, employees, or others.
+     */
     timeTracking: {
         /**
          * The time-tracking transactions that are returned in this query include
@@ -2227,6 +2474,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.TimeTrackingQueryRq) => Promise<NonNullable<QbdTypes.TimeTrackingQueryRs["TimeTrackingRet"]>>;
     };
+    /**
+     * A transfer is a transaction that moves money from one account to another
+     * account.
+     */
     transfer: {
         /**
          * Adds a transfer transaction.
@@ -2247,6 +2498,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.TransferQueryRq) => Promise<NonNullable<QbdTypes.TransferQueryRs["TransferRet"]>>;
     };
+    /**
+     * An inventory transfer is the movement of inventory between two inventory
+     * sites.
+     */
     transferInventory: {
         /**
          * Adds a transfer inventory transaction.
@@ -2268,9 +2523,14 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.TransferInventoryQueryRq) => Promise<NonNullable<QbdTypes.TransferInventoryQueryRs["TransferInventoryRet"]>>;
     };
+    /**
+     * A vehicle is used to add, select, and manage vehicles for tracking and
+     * billing mileage.
+     */
     vehicle: {
         /**
-         * Adds a vehicle to the vehicle list for use in `VehicleMileage` transactions. Each vehicle name must be unique.
+         * Adds a vehicle to the vehicle list for use in `VehicleMileage`
+         * transactions. Each vehicle name must be unique.
          *
          * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/VehicleAdd
          */
@@ -2290,6 +2550,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.VehicleQueryRq) => Promise<NonNullable<QbdTypes.VehicleQueryRs["VehicleRet"]>>;
     };
+    /**
+     * Vehicle mileage records a mileage transaction for a specified vehicle,
+     * using provided or calculated miles.
+     */
     vehicleMileage: {
         /**
          * Adds a vehicle mileage transaction. involving the specified vehicle for
@@ -2307,6 +2571,12 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.VehicleMileageQueryRq) => Promise<NonNullable<QbdTypes.VehicleMileageQueryRs["VehicleMileageRet"]>>;
     };
+    /**
+     * A vendor is any person or company from whom a small business owner buys
+     * goods and services. (Banks and tax agencies usually are included on the
+     * vendor list.) A company’s vendor list contains information such as account
+     * balance and contact information about each vendor.
+     */
     vendor: {
         /**
          * Adds a vendor.
@@ -2335,6 +2605,11 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.VendorQueryRq) => Promise<NonNullable<QbdTypes.VendorQueryRs["VendorRet"]>>;
     };
+    /**
+     * A vendor credit is also known as a “bill credit”. That is, it is a credit
+     * that a vendor owes you because you overpaid your bill, returned
+     * merchandise, or for some other reason.
+     */
     vendorCredit: {
         /**
          * Adds a vendor credit.
@@ -2377,6 +2652,12 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.VendorCreditQueryRq) => Promise<NonNullable<QbdTypes.VendorCreditQueryRs["VendorCreditRet"]>>;
     };
+    /**
+     * A vendor type allows business owners to categorize vendors in ways that are
+     * meaningful for their businesses. For example, a vendor type might indicate
+     * which industry a vendor represents, or which part of the country a vendor
+     * is in.
+     */
     vendorType: {
         /**
          * Adds a vendor type. A vendor type allows business owners to categorize
@@ -2398,6 +2679,10 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.VendorTypeQueryRq) => Promise<NonNullable<QbdTypes.VendorTypeQueryRs["VendorTypeRet"]>>;
     };
+    /**
+     * A workers comp code categorizes occupations based on risk, determining
+     * insurance premiums for workers' compensation coverage.
+     */
     workersCompCode: {
         /**
          * Adds a workers’ compensation code with one or more rate entries (each