conductor-node 9.5.0 → 9.6.0

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

@@ -348,6 +348,36 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { ChargeQueryRq: params }, "ChargeQueryRs", "ChargeRet"),
     };
+    buildAssembly = {
+        /**
+         * Adds a build assembly transaction to QuickBooks, where the specified
+         * quantity of the specified inventory assembly item is built. If there are
+         * insufficient quantities of items required for the build, you can have the
+         * build marked as a pending build by using setting `MarkPendingIfRequired`
+         * to `True`. (If you don’t and there aren’t enough quantities on hand for
+         * the build, this request will fail.) If successful, this request results
+         * in the decrementing of the quantities on hand amounts of each item used
+         * in the build, and the incrementing of the on hand quantities of the built
+         * assembly item.
+         *
+         * This request is supported only in Premier and Enterprise.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { BuildAssemblyAddRq: { BuildAssemblyAdd: params } }, "BuildAssemblyAddRs", "BuildAssemblyRet"),
+        /**
+         * Modifies an existing build assembly transaction in the QuickBooks company.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { BuildAssemblyModRq: { BuildAssemblyMod: params } }, "BuildAssemblyModRs", "BuildAssemblyRet"),
+        /**
+         * Filters build assembly transactions by the specified filter criteria.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BuildAssemblyQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { BuildAssemblyQueryRq: params }, "BuildAssemblyQueryRs", "BuildAssemblyRet"),
+    };
     check = {
         /**
          * The amount of a check is the total of the amounts assigned to expense
@@ -1216,6 +1246,8 @@ class QbdIntegration extends BaseIntegration_1.default {
         mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { ItemSalesTaxModRq: { ItemSalesTaxMod: params } }, "ItemSalesTaxModRs", "ItemSalesTaxRet"),
         /**
          * Queries for the specified sales-tax item or set of items.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ItemSalesTaxQuery
          */
         query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { ItemSalesTaxQueryRq: params }, "ItemSalesTaxQueryRs", "ItemSalesTaxRet"),
     };
@@ -1349,17 +1381,6 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { ItemSubtotalQueryRq: params }, "ItemSubtotalQueryRs", "ItemSubtotalRet"),
     };
