conductor-node 11.6.3 → 11.6.5

package/dist/package.json

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

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

@@ -2117,6 +2117,16 @@ export default class QbdIntegration extends BaseIntegration {
      * needs.
      */
     report: {
+        /**
+         * Generates an aging report, which tracks outstanding invoices (in accounts
+         * receivable accounts) and unpaid bills (in accounts payable accounts).
+         *
+         * Note that you could use a collections report instead of the aging query,
+         * if that better suited your needs.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AgingReportQuery
+         */
+        aging: (endUserId: string, params: QbdTypes.AgingReportQueryRq) => Promise<NonNullable<QbdTypes.AgingReportQueryRs["ReportRet"]>>;
         /**
          * Generates budget reports similar to the budget report functionality that
          * is available within the QuickBooks UI. (From the main QB menubar select

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

@@ -2122,6 +2122,16 @@ class QbdIntegration extends BaseIntegration_1.default {
      * needs.
      */
     report = {
+        /**
+         * Generates an aging report, which tracks outstanding invoices (in accounts
+         * receivable accounts) and unpaid bills (in accounts payable accounts).
+         *
+         * Note that you could use a collections report instead of the aging query,
+         * if that better suited your needs.
+         *
+         * See more: https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/AgingReportQuery
+         */
+        aging: async (endUserId, params) => this.sendRequestWrapper(endUserId, { AgingReportQueryRq: params }, "AgingReportQueryRs", "ReportRet"),
         /**
          * Generates budget reports similar to the budget report functionality that
          * is available within the QuickBooks UI. (From the main QB menubar select

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

@@ -297,6 +297,44 @@ export interface AddressBlock {
 }
 export type AdjustBillingRateRelativeTo = "CurrentCustomRate" | "StandardRate";
 export type AdjustRelativeTo = "Cost" | "CurrentCustomPrice" | "StandardPrice";
+export interface AgingReportQueryRq {
+    /** The type of aging report being queried. */
+    AgingReportType: AgingReportType;
+    /** Set `DisplayReport` to true to display this report within the QuickBooks UI. (Default is false.) If you want the request to display the report without returning any data to your application, set the `responseData` attribute to `includeNone`. */
+    DisplayReport?: boolean;
+    /** If you omit both `ToReportDate` and `FromReportDate`, the report will cover the current fiscal year to date. */
+    ReportPeriod?: ReportPeriod;
+    /** The time period covered by this report. */
+    ReportDateMacro?: ReportDateMacro;
+    /** Allows you to query for a specified account type or for specific list elements. */
+    ReportAccountFilter?: ReportAccountFilter;
+    /** Allows you to query for a specified name type (customer, employee, vendor, or other) or query for specific list elements. */
+    ReportEntityFilter?: ReportEntityFilter;
+    /** Allows you to query for a specified item type (for example, discount, inventory, or non-inventory) or query for specific list elements. */
+    ReportItemFilter?: ReportItemFilter;
+    /** Allows you to query for a specified class. 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. */
+    ReportClassFilter?: ReportClassFilter;
+    /** Allows you to report on specific transaction types (for example, charge, check, deposit, or estimate). */
+    ReportTxnTypeFilter?: ReportTxnTypeFilter;
+    /** Returns reports that were modified between these two dates (inclusive). The range of acceptable dates for both `FromReportModifiedDate` and `ToReportModifiedDate` is 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). */
+    ReportModifiedDateRangeFilter?: ReportModifiedDateRangeFilter;
+    /** The time period covered by this report. */
+    ReportModifiedDateRangeMacro?: ReportModifiedDateRangeMacro;
+    /** The level of detail to include in the report. */
+    ReportDetailLevelFilter?: ReportDetailLevelFilter;
+    /** Allows you to query for posting reports, non-posting reports, or reports that are either one. */
+    ReportPostingStatusFilter?: ReportPostingStatusFilter;
+    /** A list of enum values showing which columns you want the report to return. (The report won’t return columns other than the ones you specify here.) */
+    IncludeColumn?: IncludeColumn | IncludeColumn[];
+    /** Indicates whether this report should include all accounts or just those that are currently in use. */
+    IncludeAccounts?: IncludeAccounts;
+    /** The report will return aging information up to the `ReportAgingAsOf` date. */
+    ReportAgingAsOf?: ReportAgingAsOf;
+}
+export interface AgingReportQueryRs {
+    ReportRet: ReportRet[];
+}
+export type AgingReportType = "APAgingDetail" | "APAgingSummary" | "ARAgingDetail" | "ARAgingSummary" | "CollectionsReport";
 export interface APAccountRef {
     /** 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;
@@ -1698,7 +1736,7 @@ export interface ColData {
     /** The data in this cell of the report. */
     Value: string;
     /** The data type: IDTYPE, STRTYPE, and so on. */
-    DataType: DataType;
+    DataType?: DataType;
 }
 export interface ColDesc {
     /** A list of `IColTitle` objects, each of which represents a title for this column. For example, if the first two rows of this column were titles, two `IColTitle` objects would be returned. */
@@ -1708,7 +1746,7 @@ export interface ColDesc {
     /** An identifying number that corresponds to the position of this column in the report. The columns are numbered from left to right, starting with 1. */
     ColID: number;
     /** The data type: IDTYPE, STRTYPE, and so on. */
-    DataType: DataType;
+    DataType?: DataType;
 }
 export interface ColTitle {
     /** The number of this title row. For example, if the first three rows of a report were titles, `titleRow` of the third of these rows would be 3. */
@@ -3628,6 +3666,8 @@ export interface DataRow {
     RowData?: RowData;
     /** A list of `IColData` objects, each of which describes the data in one cell of the report. */
     ColData?: ColData | ColData[];
+    /** The row number. Rows are numbered from top to bottom, starting with 1. */
+    RowNumber: number;
 }
 export type DataType = "AMTTYPE" | "BOOLTYPE" | "DATETIMETYPE" | "DATETYPE" | "ENUMTYPE" | "GUIDTYPE" | "IDTYPE" | "INTTYPE" | "PERCENTTYPE" | "PRICETYPE" | "QUANTYPE" | "STRTYPE" | "TIMEINTERVALTYPE";
 export interface DateDrivenTermsAdd {
@@ -10120,6 +10160,8 @@ export interface ReportAccountFilter {
     /** Allows you to filter for data that relates to the specified object and its descendants. For names that do not have children, `FullNameWithChildren` is exactly the same as `FullName`. */
     FullNameWithChildren?: string;
 }
+/** @default: ReportEndDate */
+export type ReportAgingAsOf = "ReportEndDate" | "Today";
 /** @default: None */
 export type ReportBasis = "Accrual" | "Cash" | "None";
 export type ReportCalendar = "CalendarYear" | "FiscalYear" | "TaxYear";
@@ -10140,8 +10182,10 @@ export interface ReportData {
     TextRow?: TextRow | TextRow[];
     /** A row that contains a calculated subtotal of the data in all the rows since the last `SubTotalRow` and, usually, a single underline. There can be multiple `SubTotalRow` aggregates in a report. */
     SubtotalRow?: SubtotalRow | SubtotalRow[];
-    /** A row that contains a calculated total of all the data that has come before and a double underline. There will only be one `TotalRow` per report. If `TotalRow` does not include any numerical values, the columns required to show the total values are not part of the report. These columns were not included when the report was customized. */
-    TotalRow?: TotalRow;
+    /** A row that contains a calculated total of all the data that has come before and a double underline. There will only be one `TotalRow` per report.
+  
+    If `TotalRow` does not include any numerical values, the columns required to show the total values are not part of the report. These columns were not included when the report was customized. */
+    TotalRow?: TotalRow | TotalRow[];
 }
 export type ReportDateMacro = "All" | "LastMonth" | "LastMonthToDate" | "LastQuarter" | "LastQuarterToDate" | "LastWeek" | "LastWeekToDate" | "LastYear" | "LastYearToDate" | "NextFourWeeks" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisMonthToDate" | "ThisQuarter" | "ThisQuarterToDate" | "ThisWeek" | "ThisWeekToDate" | "ThisYear" | "ThisYearToDate" | "Today" | "Yesterday";
 /** @default: All */
@@ -10163,7 +10207,9 @@ export type ReportingPeriod = "Monthly" | "Quarterly";
 export interface ReportItemFilter {
     /** Allows you to report on a specific item type. */
     ItemTypeFilter?: ItemTypeFilter;
-    /** One or more `ListID` values. 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. */
+    /** One or more `ListID` values. 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[] | string;
     /** A list of one or more `FullName` values. `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[] | string;
@@ -10182,7 +10228,9 @@ export type ReportModifiedDateRangeMacro = "All" | "LastMonth" | "LastMonthToDat
 /** @default: Today */
 export type ReportOpenBalanceAsOf = "ReportEndDate" | "Today";
 export interface ReportPeriod {
-    /** Selects information from this date and later. The range of acceptable `FromReportDate` and `ToReportDate` values depends on how the report dates are determined. If the report dates are based on the dates of transactions, the range is 01/01/1901 to 12/31/9999. If the report dates are based on modification dates, the range will be 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). If you omit `FromReportDate`, it will be set to 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST). */
+    /** Selects information from this date and later. The range of acceptable `FromReportDate` and `ToReportDate` values depends on how the report dates are determined. If the report dates are based on the dates of transactions, the range is 01/01/1901 to 12/31/9999. If the report dates are based on modification dates, the range will be 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
+  
+    If you omit `FromReportDate`, it will be set to 1970-01-01T00:00:00 (1969-12-31T16:00:00-08:00 PST). */
     FromReportDate?: string;
     /** Selects information created on this date or earlier. The range of acceptable `ToReportDate` and `FromReportDate` values depends on how the report dates are determined. If the report dates are based on the dates of transactions, the range is 01/01/1901 to 12/31/9999. If the report dates are based on modification dates, the range will be 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). If you omit `ToReportDate`, it will be set to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). */
     ToReportDate?: string;
@@ -10193,7 +10241,9 @@ export interface ReportRet {
     ReportTitle: string;
     /** The subtitle for this report. */
     ReportSubtitle: string;
-    /** If `ReportBasis` is `rbCash`, the report bases income and expenses on the dates when money changed hands.`rbAccrual`, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered.`rbNone`, the report uses the default `ReportBasis`, which is either the QuickBooks Preference setting or the QuickBooks default for a given type of report. In a report response, the SDK returns `rbNone` for reports that do not support `ReportBasis`. (The 1099 report, for example, has its own basis for generation.) */
+    /** If `ReportBasis` is
+  
+    `rbCash`, the report bases income and expenses on the dates when money changed hands. `rbAccrual`, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered. `rbNone`, the report uses the default `ReportBasis`, which is either the QuickBooks Preference setting or the QuickBooks default for a given type of report. In a report response, the SDK returns `rbNone` for reports that do not support `ReportBasis`. (The 1099 report, for example, has its own basis for generation.) */
     ReportBasis?: ReportBasis;
     /** The number of rows in the report. */
     NumRows: number;
@@ -10213,7 +10263,55 @@ export interface ReportTxnTypeFilter {
 export type ReturnColumns = "ActiveOnly" | "All" | "NonZero";
 export type ReturnRows = "ActiveOnly" | "All" | "NonZero";
 export interface RowData {
-    /** An enumerated value that shows the type of data that this row contains. Values: account class customer `customerMessage` `customerType` employee item `jobType` label `memorizedTxn` `memorizedReport` name `otherName` `paymentMethod` `payrollItem` `salesRep` `salesTaxCode` `shipMethod` state style terms `toDo` vendor `vendorType` */
+    /** An enumerated value that shows the type of data that this row contains. Values:
+  
+    account
+  
+    class
+  
+    customer
+  
+    `customerMessage`
+  
+    `customerType`
+  
+    employee
+  
+    item
+  
+    `jobType`
+  
+    label
+  
+    `memorizedTxn`
+  
+    `memorizedReport`
+  
+    name
+  
+    `otherName`
+  
+    `paymentMethod`
+  
+    `payrollItem`
+  
+    `salesRep`
+  
+    `salesTaxCode`
+  
+    `shipMethod`
+  
+    state
+  
+    style
+  
+    terms
+  
+    `toDo`
+  
+    vendor
+  
+    `vendorType` */
     RowType: RowType;
     /** The data in this cell of the report. */
     Value: string;
@@ -11800,6 +11898,7 @@ export interface SubtotalRow {
     RowData?: RowData;
     /** A list of `IColData` objects, each of which describes the data in one cell of the report. */
     ColData?: ColData | ColData[];
+    RowNumber: number;
 }
 export type SummarizeBudgetColumnsBy = "Class" | "Customer" | "Date";
 export type SummarizeBudgetRowsBy = "Account" | "Class" | "Customer";
@@ -11849,7 +11948,6 @@ export interface TermsRef {
     FullName?: string;
 }
 export interface TextRow {
-    /** The row number. Rows are numbered from top to bottom, starting with 1. */
     RowNumber: number;
     /** The data in this cell of the report. */
     Value: string;
@@ -12038,6 +12136,7 @@ export interface TotalRow {
     RowData?: RowData;
     /** A list of `IColData` objects, each of which describes the data in one cell of the report. */
     ColData?: ColData | ColData[];
+    RowNumber: number;
 }
 export interface TransactionAccountFilter {
     /** Allows you to report on a specific account type. */
@@ -12373,7 +12472,7 @@ export interface TransferInventoryLineRet {
     /** The lot number of the asset. */
     LotNumber?: string;
     /** The expiration date of the inventory serial/lot number. Expiration `Date` is supported from QB Desktop 2023 version 3 (USA & Canada) and SDK 16.0. */
-    ExpirationDateForSerialLotNumber: string;
+    ExpirationDateForSerialLotNumber?: string;
 }
 export interface TransferInventoryMod {
     /** 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. */

package/package.json

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