conductor-node 11.5.4 → 11.5.5

package/dist/package.json

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

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

@@ -127,7 +127,7 @@ export default class QbdIntegration extends BaseIntegration {
          * 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
+         * 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,
@@ -209,6 +209,8 @@ export default class QbdIntegration extends BaseIntegration {
      */
     billPaymentCheck: {
         /**
+         * Adds a bill payment check.
+         *
          * 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.
@@ -220,18 +222,21 @@ export default class QbdIntegration extends BaseIntegration {
          * `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
+         * 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.
+         * payment in the QB SDK Programmer’s Guide. Notice that the request
+         * requires one (but not more than one!) `BillPaymentCheckAdd` sub
+         * aggregate, which is provided to support the SDK macro feature in this
+         * request. 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.
+         * 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.
@@ -290,10 +295,13 @@ export default class QbdIntegration extends BaseIntegration {
          */
         mod: (endUserId: string, params: QbdTypes.BillPaymentCheckModRq["BillPaymentCheckMod"]) => Promise<NonNullable<QbdTypes.BillPaymentCheckModRs["BillPaymentCheckRet"]>>;
         /**
+         * Returns bill payment check transactions based on the supplied query
+         * criteria.
+         *
          * 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
+         * 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.
          *
@@ -324,6 +332,93 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (endUserId: string, params?: QbdTypes.BillPaymentCheckQueryRq) => Promise<NonNullable<QbdTypes.BillPaymentCheckQueryRs["BillPaymentCheckRet"]>>;
     };
+    /**
+     * A bill payment credit card is a transaction that represents a payment by
+     * credit card for a bill.
+     */
+    billPaymentCreditCard: {
+        /**
+         * Adds a bill payment credit card.
+         *
+         * A `BillPaymentCreditCardAdd` 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.
+         *
+         * `BillPaymentCreditCardAdd` provides 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 the request
+         * requires one (but not more than one!) `BillPaymentCreditCardAdd`
+         * sub-aggregate. 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 `BillPaymentCreditCardAdd` 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.
+         *
+         * Finally, notice that it is possible to issue this request using only
+         * `SetCredit` to apply an existing credit to the bill. However, if you do
+         * this, you should be aware that no transaction ID is generated. The credit
+         * and the bill simply are linked.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCreditCardAdd
+         */
+        add: (endUserId: string, params: QbdTypes.BillPaymentCreditCardAddRq["BillPaymentCreditCardAdd"]) => Promise<NonNullable<QbdTypes.BillPaymentCreditCardAddRs["BillPaymentCreditCardRet"]>>;
+        /**
+         * Returns bill payment credit card transactions based on the supplied query
+         * criteria.
+         *
+         * Provides functionality found in the Find/Advanced Find window to find
+         * bill payments that were paid by credit card. 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’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.
+         *
+         * Important: If you made a bill payment by credit card, and ONLY applied a
+         * credit using `SetCredit` (no funds were applied other than the credit),
+         * then that payment will not be returned in this query because it is not
+         * considered a separate transaction and has no `TxnID`. To get that kind of
+         * payment, you must do a `BillQuery` on the original bill and specify
+         * `IncludeLinkedTxns`. Any applied credit will be linked directly to the
+         * bill.
+         *
+         * 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).
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCreditCardQuery
+         */
+        query: (endUserId: string, params?: QbdTypes.BillPaymentCreditCardQueryRq) => Promise<NonNullable<QbdTypes.BillPaymentCreditCardQueryRs["BillPaymentCreditCardRet"]>>;
+    };
     /**
      * A build assembly represents an inventory item created from other inventory
      * items or assemblies.

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

@@ -132,7 +132,7 @@ class QbdIntegration extends BaseIntegration_1.default {
          * 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
+         * 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,
@@ -214,6 +214,8 @@ class QbdIntegration extends BaseIntegration_1.default {
      */
     billPaymentCheck = {
         /**
+         * Adds a bill payment check.
+         *
          * 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.
@@ -225,18 +227,21 @@ class QbdIntegration extends BaseIntegration_1.default {
          * `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
+         * 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.
+         * payment in the QB SDK Programmer’s Guide. Notice that the request
+         * requires one (but not more than one!) `BillPaymentCheckAdd` sub
+         * aggregate, which is provided to support the SDK macro feature in this
+         * request. 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.
+         * 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.
@@ -295,10 +300,13 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         mod: async (endUserId, params) => this.sendRequestWrapper(endUserId, { BillPaymentCheckModRq: { BillPaymentCheckMod: params } }, "BillPaymentCheckModRs", "BillPaymentCheckRet"),
         /**
+         * Returns bill payment check transactions based on the supplied query
+         * criteria.
+         *
          * 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
+         * 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.
          *
@@ -329,6 +337,93 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { BillPaymentCheckQueryRq: params }, "BillPaymentCheckQueryRs", "BillPaymentCheckRet"),
     };
+    /**
+     * A bill payment credit card is a transaction that represents a payment by
+     * credit card for a bill.
+     */
+    billPaymentCreditCard = {
+        /**
+         * Adds a bill payment credit card.
+         *
+         * A `BillPaymentCreditCardAdd` 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.
+         *
+         * `BillPaymentCreditCardAdd` provides 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 the request
+         * requires one (but not more than one!) `BillPaymentCreditCardAdd`
+         * sub-aggregate. 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 `BillPaymentCreditCardAdd` 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.
+         *
+         * Finally, notice that it is possible to issue this request using only
+         * `SetCredit` to apply an existing credit to the bill. However, if you do
+         * this, you should be aware that no transaction ID is generated. The credit
+         * and the bill simply are linked.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCreditCardAdd
+         */
+        add: async (endUserId, params) => this.sendRequestWrapper(endUserId, { BillPaymentCreditCardAddRq: { BillPaymentCreditCardAdd: params } }, "BillPaymentCreditCardAddRs", "BillPaymentCreditCardRet"),
+        /**
+         * Returns bill payment credit card transactions based on the supplied query
+         * criteria.
+         *
+         * Provides functionality found in the Find/Advanced Find window to find
+         * bill payments that were paid by credit card. 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’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.
+         *
+         * Important: If you made a bill payment by credit card, and ONLY applied a
+         * credit using `SetCredit` (no funds were applied other than the credit),
+         * then that payment will not be returned in this query because it is not
+         * considered a separate transaction and has no `TxnID`. To get that kind of
+         * payment, you must do a `BillQuery` on the original bill and specify
+         * `IncludeLinkedTxns`. Any applied credit will be linked directly to the
+         * bill.
+         *
+         * 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).
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BillPaymentCreditCardQuery
+         */
+        query: async (endUserId, params = {}) => this.sendRequestWrapper(endUserId, { BillPaymentCreditCardQueryRq: params }, "BillPaymentCreditCardQueryRs", "BillPaymentCreditCardRet"),
+    };
     /**
      * A build assembly represents an inventory item created from other inventory
      * items or assemblies.

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

@@ -786,6 +786,106 @@ export interface BillPaymentCheckRet {
     /** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
     DataExtRet?: DataExtRet | DataExtRet[];
 }
+export interface BillPaymentCreditCardAdd {
+    /** Refers to a payee who is a customer, vendor, employee, or person on the “other names” list. In a request, if a `PayeeEntityRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Check message, `PayeeEntityRef` refers to the person or company to whom the check is written. In `CreditCardCharge` and `CreditCardCredit` messages, `PayeeEntityRef` refers to the vendor or company from whom merchandise was purchased. (`PayeeEntityRef` corresponds to the choice in the Purchased From list in QuickBooks.) */
+    PayeeEntityRef: PayeeEntityRef;
+    /** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.) If `APAccountRef` is missing, the SDK will use the QuickBooks default AP account. In a request, if an `APAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    APAccountRef?: APAccountRef;
+    /** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
+    TxnDate?: string;
+    /** Refers to the credit card account to which this payment is being charged. In a request, if a `CreditCardAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    CreditCardAccountRef: CreditCardAccountRef;
+    /** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
+    RefNumber?: string;
+    /** Additional information. */
+    Memo?: string;
+    /** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
+    ExchangeRate?: number;
+    /** Allows for the attachment of a user defined GUID value. */
+    ExternalGUID?: string;
+    /** `AppliedToTxn` List A list of `AppliedToTxn` aggregates. */
+    AppliedToTxnAdd: AppliedToTxnAdd | AppliedToTxnAdd[];
+}
+export interface BillPaymentCreditCardAddRq {
+    BillPaymentCreditCardAdd: BillPaymentCreditCardAdd;
+    /** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
+    IncludeRetElement?: string[] | string;
+}
+export interface BillPaymentCreditCardAddRs {
+    BillPaymentCreditCardRet?: BillPaymentCreditCardRet;
+    ErrorRecovery?: ErrorRecovery;
+}
+export interface BillPaymentCreditCardQueryRq {
+    /** One or more `TxnID` values. QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQuery` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
+    TxnID?: string[] | string;
+    /** A list of one or more `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user. Note (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request, the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
+    RefNumber?: string[] | string;
+    /** A list of one or more case sensitive `RefNumber` values. A `RefNumber` is a string of characters that refers to a transaction and that can be arbitrarily changed by the QuickBooks user. You should use this case sensitive ref number list rather than the older `RefNumber` list, because it provides much better performance in certain circumstances. The older `refNumber` list provided slow performance if the `refNumber` values contained letters, not just digits. This `RefNumberCaseSensitive` list, new in SDK 4.0, eliminates this performance hit. */
+    RefNumberCaseSensitive?: string[] | string;
+    /** Limits the number of objects that a query returns. (To get a count of how many objects could possibly be returned, use the `metaData` query attribute.) If you include a `MaxReturned` value, it must be at least 1. */
+    MaxReturned?: number;
+    /** Filters according to the dates when transactions were last modified. The `ModifiedDateRangeFilter` aggregate is not required to contain any elements, but if it is empty, we recommend that you leave it out altogether. Note that the time portion of the `FromModifiedDate` and `ToModifiedDate` fields was not supported in qbXML version 1.0 or 1.1. (To filter according to the dates when transactions were deleted, use a `TxnDeletedQuery` message.) */
+    ModifiedDateRangeFilter?: ModifiedDateRangeFilter;
+    /** Filters according to the original transaction dates. */
+    TxnDateRangeFilter?: TxnDateRangeFilter;
+    /** An entity refers to a person on the QuickBooks Customer list, Vendor list, Employee list, or `Other` Names list. You can use an `EntityQuery` request to get information about all the entities that are set up in the QuickBooks file. In an `ARRefundCreditCard` query, this must be a customer/customer job. */
+    EntityFilter?: EntityFilter;
+    /** Filters according to the account name or `ListID`. If the “Use account numbers” preference is enabled in the QuickBooks company file, you can specify an account number (instead of an account name) for `FullName` and get the account you’re looking for. But if numbers have been used as account names, confusion could arise. For example, if you queried for an account named 2050, and 2050 happened to be the account number of a totally different account, the query would not return what you asked for (the account named 2050), but instead would return the account with the account number 2050. This problem will not happen if the “Use account numbers” preference is turned off in the QuickBooks file, orthe account name exactly matches the account number. (In this case, query would return the correct account either way.) To avoid this problem: Do not name an account using a number unless the number exactly matches the account’s account number. If an account name must contain a number that does not match its own account number, have the QuickBooks user change the account’s name slightly, for example `to` 2050a. */
+    AccountFilter?: AccountFilter;
+    /** Filters according to `RefNumber`. */
+    RefNumberFilter?: RefNumberFilter;
+    /** Filters according to `RefNumber`. The filtering code will do a numerical comparison (if `FromRefNumber` and `ToRefNumber` only contain digits) or a lexicographical comparison (if either `FromRefNumber` or `ToRefNumber` contain any nondigit characters). In the first situation, if you need to query for a `RefNumber` that is larger than the maximum long integer value of 2147483647, one workaround is to specify a `FromRefNumber` that is less than or equal to 2147483647 without specifying a `ToRefNumber`. */
+    RefNumberRangeFilter?: RefNumberRangeFilter;
+    /** Filters by the specified currency. */
+    CurrencyFilter?: CurrencyFilter;
+    /** This filter allows you to omit line items from a query response to get a smaller result. The default value is false, so line items are omitted by default. Set `IncludeLineItems` to true to include line items in the response if you don’t mind getting a larger result. */
+    IncludeLineItems?: boolean;
+    /** You use this if you want to limit the data that will be returned in the response. In this list, you specify the name of each top-level element or aggregate that you want to be returned in the response to the request. You cannot specify fields within an aggregate, for example, you cannot specify a `City` within an `Address`: you must specify `Address` and will get the entire address. The names specified in the list are not parsed, so you must be especially careful to supply valid names, properly cased. No error is returned in the status code if you specify an invalid name. Notice that if you want to return custom data or private data extensions, you must specify the `DataExtRet` element and you must supply the `OwnerID` set to either a value of 0 (custom data) or the GUID for the private data. */
+    IncludeRetElement?: string[] | string;
+    /** Zero or more `OwnerID` values. `OwnerID` refers to the owner of a data extension:If `OwnerID` is 0, this is a public data extension, also known as a custom field. Custom fields appear in the QuickBooks UI.If `OwnerID` is a GUID, for example `{6B063959-81B0-4622-85D6-F548C8CCB517}`, this field is a private data extension defined by an integrated application. Private data extensions do not appear in the QuickBooks UI. Note that `OwnerID` values are not case-sensitive, meaning that if you enter an `OwnerID` value with lower-case letters, the value will be saved and returned with upper-case letters. When you share a private data extension with another application, the other application must know both the `OwnerID` and the `DataExtName`, as these together form a data extension’s unique name. */
+    OwnerID?: string[] | string;
+}
+export interface BillPaymentCreditCardQueryRs {
+    BillPaymentCreditCardRet: BillPaymentCreditCardRet[];
+}
+export interface BillPaymentCreditCardRet {
+    /** QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks. A `TxnID` returned from a request can be used to refer to the transaction in subsequent requests. Notice that you cannot supply the `TxnID` of a `TimeTracking` transaction to `TransactionQueryRq` requests. If you do, you get an error stating that no such record could be found, even though the transaction is in QuickBooks. This behavior reflects the behavior in the QuicKBooks UI in the Find window. */
+    TxnID?: string;
+    /** Time the object was created. */
+    TimeCreated?: string;
+    /** Time the object was last modified. */
+    TimeModified?: string;
+    /** A number that the server generates and assigns to this object. Every time the object is changed, the server will change its `EditSequence` value. When you try to modify a list object, you must provide its `EditSequence`. The server compares the `EditSequence` you provide with the `EditSequence` in memory to make sure you are dealing with the latest copy of the object. If you are not, the server will reject the request and return an error. Because `EditSequence` is only used to check whether two objects match, there is no reason to interpret its value. */
+    EditSequence?: string;
+    /** An identifying number for this transaction. */
+    TxnNumber?: number;
+    /** Refers to a payee who is a customer, vendor, employee, or person on the “other names” list. In a request, if a `PayeeEntityRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a Check message, `PayeeEntityRef` refers to the person or company to whom the check is written. In `CreditCardCharge` and `CreditCardCredit` messages, `PayeeEntityRef` refers to the vendor or company from whom merchandise was purchased. (`PayeeEntityRef` corresponds to the choice in the Purchased From list in QuickBooks.) */
+    PayeeEntityRef?: PayeeEntityRef;
+    /** Refers to an accounts payable account in the QuickBooks file. (The `AccountType` of this account will be `AccountsPayable`.) If `APAccountRef` is missing, the SDK will use the QuickBooks default AP account. In a request, if an `APAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    APAccountRef?: APAccountRef;
+    /** The date of the transaction. In some cases, if you leave `TxnDate` out of an -Add message, QuickBooks will prefill `TxnDate` with the date of the last-saved transaction of the same type. */
+    TxnDate?: string;
+    /** Refers to the credit card account to which this payment is being charged. In a request, if a `CreditCardAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    CreditCardAccountRef?: CreditCardAccountRef;
+    /** A monetary amount. */
+    Amount?: string;
+    /** The currency object contains all of the information needed by QuickBooks to display and use. For built-in currencies, the name and currency code values are internationally accepted values and thus are not editable. The comma format is editable, as is the `IsActive` status. For user-defined currencies, every value in the object is editable including name and currency code. When used with `PriceLevels`, the `CurrencyRef` should only be used with “per item” price levels. */
+    CurrencyRef?: CurrencyRef;
+    /** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
+    ExchangeRate?: number;
+    /** Amount in units of the home currency. */
+    AmountInHomeCurrency?: string;
+    /** A string of characters that refers to this transaction and that can be arbitrarily changed by the QuickBooks user. In a `BillPaymentCheckAdd` request, if you want to set the check number, use `RefNumber`.`Note` (especially relevant to `CheckAdd` requests): When `RefNumber` is left blank in an SDK transaction add request (that is, or ), the `RefNumber` will be left blank in QuickBooks. This behavior is new as of QBFC3. It used to select the next sequential reference number since the last one used by QuickBooks, as though no `RefNumber` had been provided. This is especially relevant to `CheckAdd` requests because with the current behavior, you will not know the number until the check is printed. */
+    RefNumber?: string;
+    /** Additional information. */
+    Memo?: string;
+    /** Allows for the attachment of a user defined GUID value. */
+    ExternalGUID?: string;
+    /** `AppliedToTxn` List A list of `AppliedToTxn` aggregates. */
+    AppliedToTxnRet?: AppliedToTxnRet | AppliedToTxnRet[];
+    /** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
+    DataExtRet?: DataExtRet | DataExtRet[];
+}
 export interface BillQueryRq {
     /** One or more `TxnID` values. QuickBooks generates a unique `TxnID` for each transaction that is added to QuickBooks.
   
@@ -1780,6 +1880,12 @@ export interface ContactsRet {
     /** List of additional contacts. */
     AdditionalContactRef?: AdditionalContactRef | AdditionalContactRef[];
 }
+export interface CreditCardAccountRef {
+    /** Along with `FullName`, `ListID` is a way to identify a list object. When a list object is added to QuickBooks through the SDK or through the QuickBooks user interface, the server assigns it a `ListID`. A `ListID` is not unique across lists, but it is unique across each particular type of list. For example, two customers could not have the same `ListID`, and a customer could not have the same `ListID` as an employee (because Customer and Employee are both name lists). But a customer could have the same `ListID` as a non-inventory item. */
+    ListID?: string;
+    /** `FullName` (along with `ListID`) is a way to identify a list object. The `FullName` is the name prefixed by the names of each ancestor, for example `Jones:Kitchen:Cabinets`. `FullName` values are not case-sensitive. */
+    FullName?: string;
+}
 export interface CreditCardChargeAdd {
     /** The Account list is the company file’s list of accounts. An `AccountRef` aggregate refers to one of these accounts. (If an `AccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored.) Special cases to note:In a Check message, `AccountRef` refers to the account from which the funds are being drawn for this check, for example, Checking or Savings.In an `ExpenseLineAdd` message, you must include `AccountRef` if the “Require accounts” check box is selected in the QuickBooks Accounting preferences. (It is selected by default.) In a `CreditCardCredit` message, `AccountRef` refers to the bank account or credit card account to which the credit is applied.In a `CreditCardCharge` message, `AccountRef` refers to the bank or credit card company to whom money is owed. How do you increase and decrease amounts in bank accounts? The following requests increase the balance in a bank account: Deposit Add `ReceivePaymentAdd` Journal Entry Add Sales `ReceiptAdd` The following requests decrease the balance in a bank account: `CheckAdd` Bill `PaymentCheckAdd` `JournalEntryAdd` */
     AccountRef: AccountRef;
@@ -2668,9 +2774,9 @@ export interface CreditMemoMod {
     You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
     ExchangeRate?: number;
     /** Represents one line in the credit memo. Compare with `CreditMemoGroupLine`, which represents a previously defined group of lines in the credit memo. */
-    CreditMemoLineMod?: CreditMemoLineMod;
+    CreditMemoLineMod?: CreditMemoLineMod | CreditMemoLineMod[];
     /** Represents a previously defined group of lines in the credit memo. Compare with `CreditMemoLine`, which represents just one line in the credit memo. */
-    CreditMemoLineGroupMod?: CreditMemoLineGroupMod;
+    CreditMemoLineGroupMod?: CreditMemoLineGroupMod | CreditMemoLineGroupMod[];
 }
 export interface CreditMemoModRq {
     CreditMemoMod: CreditMemoMod;
@@ -2840,9 +2946,9 @@ export interface CreditMemoRet {
     The list of linked transactions is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items. */
     LinkedTxn?: LinkedTxn | LinkedTxn[];
     /** Represents one line in the credit memo. Compare with `CreditMemoGroupLine`, which represents a previously defined group of lines in the credit memo. */
-    CreditMemoLineRet?: CreditMemoLineRet;
+    CreditMemoLineRet?: CreditMemoLineRet | CreditMemoLineRet[];
     /** Represents a previously defined group of lines in the credit memo. Compare with `CreditMemoLine`, which represents just one line in the credit memo. */
-    CreditMemoLineGroupRet?: CreditMemoLineGroupRet;
+    CreditMemoLineGroupRet?: CreditMemoLineGroupRet | CreditMemoLineGroupRet[];
     /** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
     DataExtRet?: DataExtRet | DataExtRet[];
 }
@@ -4654,9 +4760,9 @@ export interface EstimateMod {
     /** One line of this estimate. Compare with `EstimateLineGroup`, which represents a previously defined group of lines in the estimate.
   
     In a Mod request, you can add a new line by supplying a `TxnLineID` value of -1. */
-    EstimateLineMod?: EstimateLineMod;
+    EstimateLineMod?: EstimateLineMod | EstimateLineMod[];
     /** Represents a previously defined group of lines in the estimate. Compare with `EstimateLine`, which represents just one line in the estimate. */
-    EstimateLineGroupMod?: EstimateLineGroupMod;
+    EstimateLineGroupMod?: EstimateLineGroupMod | EstimateLineGroupMod[];
 }
 export interface EstimateModRq {
     EstimateMod: EstimateMod;
@@ -4826,9 +4932,9 @@ export interface EstimateRet {
     /** One line of this estimate. Compare with `EstimateLineGroup`, which represents a previously defined group of lines in the estimate.
   
     In a Mod request, you can add a new line by supplying a `TxnLineID` value of -1. */
-    EstimateLineRet?: EstimateLineRet;
+    EstimateLineRet?: EstimateLineRet | EstimateLineRet[];
     /** Represents a previously defined group of lines in the estimate. Compare with `EstimateLine`, which represents just one line in the estimate. */
-    EstimateLineGroupRet?: EstimateLineGroupRet;
+    EstimateLineGroupRet?: EstimateLineGroupRet | EstimateLineGroupRet[];
     /** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
     DataExtRet?: DataExtRet | DataExtRet[];
 }
@@ -5864,9 +5970,9 @@ export interface InvoiceMod {
     If you need to retrieve which transactions were linked in the `SetCredit`, for Bill Payment, you must do a `BillQuery` and specify `IncludeLinkedTxns`. */
     SetCredit?: SetCredit | SetCredit[];
     /** Represents one line in the invoice. Compare with `InvoiceLineGroup`, which represents a previously defined group of lines in the invoice. */
-    InvoiceLineMod?: InvoiceLineMod;
+    InvoiceLineMod?: InvoiceLineMod | InvoiceLineMod[];
     /** Represents a previously defined group of lines in the invoice. Compare with `InvoiceLine`, which represents just one line in the invoice. */
-    InvoiceLineGroupMod?: InvoiceLineGroupMod;
+    InvoiceLineGroupMod?: InvoiceLineGroupMod | InvoiceLineGroupMod[];
 }
 export interface InvoiceModRq {
     InvoiceMod: InvoiceMod;
@@ -9636,9 +9742,9 @@ export interface PurchaseOrderMod {
     /** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
     ExchangeRate?: number;
     /** One line of the purchase order. Compare with `PurchaseOrderLineGroup`, which represents a previously defined group of lines in the purchase order. */
-    PurchaseOrderLineMod?: PurchaseOrderLineMod;
+    PurchaseOrderLineMod?: PurchaseOrderLineMod | PurchaseOrderLineMod[];
     /** Represents a previously defined group of lines in the purchase order. Compare with `PurchaseOrderLine`, which represents just one line in the purchase order. */
-    PurchaseOrderLineGroupMod?: PurchaseOrderLineGroupMod;
+    PurchaseOrderLineGroupMod?: PurchaseOrderLineGroupMod | PurchaseOrderLineGroupMod[];
 }
 export interface PurchaseOrderModRq {
     PurchaseOrderMod: PurchaseOrderMod;
@@ -9760,9 +9866,9 @@ export interface PurchaseOrderRet {
     /** If the `IncludeLinkedTxns` flag is set to true in a query, or if you create an item receipt that links to other transactionsthen the returned object will include a list of linked transactions, if any exist. If no linked transactions exist, the `ILinkedTxnList` object will be empty. The list of linked transactions is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items. */
     LinkedTxn?: LinkedTxn | LinkedTxn[];
     /** One line of the purchase order. Compare with `PurchaseOrderLineGroup`, which represents a previously defined group of lines in the purchase order. */
-    PurchaseOrderLineRet?: PurchaseOrderLineRet;
+    PurchaseOrderLineRet?: PurchaseOrderLineRet | PurchaseOrderLineRet[];
     /** Represents a previously defined group of lines in the purchase order. Compare with `PurchaseOrderLine`, which represents just one line in the purchase order. */
-    PurchaseOrderLineGroupRet?: PurchaseOrderLineGroupRet;
+    PurchaseOrderLineGroupRet?: PurchaseOrderLineGroupRet | PurchaseOrderLineGroupRet[];
     /** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
     DataExtRet?: DataExtRet | DataExtRet[];
 }
@@ -10460,9 +10566,9 @@ export interface SalesOrderMod {
     /** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
     ExchangeRate?: number;
     /** Represents one line in the sales order. Compare with `SalesOrderLineGroup`, which represents a previously defined group of lines in the sales order. */
-    SalesOrderLineMod?: SalesOrderLineMod;
+    SalesOrderLineMod?: SalesOrderLineMod | SalesOrderLineMod[];
     /** Represents a previously defined group of lines in the sales order. Compare with `SalesOrderLine`, which represents just one line in the sales order. */
-    SalesOrderLineGroupMod?: SalesOrderLineGroupMod;
+    SalesOrderLineGroupMod?: SalesOrderLineGroupMod | SalesOrderLineGroupMod[];
     /** The Sales Channel `Name`. */
     SOChannel?: SOChannel;
     /** The Sales Store `Name`. */
@@ -10594,9 +10700,9 @@ export interface SalesOrderRet {
     /** If the `IncludeLinkedTxns` flag is set to true in a query, or if you create an item receipt that links to other transactionsthen the returned object will include a list of linked transactions, if any exist. If no linked transactions exist, the `ILinkedTxnList` object will be empty. The list of linked transactions is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items. */
     LinkedTxn?: LinkedTxn | LinkedTxn[];
     /** Represents one line in the sales order. Compare with `SalesOrderLineGroup`, which represents a previously defined group of lines in the sales order. */
-    SalesOrderLineRet?: SalesOrderLineRet;
+    SalesOrderLineRet?: SalesOrderLineRet | SalesOrderLineRet[];
     /** Represents a previously defined group of lines in the sales order. Compare with `SalesOrderLine`, which represents just one line in the sales order. */
-    SalesOrderLineGroupRet?: SalesOrderLineGroupRet;
+    SalesOrderLineGroupRet?: SalesOrderLineGroupRet | SalesOrderLineGroupRet[];
     /** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
     DataExtRet?: DataExtRet | DataExtRet[];
 }
@@ -10929,9 +11035,9 @@ export interface SalesReceiptMod {
     /** The exchange rate is the market price for which this currency can be exchanged for the currency used by the QuickBooks company file as the “home” currency. The exchange rate should be considered a snapshot of the rates in effect at the `AsOfDate`. You can update the exchange rate using the exchange rate property when you add a transaction. However, you need to obtain and supply the exchange rate. If you are using USD (United States Dollars) as the home currency and are connected to the Internet, you can download the current exchange rates for all active currencies automatically in the QuickBooks UI by selecting Lists->Currency->Activities->Download latest exchange rates. (Currently, you can’t do this in the SDK.) */
     ExchangeRate?: number;
     /** One line of the sales receipt. Compare with `SalesReceiptLineGroup`, which represents a previously defined group of lines in the sales receipt. */
-    SalesReceiptLineMod?: SalesReceiptLineMod;
+    SalesReceiptLineMod?: SalesReceiptLineMod | SalesReceiptLineMod[];
     /** Represents a previously defined group of lines in the sales receipt. Compare with `SalesReceiptLine`, which represents just one line in the sales receipt. */
-    SalesReceiptLineGroupMod?: SalesReceiptLineGroupMod;
+    SalesReceiptLineGroupMod?: SalesReceiptLineGroupMod | SalesReceiptLineGroupMod[];
 }
 export interface SalesReceiptModRq {
     SalesReceiptMod: SalesReceiptMod;
@@ -11057,9 +11163,9 @@ export interface SalesReceiptRet {
     /** Allows for the attachment of a user defined GUID value. */
     ExternalGUID?: string;
     /** One line of the sales receipt. Compare with `SalesReceiptLineGroup`, which represents a previously defined group of lines in the sales receipt. */
-    SalesReceiptLineRet?: SalesReceiptLineRet;
+    SalesReceiptLineRet?: SalesReceiptLineRet | SalesReceiptLineRet[];
     /** Represents a previously defined group of lines in the sales receipt. Compare with `SalesReceiptLine`, which represents just one line in the sales receipt. */
-    SalesReceiptLineGroupRet?: SalesReceiptLineGroupRet;
+    SalesReceiptLineGroupRet?: SalesReceiptLineGroupRet | SalesReceiptLineGroupRet[];
     /** A list of `IDataExtRet` objects, each of which represents a field that has been added to QuickBooks as a data extension. */
     DataExtRet?: DataExtRet | DataExtRet[];
 }

package/package.json

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