-    jobReport = {
-        /**
-         * Queries for a job report, which includes both summary and transaction
-         * detail reports. The reports can be customized only by date range, by
-         * column summarization, and by common filters. Some job reports require a
-         * `customer:job` reference in order to work.
-         *
-         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JobReportQuery
-         */
-        query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { JobReportQueryRq: params }, "JobReportQueryRs", "ReportRet"),
-    };
     jobType = {
         /**
          * Adds a job type. A job type can be used to separate jobs into any
@@ -1523,6 +1544,299 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { PurchaseOrderQueryRq: params }, "PurchaseOrderQueryRs", "PurchaseOrderRet"),
     };
+    receivePayment = {
+        /**
+         * Receives a customer payment into QuickBooks. A receive payment
+         * transaction is used for one or more of these purposes:
+         * 1. To record a customer’s payment against an invoice for one or more
+         *    jobs,
+         * 2. To set a discount (for early payment, for example),
+         * 3. To set a credit (from previously returned merchandise, for example).
+         *
+         * If full payment is received at the time of sale, it is recorded using a
+         * sales receipt transaction, not a receive payments transaction.
+         *
+         * Notice that access to sensitive data permissions are not required to use
+         * this request. However, if the application does not have access to
+         * sensitive data permission, then the response returned will not contain
+         * certain sensitive data. For example, even if credit card data is supplied
+         * in the `ReceivePaymentAdd` request via the `CreditCardTxnInfo` aggregate,
+         * the response will not contain the corresponding aggregate.
+         *
+         * This request can be used to record QBMS credit card transaction data, via
+         * the `CreditCardTxnInfo` aggregate. You can record charges and also
+         * authorizations. (You can later respond to a QBMS capture of authorized
+         * charges by doing a `ReceivePaymentMod` and changing the
+         * `CreditCardTxnType` to “Charge”.) Notice that the reconciliation data
+         * fields (`ReconBatchID`, `PaymentGroupingCode`, `PaymentStatus`,
+         * `TxnAuthorizationTime`, `TxnAuthorizationStamp`, `ClientTransID`) are
+         * optional ONLY if the `CreditCardTxnType` is “Authorization”. If the type
+         * is “Charge”, then those reconciliation fields must be supplied or you
+         * will get a runtime error.
+         *
+         * IMPORTANT: In a `SalesReceiptAdd` or `ReceivePaymentAdd` request that
+         * contains credit card transaction data supplied from QBMS transaction
+         * responses, you must specify the payment method (using the
+         * `PaymentMethodRef` aggregate).
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ReceivePaymentAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { ReceivePaymentAddRq: { ReceivePaymentAdd: params } }, "ReceivePaymentAddRs", "ReceivePaymentRet"),
+        /**
+         * Modifies a receive payment transaction.
+         *
+         * If you save QBMS credit card data in your `ReceivePayments`, this Mod
+         * request allows you to capture a previously authorized credit card charge.
+         * The way this works is that the ReceivePaymentAdd would contain the QBMS
+         * `CreditCardTxnInfo` aggregate with the `CreditCardTxnType` set to
+         * “Authorization,” which causes QB to internally mark the transaction as
+         * pending. When the capture transaction is performed later, in QBMS, that
+         * capture transaction can be saved into QuickBooks via this Mod request, as
+         * you are modifying the original `ReceivePayment` but changing its
+         * `CreditCardTxnType` from ”Authorization” to “Capture.” This mod operation
+         * results in the removal of the pending status and the posting of this
+         * receive payment.
+         *
+         * Notice that the reconciliation data fields (`ReconBatchID`,
+         * `PaymentGroupingCode`, `PaymentStatus`, `TxnAuthorizationTime`,
+         * `TxnAuthorizationStamp`, `ClientTransID`) are optional ONLY if the
+         * `CreditCardTxnType` is “Authorization” because authorizations don’t have
+         * such data. If the type is “Charge”, then those reconciliation fields must
+         * be supplied or you will get a runtime error.
+         *
+         * The following list describes what you can and can’t do with this request.
+         * - Modify `RefNumber` or `Memo`.
+         * - Modify (not clear) the `CustomerRef` field for a payment that was not
+         *   electronically processed.
+         * - Modify (not clear) the `ARAccountRef`.
+         * - Modify (not clear) the `TxnDate`.
+         * - Modify or clear the `TotalAmount`.
+         * - Modify or clear the `PaymentMethodRef`.
+         * - Modify, (not clear) the `DepositToAccountRef`
+         * - Change the payment amount applied to an invoice. For a receive payment
+         *   transaction that has been applied to several existing invoices,
+         *   redistribute the payment amounts applied to the invoices.
+         * - Change the discount amount applied to particular invoice.
+         * - You cannot change the credit amount applied to an invoice.
+         * - Apply the payment to a different invoice, including a discount and a
+         *   credit. Apply the payment amount to a different invoice. Apply a
+         *   discount, and a credit. The existing distribution is cleared, except
+         *   for any credit that may have been applied.
+         * - Modify QBMS credit card information.
+         * - You cannot auto apply payment.
+         * - Apply an additional credit to an invoice.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ReceivePaymentMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { ReceivePaymentModRq: { ReceivePaymentMod: params } }, "ReceivePaymentModRs", "ReceivePaymentRet"),
+        /**
+         * Queries for the specified receive payment or set of payments.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/ReceivePaymentQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { ReceivePaymentQueryRq: params }, "ReceivePaymentQueryRs", "ReceivePaymentRet"),
+    };
+    report = {
+        /**
+         * Generates budget reports similar to the budget report functionality that
+         * is available within the QuickBooks UI. (From the main QB menubar select
+         * Reports->Budgets & Forecasts.)
+         *
+         * Note: the graphing functionality, forecasts, and memorized reports that
+         * are available through the UI are not supported by the SDK.
+         *
+         * Notice that if you simply use the default instead of specifying the
+         * Fiscal Year, the `ReportPeriod` defaults to “year to date.” You cannot
+         * change the default to “This Fiscal Year.”
+         *
+         * There can only be one balance sheet budget for each fiscal year, one
+         * profit and loss (P&L) by account budget per fiscal year, and one profit
+         * and loss (P&L) by account and customer budget per fiscal year. Hence the
+         * `FiscalYear` element is key in specifying which budget you want. Notice
+         * that there are two “views” into each of the two budget categories: the
+         * Overview, which shows the budget itself, and the Actual, which shows how
+         * expenditures are currently running against the budget.
+         *
+         * All of the budget reports supported in the UI are supported in the SDK,
+         * although the UI and SDK nomenclature differs slightly. The UI shows
+         * Budget Overview and Budget Vs Actual as choices in the selection list,
+         * with Balance Sheet and P&L as subchoices in a subsequent selection list,
+         * already filtered by Accounts, or Accounts and Classes, or Accounts and
+         * Customers, if these are available.
+         *
+         * In comparison, you choose the budget view you want via the SDK
+         * `BudgetSummaryType` element, which has these possible values:
+         * - `BalanceSheetBudgetOverview`
+         * - `BalanceSheetBudgetVsActual`
+         * - `ProfitAndLossBudgetOverview`
+         * - `ProfitAndLossBudgetVsActual`
+         *
+         * Then you specify any additional filtering by the Budget Criterion value
+         * you specify (`Accounts`, `AccountsAndCustomers`, or
+         * `AccountsAndClasses`). Notice that before you can obtain a Budget report,
+         * the “target” budget must be defined in QuickBooks, via the UI, because
+         * you cannot create a budget via the SDK.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/BudgetSummaryReportQuery
+         */
+        budgetSummary: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { BudgetSummaryReportQueryRq: params }, "BudgetSummaryReportQueryRs", "ReportRet"),
+        /**
+         * A Custom Transaction Detail report gives you complete control over the
+         * content of the report. It does not have any default values and consists
+         * entirely of customized data. You must specify all the include columns for
+         * the transactions you want returned in the report.
+         *
+         * If you want complete control over the report content, you will be
+         * interested in both the custom summary report and the custom transaction
+         * detail report. Custom reports do not make any assumptions about the data
+         * you are interested in–they require you to specify exactly what data you
+         * want included in the report. Your application has to select the row and
+         * column axes, and it controls the output using common customization
+         * parameters for dates and filters. For the custom transaction detail
+         * report, you must specify all the include columns for the transactions you
+         * want returned in the report. For these reports, you are also required to
+         * specify a date element a `DateMacro` or a custom date range).
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomDetailReportQuery
+         */
+        customDetail: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { CustomDetailReportQueryRq: params }, "CustomDetailReportQueryRs", "ReportRet"),
+        /**
+         * A custom summary report gives you complete control over the content of
+         * the report. It does not have any default values and consists entirely of
+         * customized data.
+         *
+         * If you want complete control over the report content, you will be
+         * interested in both the custom summary report and the custom transaction
+         * detail report. Custom reports do not make any assumptions about the data
+         * you are interested in–they require you to specify exactly what data you
+         * want included in the report. Your application has to select the row and
+         * column axes, and it controls the output using common customization
+         * parameters for dates and filters. For the custom transaction detail
+         * report, you must specify all the include columns for the transactions you
+         * want returned in the report. For these reports, you are also required to
+         * specify a date element a ``DateMacro`` or a custom date range).
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/CustomSummaryReportQuery
+         */
+        customSummary: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { CustomSummaryReportQueryRq: params }, "CustomSummaryReportQueryRs", "ReportRet"),
+        /**
+         * You use this report query to get any of the supported QuickBooks detail
+         * reports, which you specify in the `GeneralDetailReportType`. You can
+         * optionally display the report within QB by setting `DisplayReport` to
+         * True.
+         *
+         * You can also use this detail report to get information not obtainable
+         * from various SDK queries. For example, suppose you wanted the cleared
+         * status from a `BillPaymentCheck`; the `BillPaymentCheckQuery` wouldn’t
+         * have this info, but you could use this general detail report and specify
+         * the column `ClearedStatus` to find that information.
+         *
+         * Also, if you wanted to query the accounts receivable directly, you could
+         * do a General Detail Report Query with the report type set to Open
+         * Invoices.
+         *
+         * You could also use this report if you needed to run a report on all
+         * invoice changes made in a specific day, and only include changes to
+         * invoices from a given past month, if the audit trail is on in QuickBooks.
+         * You would use a `GeneralDetailReport` query with the report type set to
+         * `AuditTrail`.
+         *
+         * Notice that if a line is paid, `PaidStatus == “X”`. If a line is not
+         * paid, no entry for `PaidStatus` is returned.
+         *
+         * However, in the same report run within the QB GUI, the following behavior
+         * is observed: This differs from the UI, where if the line is paid, an
+         * entry of “Paid” is displayed and if the line is not paid, an entry of
+         * “Unpaid” is displayed.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/GeneralDetailReportQuery
+         */
+        generalDetail: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { GeneralDetailReportQueryRq: params }, "GeneralDetailReportQueryRs", "ReportRet"),
+        /**
+         * The General Summary Reports category is the largest category for summary
+         * reports. In addition to common customizations, the reports within this
+         * category can be customized by the number of columns that are returned and
+         * by period comparisons for the data in the report.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/GeneralSummaryReportQuery
+         */
+        generalSummary: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { GeneralSummaryReportQueryRq: params }, "GeneralSummaryReportQueryRs", "ReportRet"),
+        /**
+         * Queries for a job report, which includes both summary and transaction
+         * detail reports. The reports can be customized only by date range, by
+         * column summarization, and by common filters. Some job reports require a
+         * `customer:job` reference in order to work.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/JobReportQuery
+         */
+        job: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { JobReportQueryRq: params }, "JobReportQueryRs", "ReportRet"),
+        /**
+         * This report returns information from any of three QuickBooks payroll
+         * reports:
+         * - Payroll summary report This report shows the total wages, taxes
+         *   withheld, deductions from net pay, additions to net pay, and
+         *   employer-paid taxes and contributions for each employee on the payroll.
+         * - Employee earnings summary report This report shows information similar
+         *   to the payroll summary report, but in a different layout. The report
+         *   has a row for each employee and a column for each payroll item.
+         * - Payroll liability balances report This report lists the payroll
+         *   liabilities the QuickBooks company owes to various agencies, such as
+         *   the federal government, your state government, insurance plan
+         *   administrators, labor unions, etc. The report covers unpaid liabilities
+         *   incurred during the period of time shown in the From and To fields. If
+         *   the company paid a liability incurred within the date range of the
+         *   report, the report omits that liability, even if the payment occurred
+         *   after the ending date of the report.
+         *
+         * Payroll Summary Reports can be generated if your application is accessing
+         * a company file that is currently signed up for a subscription to a
+         * payroll service. (If your application is not signed up, it will receive
+         * an error when it attempts to generate a report in this category.)
+         *
+         * The restrictions noted above about payroll reports requiring the use of
+         * the Intuit Payroll service do not apply to the QuickBooks sample
+         * companies. You can still test out these reports on the sample companies
+         * without subscribing to the payroll service. For all other companies,
+         * however, the company must be subscribed.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollSummaryReportQuery
+         */
+        payrollSummary: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { PayrollSummaryReportQueryRq: params }, "PayrollSummaryReportQueryRs", "ReportRet"),
+        /**
+         * Returns information from any of five QuickBooks payroll reports:
+         * - Employee state taxes detail report
+         * - Payroll item detail report (lists the payroll transactions on which
+         *   each payroll item appears)
+         * - Payroll detail review report (provides detailed information about how
+         *   QuickBooks calculates tax amounts on employee paychecks and in
+         *   year-to-date transactions)
+         * - Payroll transaction detail report (shows the line-item detail that
+         *   appears on each payroll transaction)
+         * - Payroll transactions by payee report (lists payroll transactions,
+         *   grouping them by payee)
+         *
+         * Payroll Summary Reports can be generated if your application is accessing
+         * a company file that is currently signed up for a subscription to a
+         * payroll service. (If your application is not signed up, it will receive
+         * an error when it attempts to generate a report in this category.)
+         *
+         * The restrictions noted above about payroll reports requiring the use of
+         * the Intuit Payroll service do not apply to the QuickBooks sample
+         * companies. You can still test out these reports on the sample companies
+         * without subscribing to the payroll service. For all other companies,
+         * however, the company must be subscribed.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/PayrollDetailReportQuery
+         */
+        payrollDetail: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { PayrollDetailReportQueryRq: params }, "PayrollDetailReportQueryRs", "ReportRet"),
+        /**
+         * The Time Reports category includes summary and detail reports related by
+         * time. Summarized columns can be customized in these reports.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeReportQuery
+         */
+        time: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TimeReportQueryRq: params }, "TimeReportQueryRs", "ReportRet"),
+    };
     salesReceipt = {
         /**
          * Adds a sales receipt to QuickBooks.
@@ -1644,6 +1958,47 @@ class QbdIntegration extends BaseIntegration_1.default {
          */
         query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TimeTrackingQueryRq: params }, "TimeTrackingQueryRs", "TimeTrackingRet"),
     };
