conductor-node 3.8.4 → 3.8.5

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "conductor-node",
-    "version": "3.8.4",
+    "version": "3.8.5",
     "description": "Conductor API wrapper",
     "author": "Danny Nemer <hi@DannyNemer.com>",
     "license": "MIT",

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

@@ -396,6 +396,29 @@ export default class QbdIntegration extends BaseIntegration {
          */
         query: (integrationUserConnectionId: string, params: QbdTypes.CustomerQueryRq) => Promise<NonNullable<QbdTypes.CustomerQueryRs["CustomerRet"]>>;
     };
+    deposit: {
+        /**
+         * After you receive payments from customers (see `ReceivePayment`), you can
+         * use the `DepositAdd` request to either deposit each payment directly into
+         * a QuickBooks bank account or you can group payments together. You can
+         * also choose the method you prefer for depositing payments.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositAdd
+         */
+        add: (integrationUserConnectionId: string, params: QbdTypes.DepositAddRq["DepositAdd"]) => Promise<NonNullable<QbdTypes.DepositAddRs["DepositRet"]>>;
+        /**
+         * Modifies an existing deposit.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositMod
+         */
+        mod: (integrationUserConnectionId: string, params: QbdTypes.DepositModRq["DepositMod"]) => Promise<NonNullable<QbdTypes.DepositModRs["DepositRet"]>>;
+        /**
+         * This request searches for deposits that match the supplied filters.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositQuery
+         */
+        query: (integrationUserConnectionId: string, params: QbdTypes.DepositQueryRq) => Promise<NonNullable<QbdTypes.DepositQueryRs["DepositRet"]>>;
+    };
     employee: {
         /**
          * Adds an employee with personal data about the employee as well as certain

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

@@ -400,6 +400,29 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { CustomerQueryRq: params }, "CustomerQueryRs", "CustomerRet"),
     };
+    deposit = {
+        /**
+         * After you receive payments from customers (see `ReceivePayment`), you can
+         * use the `DepositAdd` request to either deposit each payment directly into
+         * a QuickBooks bank account or you can group payments together. You can
+         * also choose the method you prefer for depositing payments.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositAdd
+         */
+        add: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { DepositAddRq: { DepositAdd: params } }, "DepositAddRs", "DepositRet"),
+        /**
+         * Modifies an existing deposit.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositMod
+         */
+        mod: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { DepositModRq: { DepositMod: params } }, "DepositModRs", "DepositRet"),
+        /**
+         * This request searches for deposits that match the supplied filters.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/DepositQuery
+         */
+        query: async (integrationUserConnectionId, params) => this.sendRequestBase(integrationUserConnectionId, { DepositQueryRq: params }, "DepositQueryRs", "DepositRet"),
+    };
     employee = {
         /**
          * Adds an employee with personal data about the employee as well as certain

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

@@ -806,6 +806,32 @@ export interface BillRet {
     /** 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 CashBackInfoAdd {
+    /** 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;
+    /** Additional information. */
+    Memo?: string;
+    /** A monetary amount. */
+    Amount?: string;
+}
+export interface CashBackInfoMod {
+    /** 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;
+    /** Additional information. */
+    Memo?: string;
+    /** A monetary amount. */
+    Amount?: string;
+}
+export interface CashBackInfoRet {
+    /** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
+    TxnLineID: string;
+    /** 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;
+    /** Additional information. */
+    Memo?: string;
+    /** A monetary amount. */
+    Amount?: string;
+}
 export declare type CashFlowClassification = "Financing" | "Investing" | "None" | "NotApplicable" | "Operating";
 export interface CheckAdd {
     /** 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` */
@@ -1562,6 +1588,205 @@ export interface DataExtRet {
 }
 export declare type DataExtType = "AMTTYPE" | "DATETIMETYPE" | "INTTYPE" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STR255TYPE" | "STR1024TYPE";
 export declare type DateMacro = "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDate" | "LastCalendarYear" | "LastCalendarYearToDate" | "LastFiscalQuarter" | "LastFiscalQuarterToDate" | "LastFiscalYear" | "LastFiscalYearToDate" | "LastMonth" | "LastMonthToDate" | "LastWeek" | "LastWeekToDate" | "NextCalendarQuarter" | "NextCalendarYear" | "NextFiscalQuarter" | "NextFiscalYear" | "NextFourWeeks" | "NextMonth" | "NextWeek" | "ThisCalendarQuarter" | "ThisCalendarQuarterToDate" | "ThisCalendarYear" | "ThisCalendarYearToDate" | "ThisFiscalQuarter" | "ThisFiscalQuarterToDate" | "ThisFiscalYear" | "ThisFiscalYearToDate" | "ThisMonth" | "ThisMonthToDate" | "ThisWeek" | "ThisWeekToDate" | "Today" | "Yesterday";
+export interface DepositAdd {
+    /** 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 account where these funds will be (or have been) deposited. In a `ReceivePaymentAdd` request, the default is Undeposited Funds if this is not included in the request. In a request, if a `DepositToAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    DepositToAccountRef: DepositToAccountRef;
+    /** Additional information. */
+    Memo?: string;
+    /** This aggregate is included if there is cash back from this deposit. `AccountRef` indicates where the cash back `Amount` is going (for example, into a petty cash account). */
+    CashBackInfoAdd?: CashBackInfoAdd;
+    /** 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;
+    /** Allows for the attachment of a user defined GUID value. */
+    ExternalGUID?: string;
+    /** A list of deposit lines, each representing a deposit into the account referred to by `DepositToAccountRef`. Each deposit line is added as either a received payment (in an `IPaymentLine` object) or as a transfer from one account into another (in an `IDepositInfo` object). */
+    DepositLineAdd?: DepositLineAdd | DepositLineAdd[];
+}
+export interface DepositAddRq {
+    DepositAdd: DepositAdd;
+    /** 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 DepositAddRs {
+    DepositRet?: DepositRet;
+    ErrorRecovery?: ErrorRecovery;
+}
+export interface DepositLineAdd {
+    /** For the `PaymentTxnID`, use either of these two values:A `TxnID` value exactly as it is returned by the `ReceivePaymentToDepositQuery` request, or A `TxnID` value exactly as it is returned in a `ReceivePaymentAdd` response. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
+    PaymentTxnID: string;
+    /** For the `PaymentTxnLineID`, use a `TxnLineID` value exactly as it has been returned by the `ReceivePaymentToDepositQuery` request. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
+    PaymentTxnLineID?: string;
+    /** Depost line memo additional information. */
+    OverrideMemo?: string;
+    /** Deposit line check number. */
+    OverrideCheckNumber?: string;
+    /** Deposit line class reference. */
+    OverrideClassRef?: OverrideClassRef;
+    /** A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a `BillToPayQuery` message, `EntityRef` refers to the vendor name.In `JournalCreditLine` and `JournalDebitLine` messages for A/R accounts, `EntityRef` must refer to a customer, or else the transaction will not be recorded. For A/P accounts the `EntityRef` must refer to a vendor, or else the transaction will not be recorded.In a `TimeTracking` message, `EntityRef` cannot refer to a customer, only to an employee, vendor, or person on the “other names” list whose time is being tracked. */
+    EntityRef?: EntityRef;
+    /** 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;
+    /** Additional information about this deposit line. */
+    Memo?: string;
+    /** The check number of a check that a QuickBooks user writes or receives from someone else. */
+    CheckNumber?: string;
+    /** A customer’s payment method, for example, cash, check, or Master Card. A `PaymentMethodRef` aggregate refers to an item on the `PaymentMethod` list. In a request, if a `PaymentMethodRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a `SalesReceiptAdd`, `ReceivePaymentAdd`, or `ARRefundCreditCard` request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type. */
+    PaymentMethodRef?: PaymentMethodRef;
+    /** 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.) In QuickBooks, class tracking is off by default. A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
+    ClassRef?: ClassRef;
+    /** A monetary amount. */
+    Amount?: string;
+}
+export interface DepositLineMod {
+    /** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
+    TxnLineID: string;
+    /** For the `PaymentTxnID`, use either of these two values:A `TxnID` value exactly as it is returned by the `ReceivePaymentToDepositQuery` request, or A `TxnID` value exactly as it is returned in a `ReceivePaymentAdd` response. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
+    PaymentTxnID: string;
+    /** For the `PaymentTxnLineID`, use a `TxnLineID` value exactly as it has been returned by the `ReceivePaymentToDepositQuery` request. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
+    PaymentTxnLineID?: string;
+    /** Depost line memo additional information. */
+    OverrideMemo?: string;
+    /** Deposit line check number. */
+    OverrideCheckNumber?: string;
+    /** Deposit line class reference. */
+    OverrideClassRef?: OverrideClassRef;
+    /** A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a `BillToPayQuery` message, `EntityRef` refers to the vendor name.In `JournalCreditLine` and `JournalDebitLine` messages for A/R accounts, `EntityRef` must refer to a customer, or else the transaction will not be recorded. For A/P accounts the `EntityRef` must refer to a vendor, or else the transaction will not be recorded.In a `TimeTracking` message, `EntityRef` cannot refer to a customer, only to an employee, vendor, or person on the “other names” list whose time is being tracked. */
+    EntityRef?: EntityRef;
+    /** 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;
+    /** Additional information about this deposit line. */
+    Memo?: string;
+    /** The check number of a check that a QuickBooks user writes or receives from someone else. */
+    CheckNumber?: string;
+    /** A customer’s payment method, for example, cash, check, or Master Card. A `PaymentMethodRef` aggregate refers to an item on the `PaymentMethod` list. In a request, if a `PaymentMethodRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a `SalesReceiptAdd`, `ReceivePaymentAdd`, or `ARRefundCreditCard` request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type. */
+    PaymentMethodRef?: PaymentMethodRef;
+    /** 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.) In QuickBooks, class tracking is off by default. A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
+    ClassRef?: ClassRef;
+    /** A monetary amount. */
+    Amount?: string;
+}
+export interface DepositLineRet {
+    /** The type of transaction. */
+    TxnType?: TxnType;
+    /** 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;
+    /** Identification number of the transaction line. (`TxnLineID` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `TxnLineID` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `TxnLineID` to -1. */
+    TxnLineID: string;
+    /** For the `PaymentTxnLineID`, use a `TxnLineID` value exactly as it has been returned by the `ReceivePaymentToDepositQuery` request. If you do not include a `PaymentTxnLineID` and include a `PaymentTxnID` for a transaction that includes payment lines, only the first payment line from that transaction will be deposited. */
+    PaymentTxnLineID?: string;
+    /** A QuickBooks “entity” is a customer, vendor, employee, or person on the QuickBooks “other names” list. Special cases to note: In a `BillToPayQuery` message, `EntityRef` refers to the vendor name.In `JournalCreditLine` and `JournalDebitLine` messages for A/R accounts, `EntityRef` must refer to a customer, or else the transaction will not be recorded. For A/P accounts the `EntityRef` must refer to a vendor, or else the transaction will not be recorded.In a `TimeTracking` message, `EntityRef` cannot refer to a customer, only to an employee, vendor, or person on the “other names” list whose time is being tracked. */
+    EntityRef?: EntityRef;
+    /** 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;
+    /** Additional information about this deposit line. */
+    Memo?: string;
+    /** The check number of a check that a QuickBooks user writes or receives from someone else. */
+    CheckNumber?: string;
+    /** A customer’s payment method, for example, cash, check, or Master Card. A `PaymentMethodRef` aggregate refers to an item on the `PaymentMethod` list. In a request, if a `PaymentMethodRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In a `SalesReceiptAdd`, `ReceivePaymentAdd`, or `ARRefundCreditCard` request that contains credit card transaction data supplied from QBMS transaction responses, you must specify the payment method, and the payment method must be a credit card type. */
+    PaymentMethodRef?: PaymentMethodRef;
+    /** 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.) In QuickBooks, class tracking is off by default. A `ClassRef` aggregate refers to one of these named classes. For example, in a `TimeTracking` message, `ClassRef` refers to the QuickBooks class into which the timed activity falls. If a `ClassRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. In an `InvoiceAdd` request, if you specify a `ClassRef` for the whole invoice, that same `ClassRef` is automatically used in the line items. If you want to clear that (that is, have NO `ClassRef` for the line item, you can clear it in the line item by simply not specifying it in the line item. */
+    ClassRef?: ClassRef;
+    /** A monetary amount. */
+    Amount?: string;
+}
+export interface DepositMod {
+    /** 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;
+    /** 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;
+    /** 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 account where these funds will be (or have been) deposited. In a `ReceivePaymentAdd` request, the default is Undeposited Funds if this is not included in the request. In a request, if a `DepositToAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    DepositToAccountRef?: DepositToAccountRef;
+    /** Additional information. */
+    Memo?: string;
+    /** This aggregate is included if there is cash back from this deposit. `AccountRef` indicates where the cash back `Amount` is going (for example, into a petty cash account). */
+    CashBackInfoMod?: CashBackInfoMod;
+    /** 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;
+    /** A list of deposit lines, each representing a deposit into the account referred to by `DepositToAccountRef`. Each deposit line is added as either a received payment (in an `IPaymentLine` object) or as a transfer from one account into another (in an `IDepositInfo` object). */
+    DepositLineMod?: DepositLineMod | DepositLineMod[];
+}
+export interface DepositModRq {
+    DepositMod: DepositMod;
+    /** 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 DepositModRs {
+    DepositRet?: DepositRet;
+    ErrorRecovery?: ErrorRecovery;
+}
+export interface DepositQueryRq {
+    /** 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;
+    /** 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 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 DepositQueryRs {
+    DepositRet: [DepositRet, ...DepositRet[]];
+}
+export interface DepositRet {
+    /** 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;
+    /** 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 account where these funds will be (or have been) deposited. In a `ReceivePaymentAdd` request, the default is Undeposited Funds if this is not included in the request. In a request, if a `DepositToAccountRef` aggregate includes both `FullName` and `ListID`, `FullName` will be ignored. */
+    DepositToAccountRef: DepositToAccountRef;
+    /** Additional information. */
+    Memo?: string;
+    /** The sum of all the deposited amounts. */
+    DepositTotal?: 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 of the deposit in units of the home currency. */
+    DepositTotalInHomeCurrency?: string;
+    /** This aggregate is included if there is cash back from this deposit. `AccountRef` indicates where the cash back `Amount` is going (for example, into a petty cash account). */
+    CashBackInfoRet?: CashBackInfoRet;
+    /** Allows for the attachment of a user defined GUID value. */
+    ExternalGUID?: string;
+    /** A list of deposit lines, each representing a deposit into the account referred to by `DepositToAccountRef`. Each deposit line is added as either a received payment (in an `IPaymentLine` object) or as a transfer from one account into another (in an `IDepositInfo` object). */
+    DepositLineRet?: DepositLineRet | DepositLineRet[];
+    /** 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 DepositToAccountRef {
+    /** 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 declare type Disabled = "No" | "Yes";
 export interface DiscountAccountRef {
     /** 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. */
@@ -2820,6 +3045,12 @@ export interface NameRangeFilter {
 }
 export declare type OnFile = "No" | "Yes";
 export declare type Operator = "Equal" | "GreaterThan" | "GreaterThanEqual" | "LessThan" | "LessThanEqual";
+export interface OverrideClassRef {
+    /** 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 OverrideItemAccountRef {
     /** 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;
@@ -2847,6 +3078,12 @@ export interface PayeeEntityRef {
     /** `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 PaymentMethodRef {
+    /** 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 declare type PayPeriod = "Biweekly" | "Daily" | "Monthly" | "Quarterly" | "Semimonthly" | "Weekly" | "Yearly";
 export interface PayrollItemWageRef {
     /** 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. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conductor-node",
-  "version": "3.8.4",
+  "version": "3.8.5",
   "description": "Conductor API wrapper",
   "author": "Danny Nemer <hi@DannyNemer.com>",
   "license": "MIT",