+    transfer = {
+        /**
+         * Adds a transfer transaction.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TransferAddRq: { TransferAdd: params } }, "TransferAddRs", "TransferRet"),
+        /**
+         * Modifies a transfer transaction.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TransferModRq: { TransferMod: params } }, "TransferModRs", "TransferRet"),
+        /**
+         * Queries for the specified transfer or set of transfers.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TransferQueryRq: params }, "TransferQueryRs", "TransferRet"),
+    };
+    transferInventory = {
+        /**
+         * Adds a transfer inventory transaction.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferInventoryAdd
+         */
+        add: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TransferInventoryAddRq: { TransferInventoryAdd: params } }, "TransferInventoryAddRs", "TransferInventoryRet"),
+        /**
+         * Modifies a transfer inventory transaction.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferInventoryMod
+         */
+        mod: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TransferInventoryModRq: { TransferInventoryMod: params } }, "TransferInventoryModRs", "TransferInventoryRet"),
+        /**
+         * Queries for the specified transfer inventory transaction or set of
+         * transfer inventory transactions.
+         *
+         * https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TransferInventoryQuery
+         */
+        query: async (integrationConnectionId, params) => this.sendRequestWrapper(integrationConnectionId, { TransferInventoryQueryRq: params }, "TransferInventoryQueryRs", "TransferInventoryRet"),
+    };
     vendor = {
         /**
          * Adds a vendor.