conductor-node 14.13.0 → 14.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,7 +3,10 @@ import { APIPromise } from "../../core/api-promise.js";
3
3
  import { RequestOptions } from "../../internal/request-options.js";
4
4
  export declare class Reports extends APIResource {
5
5
  /**
6
- * Retrieves an aging report.
6
+ * Retrieves an accounts receivable, accounts payable, or collections aging report
7
+ * showing unpaid invoices and bills by aging criteria. This report is useful for
8
+ * analyzing receivables, payables, and collection work across summary or detail
9
+ * aging views.
7
10
  *
8
11
  * @example
9
12
  * ```ts
@@ -15,7 +18,11 @@ export declare class Reports extends APIResource {
15
18
  */
16
19
  aging(params: ReportAgingParams, options?: RequestOptions): APIPromise<Report>;
17
20
  /**
18
- * Retrieves a budget summary report.
21
+ * Retrieves a QuickBooks Desktop budget summary report for Balance Sheet or Profit
22
+ * and Loss budgets, including budget overview, budget versus actual, and
23
+ * performance views. This report compares budgeted amounts against actual activity
24
+ * for a fiscal year and budget criterion; the target budget must already exist in
25
+ * QuickBooks Desktop.
19
26
  *
20
27
  * @example
21
28
  * ```ts
@@ -28,7 +35,10 @@ export declare class Reports extends APIResource {
28
35
  */
29
36
  budgetSummary(params: ReportBudgetSummaryParams, options?: RequestOptions): APIPromise<Report>;
30
37
  /**
31
- * Retrieves a custom detail report.
38
+ * Retrieves a custom transaction detail report built from the row grouping,
39
+ * included columns, date period, and filters you request. This report is useful
40
+ * when no preset detail report exposes the transaction rows or report-only columns
41
+ * you need; QuickBooks Desktop does not choose default columns for this report.
32
42
  *
33
43
  * @example
34
44
  * ```ts
@@ -41,7 +51,10 @@ export declare class Reports extends APIResource {
41
51
  */
42
52
  customDetail(params: ReportCustomDetailParams, options?: RequestOptions): APIPromise<Report>;
43
53
  /**
44
- * Retrieves a custom summary report.
54
+ * Retrieves a custom summary report built from the row and column axes, filters,
55
+ * date period, calendar, and basis options you request. This report is useful when
56
+ * preset summary reports do not match the dimensions you need; QuickBooks Desktop
57
+ * does not assume a default layout.
45
58
  *
46
59
  * @example
47
60
  * ```ts
@@ -54,7 +67,12 @@ export declare class Reports extends APIResource {
54
67
  */
55
68
  customSummary(params: ReportCustomSummaryParams, options?: RequestOptions): APIPromise<Report>;
56
69
  /**
57
- * Retrieves a general detail report.
70
+ * Retrieves a QuickBooks Desktop general detail report with transaction-level
71
+ * rows, such as General Ledger, Journal, Open Invoices, unpaid bills, sales
72
+ * detail, purchase detail, audit trail, and transaction lists. This report is
73
+ * useful for inspecting the transactions behind balances, receivables, payables,
74
+ * sales, purchases, inventory valuation, and audit activity, including report-only
75
+ * columns that may not be available from standard object queries.
58
76
  *
59
77
  * @example
60
78
  * ```ts
@@ -66,7 +84,11 @@ export declare class Reports extends APIResource {
66
84
  */
67
85
  generalDetail(params: ReportGeneralDetailParams, options?: RequestOptions): APIPromise<Report>;
68
86
  /**
69
- * Retrieves a general summary report.
87
+ * Retrieves a QuickBooks Desktop general summary report, such as a balance sheet,
88
+ * profit and loss, trial balance, sales, purchase, inventory, customer balance,
89
+ * vendor balance, sales tax, or income tax summary. This report is useful for
90
+ * aggregated financial or operational totals with optional date periods, filters,
91
+ * calendar settings, and column summarization.
70
92
  *
71
93
  * @example
72
94
  * ```ts
@@ -78,7 +100,11 @@ export declare class Reports extends APIResource {
78
100
  */
79
101
  generalSummary(params: ReportGeneralSummaryParams, options?: RequestOptions): APIPromise<Report>;
80
102
  /**
81
- * Retrieves a job report.
103
+ * Retrieves a QuickBooks Desktop job report for estimates versus actuals, item
104
+ * profitability, or job profitability. This report is useful for project costing,
105
+ * margin analysis, and estimate tracking by customer or job; job profitability
106
+ * detail and estimates-versus-actuals detail report types require a customer or
107
+ * job filter.
82
108
  *
83
109
  * @example
84
110
  * ```ts
@@ -90,7 +116,11 @@ export declare class Reports extends APIResource {
90
116
  */
91
117
  job(params: ReportJobParams, options?: RequestOptions): APIPromise<Report>;
92
118
  /**
93
- * Retrieves a payroll detail report.
119
+ * Retrieves a QuickBooks Desktop payroll detail report, including employee state
120
+ * tax detail, payroll item detail, payroll review detail, payroll transaction
121
+ * detail, and payroll transactions by payee. This report is useful for auditing
122
+ * paycheck line items, payroll item usage, tax calculations, and payee-level
123
+ * payroll activity.
94
124
  *
95
125
  * @example
96
126
  * ```ts
@@ -102,7 +132,10 @@ export declare class Reports extends APIResource {
102
132
  */
103
133
  payrollDetail(params: ReportPayrollDetailParams, options?: RequestOptions): APIPromise<Report>;
104
134
  /**
105
- * Retrieves a payroll summary report.
135
+ * Retrieves a QuickBooks Desktop payroll summary report, including payroll totals
136
+ * by employee, employee earnings by payroll item, and payroll liability balances.
137
+ * This report is useful for wage, tax, deduction, addition, employer contribution,
138
+ * and unpaid payroll liability reporting.
106
139
  *
107
140
  * @example
108
141
  * ```ts
@@ -114,7 +147,9 @@ export declare class Reports extends APIResource {
114
147
  */
115
148
  payrollSummary(params: ReportPayrollSummaryParams, options?: RequestOptions): APIPromise<Report>;
116
149
  /**
117
- * Retrieves a time report.
150
+ * Retrieves a QuickBooks Desktop time report by item, job, or name, with summary
151
+ * or detail rows depending on the selected report type. This report is useful for
152
+ * analyzing tracked time for billing, costing, staffing, or project review.
118
153
  *
119
154
  * @example
120
155
  * ```ts
@@ -406,17 +441,17 @@ export interface ReportAgingParams {
406
441
  */
407
442
  conductorEndUserId: string;
408
443
  /**
409
- * Query param: Filter for report data by account `fullName` values,
410
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
411
- * joining parent object names with the object's `name` using colons. Repeat this
412
- * query parameter to include multiple accounts. Use only one account filter per
413
- * request.
444
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
445
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
446
+ * object names with the object's `name` using colons. Accepts one or more account
447
+ * full names. Choose only one account filter per request: `accountType`,
448
+ * `accountIds`, or `accountFullNames`.
414
449
  */
415
450
  accountFullNames?: Array<string>;
416
451
  /**
417
- * Query param: Filter for report data by QuickBooks-assigned account IDs. Repeat
418
- * this query parameter to include multiple accounts. Use only one account filter
419
- * per request.
452
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
453
+ * or more account IDs. Choose only one account filter per request: `accountType`,
454
+ * `accountIds`, or `accountFullNames`.
420
455
  */
421
456
  accountIds?: Array<string>;
422
457
  /**
@@ -424,8 +459,8 @@ export interface ReportAgingParams {
424
459
  */
425
460
  accountsToInclude?: 'all' | 'in_use';
426
461
  /**
427
- * Query param: Filter for report data by account type. Use only one account filter
428
- * per request.
462
+ * Query param: Filter report rows by account type. Choose only one account filter
463
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
429
464
  */
430
465
  accountType?: 'accounts_payable' | 'accounts_receivable' | 'allowed_for_1099' | 'ap_and_sales_tax' | 'ap_or_credit_card' | 'ar_and_ap' | 'asset' | 'balance_sheet' | 'bank' | 'bank_and_ar_and_ap_and_uf' | 'bank_and_uf' | 'cost_of_sales' | 'credit_card' | 'current_asset' | 'current_asset_and_expense' | 'current_liability' | 'equity' | 'equity_and_income_and_expense' | 'expense_and_other_expense' | 'fixed_asset' | 'income_and_expense' | 'income_and_other_income' | 'liability' | 'liability_and_equity' | 'long_term_liability' | 'non_posting' | 'ordinary_expense' | 'ordinary_income' | 'ordinary_income_and_cogs' | 'ordinary_income_and_expense' | 'other_asset' | 'other_current_asset' | 'other_current_liability' | 'other_expense' | 'other_income' | 'other_income_or_expense';
431
466
  /**
@@ -434,17 +469,16 @@ export interface ReportAgingParams {
434
469
  */
435
470
  agingAsOf?: 'report_end_date' | 'today';
436
471
  /**
437
- * Query param: Filter for report data by class `fullName` values,
438
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
439
- * joining parent object names with the object's `name` using colons. Repeat this
440
- * query parameter to include multiple classes. Use only one class filter per
441
- * request.
472
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
473
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
474
+ * names with the object's `name` using colons. Accepts one or more class full
475
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
442
476
  */
443
477
  classFullNames?: Array<string>;
444
478
  /**
445
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
446
- * this query parameter to include multiple classes. Use only one class filter per
447
- * request.
479
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
480
+ * more class IDs. Choose only one class filter per request: `classIds` or
481
+ * `classFullNames`.
448
482
  */
449
483
  classIds?: Array<string>;
450
484
  /**
@@ -454,91 +488,97 @@ export interface ReportAgingParams {
454
488
  */
455
489
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
456
490
  /**
457
- * Query param: Filter for report data by entity `fullName` values,
458
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
459
- * joining parent object names with the object's `name` using colons. Repeat this
460
- * query parameter to include multiple entities. Use only one entity filter per
461
- * request.
491
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
492
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
493
+ * names with the object's `name` using colons. Accepts one or more entity full
494
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
495
+ * `entityFullNames`.
462
496
  */
463
497
  entityFullNames?: Array<string>;
464
498
  /**
465
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
466
- * this query parameter to include multiple entities. Use only one entity filter
467
- * per request.
499
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
500
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
501
+ * `entityIds`, or `entityFullNames`.
468
502
  */
469
503
  entityIds?: Array<string>;
470
504
  /**
471
- * Query param: Filter for report data by entity type, such as customer, vendor,
472
- * employee, or other name. Use only one entity filter per request.
505
+ * Query param: Filter report rows by entity type, such as customer, vendor,
506
+ * employee, or other name. Choose only one entity filter per request:
507
+ * `entityType`, `entityIds`, or `entityFullNames`.
473
508
  */
474
509
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
475
510
  /**
476
- * Query param: The specific report columns to include, by column type. Repeat this
477
- * query parameter to request multiple columns. When this parameter is present,
478
- * QuickBooks Desktop omits its default report columns unless you include them
479
- * here.
511
+ * Query param: The report columns to include, by column type. Accepts one or more
512
+ * columns.
513
+ *
514
+ * **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
515
+ * default report columns unless you include them here.
480
516
  */
481
517
  includeColumns?: Array<'account' | 'aging' | 'amount' | 'amount_difference' | 'average_cost' | 'billed_date' | 'billing_status' | 'calculated_amount' | 'class' | 'cleared_status' | 'cost_price' | 'credit' | 'currency' | 'date' | 'debit' | 'delivery_date' | 'due_date' | 'estimate_active' | 'exchange_rate' | 'shipment_origin' | 'income_subject_to_tax' | 'invoiced' | 'item' | 'description' | 'last_modified_by' | 'latest_or_prior_state' | 'memo' | 'updated_at' | 'name' | 'name_account_number' | 'name_address' | 'name_city' | 'name_contact' | 'name_email' | 'name_fax' | 'name_phone' | 'name_state' | 'name_postal_code' | 'open_balance' | 'original_amount' | 'paid_amount' | 'paid_status' | 'paid_through_date' | 'payment_method' | 'payroll_item' | 'purchase_order_number' | 'print_status' | 'progress_amount' | 'progress_percent' | 'quantity' | 'quantity_available' | 'quantity_on_hand' | 'quantity_on_sales_order' | 'received_quantity' | 'ref_number' | 'running_balance' | 'sales_representative' | 'sales_tax_code' | 'serial_or_lot_number' | 'shipping_date' | 'shipping_method' | 'source_name' | 'split_account' | 'ssn_or_tax_identification_number' | 'tax_line' | 'tax_table_version' | 'terms' | 'transaction_id' | 'transaction_number' | 'transaction_type' | 'unit_price' | 'user_edit' | 'value_on_hand' | 'wage_base' | 'wage_base_tips'>;
482
518
  /**
483
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
484
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
485
- * object names with the object's `name` using colons. Repeat this query parameter
486
- * to include multiple items. Use only one item filter per request.
519
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
520
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
521
+ * names with the object's `name` using colons. Accepts one or more item full
522
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
523
+ * `itemFullNames`.
487
524
  */
488
525
  itemFullNames?: Array<string>;
489
526
  /**
490
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
491
- * query parameter to include multiple items. Use only one item filter per request.
527
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
528
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
529
+ * or `itemFullNames`.
492
530
  */
493
531
  itemIds?: Array<string>;
494
532
  /**
495
- * Query param: Filter for report data by item type. Use only one item filter per
496
- * request.
533
+ * Query param: Filter report rows by item type. Choose only one item filter per
534
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
497
535
  */
498
536
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
499
537
  /**
500
- * Query param: Filter for report data that is posting, non-posting, or either.
538
+ * Query param: Filter report rows that are posting, non-posting, or either.
501
539
  * Posting status refers to whether QuickBooks records the transaction in an
502
540
  * account register.
503
541
  */
504
542
  postingStatus?: 'either' | 'non_posting' | 'posting';
505
543
  /**
506
- * Query param: Filter for report data dated on or after this date, in ISO 8601
507
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
508
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
509
- * the current fiscal year to date.
544
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
545
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
546
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
547
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
510
548
  */
511
549
  reportDateFrom?: string;
512
550
  /**
513
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
514
- * with `reportDateFrom` or `reportDateTo`.
551
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
552
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
515
553
  */
516
554
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
517
555
  /**
518
- * Query param: Filter for report data dated on or before this date, in ISO 8601
519
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
520
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
521
- * the current fiscal year to date.
556
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
557
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
558
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
559
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
522
560
  */
523
561
  reportDateTo?: string;
524
562
  /**
525
- * Query param: Filter for report data by transaction type(s). Repeat this query
526
- * parameter to include multiple transaction types.
563
+ * Query param: Filter report rows by transaction type. Accepts one or more
564
+ * transaction types.
527
565
  */
528
566
  transactionTypes?: Array<'all' | 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment'>;
529
567
  /**
530
- * Query param: Filter for report data updated on or after this date, in ISO 8601
531
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
568
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
569
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
570
+ * `updatedAfter`/`updatedBefore`.
532
571
  */
533
572
  updatedAfter?: string;
534
573
  /**
535
- * Query param: Filter for report data updated on or before this date, in ISO 8601
536
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
574
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
575
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
576
+ * `updatedAfter`/`updatedBefore`.
537
577
  */
538
578
  updatedBefore?: string;
539
579
  /**
540
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
541
- * combined with `updatedAfter` or `updatedBefore`.
580
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
581
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
542
582
  */
543
583
  updatedDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
544
584
  }
@@ -563,36 +603,35 @@ export interface ReportBudgetSummaryParams {
563
603
  */
564
604
  budgetCriterion?: 'accounts' | 'accounts_and_classes' | 'accounts_and_customers';
565
605
  /**
566
- * Query param: Filter for report data by class `fullName` values,
567
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
568
- * joining parent object names with the object's `name` using colons. Repeat this
569
- * query parameter to include multiple classes. Use only one class filter per
570
- * request.
606
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
607
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
608
+ * names with the object's `name` using colons. Accepts one or more class full
609
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
571
610
  */
572
611
  classFullNames?: Array<string>;
573
612
  /**
574
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
575
- * this query parameter to include multiple classes. Use only one class filter per
576
- * request.
613
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
614
+ * more class IDs. Choose only one class filter per request: `classIds` or
615
+ * `classFullNames`.
577
616
  */
578
617
  classIds?: Array<string>;
579
618
  /**
580
- * Query param: Filter for report data dated on or after this date, in ISO 8601
581
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
582
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
583
- * the current fiscal year to date.
619
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
620
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
621
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
622
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
584
623
  */
585
624
  reportDateFrom?: string;
586
625
  /**
587
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
588
- * with `reportDateFrom` or `reportDateTo`.
626
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
627
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
589
628
  */
590
629
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
591
630
  /**
592
- * Query param: Filter for report data dated on or before this date, in ISO 8601
593
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
594
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
595
- * the current fiscal year to date.
631
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
632
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
633
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
634
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
596
635
  */
597
636
  reportDateTo?: string;
598
637
  /**
@@ -607,10 +646,11 @@ export interface ReportBudgetSummaryParams {
607
646
  }
608
647
  export interface ReportCustomDetailParams {
609
648
  /**
610
- * Query param: The specific report columns to include, by column type. Repeat this
611
- * query parameter to request multiple columns. When this parameter is present,
612
- * QuickBooks Desktop omits its default report columns unless you include them
613
- * here.
649
+ * Query param: The report columns to include, by column type. Accepts one or more
650
+ * columns.
651
+ *
652
+ * **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
653
+ * default report columns unless you include them here.
614
654
  */
615
655
  includeColumns: Array<'account' | 'aging' | 'amount' | 'amount_difference' | 'average_cost' | 'billed_date' | 'billing_status' | 'calculated_amount' | 'class' | 'cleared_status' | 'cost_price' | 'credit' | 'currency' | 'date' | 'debit' | 'delivery_date' | 'due_date' | 'estimate_active' | 'exchange_rate' | 'shipment_origin' | 'income_subject_to_tax' | 'invoiced' | 'item' | 'description' | 'last_modified_by' | 'latest_or_prior_state' | 'memo' | 'updated_at' | 'name' | 'name_account_number' | 'name_address' | 'name_city' | 'name_contact' | 'name_email' | 'name_fax' | 'name_phone' | 'name_state' | 'name_postal_code' | 'open_balance' | 'original_amount' | 'paid_amount' | 'paid_status' | 'paid_through_date' | 'payment_method' | 'payroll_item' | 'purchase_order_number' | 'print_status' | 'progress_amount' | 'progress_percent' | 'quantity' | 'quantity_available' | 'quantity_on_hand' | 'quantity_on_sales_order' | 'received_quantity' | 'ref_number' | 'running_balance' | 'sales_representative' | 'sales_tax_code' | 'serial_or_lot_number' | 'shipping_date' | 'shipping_method' | 'source_name' | 'split_account' | 'ssn_or_tax_identification_number' | 'tax_line' | 'tax_table_version' | 'terms' | 'transaction_id' | 'transaction_number' | 'transaction_type' | 'unit_price' | 'user_edit' | 'value_on_hand' | 'wage_base' | 'wage_base_tips'>;
616
656
  /**
@@ -623,17 +663,17 @@ export interface ReportCustomDetailParams {
623
663
  */
624
664
  conductorEndUserId: string;
625
665
  /**
626
- * Query param: Filter for report data by account `fullName` values,
627
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
628
- * joining parent object names with the object's `name` using colons. Repeat this
629
- * query parameter to include multiple accounts. Use only one account filter per
630
- * request.
666
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
667
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
668
+ * object names with the object's `name` using colons. Accepts one or more account
669
+ * full names. Choose only one account filter per request: `accountType`,
670
+ * `accountIds`, or `accountFullNames`.
631
671
  */
632
672
  accountFullNames?: Array<string>;
633
673
  /**
634
- * Query param: Filter for report data by QuickBooks-assigned account IDs. Repeat
635
- * this query parameter to include multiple accounts. Use only one account filter
636
- * per request.
674
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
675
+ * or more account IDs. Choose only one account filter per request: `accountType`,
676
+ * `accountIds`, or `accountFullNames`.
637
677
  */
638
678
  accountIds?: Array<string>;
639
679
  /**
@@ -641,8 +681,8 @@ export interface ReportCustomDetailParams {
641
681
  */
642
682
  accountsToInclude?: 'all' | 'in_use';
643
683
  /**
644
- * Query param: Filter for report data by account type. Use only one account filter
645
- * per request.
684
+ * Query param: Filter report rows by account type. Choose only one account filter
685
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
646
686
  */
647
687
  accountType?: 'accounts_payable' | 'accounts_receivable' | 'allowed_for_1099' | 'ap_and_sales_tax' | 'ap_or_credit_card' | 'ar_and_ap' | 'asset' | 'balance_sheet' | 'bank' | 'bank_and_ar_and_ap_and_uf' | 'bank_and_uf' | 'cost_of_sales' | 'credit_card' | 'current_asset' | 'current_asset_and_expense' | 'current_liability' | 'equity' | 'equity_and_income_and_expense' | 'expense_and_other_expense' | 'fixed_asset' | 'income_and_expense' | 'income_and_other_income' | 'liability' | 'liability_and_equity' | 'long_term_liability' | 'non_posting' | 'ordinary_expense' | 'ordinary_income' | 'ordinary_income_and_cogs' | 'ordinary_income_and_expense' | 'other_asset' | 'other_current_asset' | 'other_current_liability' | 'other_expense' | 'other_income' | 'other_income_or_expense';
648
688
  /**
@@ -653,17 +693,16 @@ export interface ReportCustomDetailParams {
653
693
  */
654
694
  basis?: 'accrual' | 'cash' | 'none';
655
695
  /**
656
- * Query param: Filter for report data by class `fullName` values,
657
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
658
- * joining parent object names with the object's `name` using colons. Repeat this
659
- * query parameter to include multiple classes. Use only one class filter per
660
- * request.
696
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
697
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
698
+ * names with the object's `name` using colons. Accepts one or more class full
699
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
661
700
  */
662
701
  classFullNames?: Array<string>;
663
702
  /**
664
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
665
- * this query parameter to include multiple classes. Use only one class filter per
666
- * request.
703
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
704
+ * more class IDs. Choose only one class filter per request: `classIds` or
705
+ * `classFullNames`.
667
706
  */
668
707
  classIds?: Array<string>;
669
708
  /**
@@ -673,39 +712,42 @@ export interface ReportCustomDetailParams {
673
712
  */
674
713
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
675
714
  /**
676
- * Query param: Filter for report data by entity `fullName` values,
677
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
678
- * joining parent object names with the object's `name` using colons. Repeat this
679
- * query parameter to include multiple entities. Use only one entity filter per
680
- * request.
715
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
716
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
717
+ * names with the object's `name` using colons. Accepts one or more entity full
718
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
719
+ * `entityFullNames`.
681
720
  */
682
721
  entityFullNames?: Array<string>;
683
722
  /**
684
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
685
- * this query parameter to include multiple entities. Use only one entity filter
686
- * per request.
723
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
724
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
725
+ * `entityIds`, or `entityFullNames`.
687
726
  */
688
727
  entityIds?: Array<string>;
689
728
  /**
690
- * Query param: Filter for report data by entity type, such as customer, vendor,
691
- * employee, or other name. Use only one entity filter per request.
729
+ * Query param: Filter report rows by entity type, such as customer, vendor,
730
+ * employee, or other name. Choose only one entity filter per request:
731
+ * `entityType`, `entityIds`, or `entityFullNames`.
692
732
  */
693
733
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
694
734
  /**
695
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
696
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
697
- * object names with the object's `name` using colons. Repeat this query parameter
698
- * to include multiple items. Use only one item filter per request.
735
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
736
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
737
+ * names with the object's `name` using colons. Accepts one or more item full
738
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
739
+ * `itemFullNames`.
699
740
  */
700
741
  itemFullNames?: Array<string>;
701
742
  /**
702
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
703
- * query parameter to include multiple items. Use only one item filter per request.
743
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
744
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
745
+ * or `itemFullNames`.
704
746
  */
705
747
  itemIds?: Array<string>;
706
748
  /**
707
- * Query param: Filter for report data by item type. Use only one item filter per
708
- * request.
749
+ * Query param: Filter report rows by item type. Choose only one item filter per
750
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
709
751
  */
710
752
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
711
753
  /**
@@ -714,28 +756,28 @@ export interface ReportCustomDetailParams {
714
756
  */
715
757
  openBalanceAsOf?: 'report_end_date' | 'today';
716
758
  /**
717
- * Query param: Filter for report data that is posting, non-posting, or either.
759
+ * Query param: Filter report rows that are posting, non-posting, or either.
718
760
  * Posting status refers to whether QuickBooks records the transaction in an
719
761
  * account register.
720
762
  */
721
763
  postingStatus?: 'either' | 'non_posting' | 'posting';
722
764
  /**
723
- * Query param: Filter for report data dated on or after this date, in ISO 8601
724
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
725
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
726
- * the current fiscal year to date.
765
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
766
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
767
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
768
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
727
769
  */
728
770
  reportDateFrom?: string;
729
771
  /**
730
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
731
- * with `reportDateFrom` or `reportDateTo`.
772
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
773
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
732
774
  */
733
775
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
734
776
  /**
735
- * Query param: Filter for report data dated on or before this date, in ISO 8601
736
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
737
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
738
- * the current fiscal year to date.
777
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
778
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
779
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
780
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
739
781
  */
740
782
  reportDateTo?: string;
741
783
  /**
@@ -745,23 +787,25 @@ export interface ReportCustomDetailParams {
745
787
  */
746
788
  reportType?: 'custom_transaction_detail';
747
789
  /**
748
- * Query param: Filter for report data by transaction type(s). Repeat this query
749
- * parameter to include multiple transaction types.
790
+ * Query param: Filter report rows by transaction type. Accepts one or more
791
+ * transaction types.
750
792
  */
751
793
  transactionTypes?: Array<'all' | 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment'>;
752
794
  /**
753
- * Query param: Filter for report data updated on or after this date, in ISO 8601
754
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
795
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
796
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
797
+ * `updatedAfter`/`updatedBefore`.
755
798
  */
756
799
  updatedAfter?: string;
757
800
  /**
758
- * Query param: Filter for report data updated on or before this date, in ISO 8601
759
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
801
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
802
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
803
+ * `updatedAfter`/`updatedBefore`.
760
804
  */
761
805
  updatedBefore?: string;
762
806
  /**
763
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
764
- * combined with `updatedAfter` or `updatedBefore`.
807
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
808
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
765
809
  */
766
810
  updatedDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
767
811
  }
@@ -781,22 +825,22 @@ export interface ReportCustomSummaryParams {
781
825
  */
782
826
  conductorEndUserId: string;
783
827
  /**
784
- * Query param: Filter for report data by account `fullName` values,
785
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
786
- * joining parent object names with the object's `name` using colons. Repeat this
787
- * query parameter to include multiple accounts. Use only one account filter per
788
- * request.
828
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
829
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
830
+ * object names with the object's `name` using colons. Accepts one or more account
831
+ * full names. Choose only one account filter per request: `accountType`,
832
+ * `accountIds`, or `accountFullNames`.
789
833
  */
790
834
  accountFullNames?: Array<string>;
791
835
  /**
792
- * Query param: Filter for report data by QuickBooks-assigned account IDs. Repeat
793
- * this query parameter to include multiple accounts. Use only one account filter
794
- * per request.
836
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
837
+ * or more account IDs. Choose only one account filter per request: `accountType`,
838
+ * `accountIds`, or `accountFullNames`.
795
839
  */
796
840
  accountIds?: Array<string>;
797
841
  /**
798
- * Query param: Filter for report data by account type. Use only one account filter
799
- * per request.
842
+ * Query param: Filter report rows by account type. Choose only one account filter
843
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
800
844
  */
801
845
  accountType?: 'accounts_payable' | 'accounts_receivable' | 'allowed_for_1099' | 'ap_and_sales_tax' | 'ap_or_credit_card' | 'ar_and_ap' | 'asset' | 'balance_sheet' | 'bank' | 'bank_and_ar_and_ap_and_uf' | 'bank_and_uf' | 'cost_of_sales' | 'credit_card' | 'current_asset' | 'current_asset_and_expense' | 'current_liability' | 'equity' | 'equity_and_income_and_expense' | 'expense_and_other_expense' | 'fixed_asset' | 'income_and_expense' | 'income_and_other_income' | 'liability' | 'liability_and_equity' | 'long_term_liability' | 'non_posting' | 'ordinary_expense' | 'ordinary_income' | 'ordinary_income_and_cogs' | 'ordinary_income_and_expense' | 'other_asset' | 'other_current_asset' | 'other_current_liability' | 'other_expense' | 'other_income' | 'other_income_or_expense';
802
846
  /**
@@ -807,17 +851,16 @@ export interface ReportCustomSummaryParams {
807
851
  */
808
852
  basis?: 'accrual' | 'cash' | 'none';
809
853
  /**
810
- * Query param: Filter for report data by class `fullName` values,
811
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
812
- * joining parent object names with the object's `name` using colons. Repeat this
813
- * query parameter to include multiple classes. Use only one class filter per
814
- * request.
854
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
855
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
856
+ * names with the object's `name` using colons. Accepts one or more class full
857
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
815
858
  */
816
859
  classFullNames?: Array<string>;
817
860
  /**
818
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
819
- * this query parameter to include multiple classes. Use only one class filter per
820
- * request.
861
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
862
+ * more class IDs. Choose only one class filter per request: `classIds` or
863
+ * `classFullNames`.
821
864
  */
822
865
  classIds?: Array<string>;
823
866
  /**
@@ -833,48 +876,53 @@ export interface ReportCustomSummaryParams {
833
876
  */
834
877
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
835
878
  /**
836
- * Query param: Filter for report data by entity `fullName` values,
837
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
838
- * joining parent object names with the object's `name` using colons. Repeat this
839
- * query parameter to include multiple entities. Use only one entity filter per
840
- * request.
879
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
880
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
881
+ * names with the object's `name` using colons. Accepts one or more entity full
882
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
883
+ * `entityFullNames`.
841
884
  */
842
885
  entityFullNames?: Array<string>;
843
886
  /**
844
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
845
- * this query parameter to include multiple entities. Use only one entity filter
846
- * per request.
887
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
888
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
889
+ * `entityIds`, or `entityFullNames`.
847
890
  */
848
891
  entityIds?: Array<string>;
849
892
  /**
850
- * Query param: Filter for report data by entity type, such as customer, vendor,
851
- * employee, or other name. Use only one entity filter per request.
893
+ * Query param: Filter report rows by entity type, such as customer, vendor,
894
+ * employee, or other name. Choose only one entity filter per request:
895
+ * `entityType`, `entityIds`, or `entityFullNames`.
852
896
  */
853
897
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
854
898
  /**
855
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
856
- * still omit subcolumns that it can easily compute from other returned values.
899
+ * Query param: Whether to include subcolumns in the report.
900
+ *
901
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
902
+ * compute from other returned values.
857
903
  */
858
904
  includeSubcolumns?: boolean;
859
905
  /**
860
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
861
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
862
- * object names with the object's `name` using colons. Repeat this query parameter
863
- * to include multiple items. Use only one item filter per request.
906
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
907
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
908
+ * names with the object's `name` using colons. Accepts one or more item full
909
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
910
+ * `itemFullNames`.
864
911
  */
865
912
  itemFullNames?: Array<string>;
866
913
  /**
867
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
868
- * query parameter to include multiple items. Use only one item filter per request.
914
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
915
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
916
+ * or `itemFullNames`.
869
917
  */
870
918
  itemIds?: Array<string>;
871
919
  /**
872
- * Query param: Filter for report data by item type. Use only one item filter per
873
- * request.
920
+ * Query param: Filter report rows by item type. Choose only one item filter per
921
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
874
922
  */
875
923
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
876
924
  /**
877
- * Query param: Filter for report data that is posting, non-posting, or either.
925
+ * Query param: Filter report rows that are posting, non-posting, or either.
878
926
  * Posting status refers to whether QuickBooks records the transaction in an
879
927
  * account register.
880
928
  */
@@ -884,22 +932,22 @@ export interface ReportCustomSummaryParams {
884
932
  */
885
933
  reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
886
934
  /**
887
- * Query param: Filter for report data dated on or after this date, in ISO 8601
888
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
889
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
890
- * the current fiscal year to date.
935
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
936
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
937
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
938
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
891
939
  */
892
940
  reportDateFrom?: string;
893
941
  /**
894
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
895
- * with `reportDateFrom` or `reportDateTo`.
942
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
943
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
896
944
  */
897
945
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
898
946
  /**
899
- * Query param: Filter for report data dated on or before this date, in ISO 8601
900
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
901
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
902
- * the current fiscal year to date.
947
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
948
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
949
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
950
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
903
951
  */
904
952
  reportDateTo?: string;
905
953
  /**
@@ -914,23 +962,25 @@ export interface ReportCustomSummaryParams {
914
962
  */
915
963
  rowsToReturn?: 'active_only' | 'non_zero' | 'all';
916
964
  /**
917
- * Query param: Filter for report data by transaction type(s). Repeat this query
918
- * parameter to include multiple transaction types.
965
+ * Query param: Filter report rows by transaction type. Accepts one or more
966
+ * transaction types.
919
967
  */
920
968
  transactionTypes?: Array<'all' | 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment'>;
921
969
  /**
922
- * Query param: Filter for report data updated on or after this date, in ISO 8601
923
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
970
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
971
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
972
+ * `updatedAfter`/`updatedBefore`.
924
973
  */
925
974
  updatedAfter?: string;
926
975
  /**
927
- * Query param: Filter for report data updated on or before this date, in ISO 8601
928
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
976
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
977
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
978
+ * `updatedAfter`/`updatedBefore`.
929
979
  */
930
980
  updatedBefore?: string;
931
981
  /**
932
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
933
- * combined with `updatedAfter` or `updatedBefore`.
982
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
983
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
934
984
  */
935
985
  updatedDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
936
986
  }
@@ -944,17 +994,17 @@ export interface ReportGeneralDetailParams {
944
994
  */
945
995
  conductorEndUserId: string;
946
996
  /**
947
- * Query param: Filter for report data by account `fullName` values,
948
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
949
- * joining parent object names with the object's `name` using colons. Repeat this
950
- * query parameter to include multiple accounts. Use only one account filter per
951
- * request.
997
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
998
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
999
+ * object names with the object's `name` using colons. Accepts one or more account
1000
+ * full names. Choose only one account filter per request: `accountType`,
1001
+ * `accountIds`, or `accountFullNames`.
952
1002
  */
953
1003
  accountFullNames?: Array<string>;
954
1004
  /**
955
- * Query param: Filter for report data by QuickBooks-assigned account IDs. Repeat
956
- * this query parameter to include multiple accounts. Use only one account filter
957
- * per request.
1005
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1006
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1007
+ * `accountIds`, or `accountFullNames`.
958
1008
  */
959
1009
  accountIds?: Array<string>;
960
1010
  /**
@@ -962,8 +1012,8 @@ export interface ReportGeneralDetailParams {
962
1012
  */
963
1013
  accountsToInclude?: 'all' | 'in_use';
964
1014
  /**
965
- * Query param: Filter for report data by account type. Use only one account filter
966
- * per request.
1015
+ * Query param: Filter report rows by account type. Choose only one account filter
1016
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
967
1017
  */
968
1018
  accountType?: 'accounts_payable' | 'accounts_receivable' | 'allowed_for_1099' | 'ap_and_sales_tax' | 'ap_or_credit_card' | 'ar_and_ap' | 'asset' | 'balance_sheet' | 'bank' | 'bank_and_ar_and_ap_and_uf' | 'bank_and_uf' | 'cost_of_sales' | 'credit_card' | 'current_asset' | 'current_asset_and_expense' | 'current_liability' | 'equity' | 'equity_and_income_and_expense' | 'expense_and_other_expense' | 'fixed_asset' | 'income_and_expense' | 'income_and_other_income' | 'liability' | 'liability_and_equity' | 'long_term_liability' | 'non_posting' | 'ordinary_expense' | 'ordinary_income' | 'ordinary_income_and_cogs' | 'ordinary_income_and_expense' | 'other_asset' | 'other_current_asset' | 'other_current_liability' | 'other_expense' | 'other_income' | 'other_income_or_expense';
969
1019
  /**
@@ -974,17 +1024,16 @@ export interface ReportGeneralDetailParams {
974
1024
  */
975
1025
  basis?: 'accrual' | 'cash' | 'none';
976
1026
  /**
977
- * Query param: Filter for report data by class `fullName` values,
978
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
979
- * joining parent object names with the object's `name` using colons. Repeat this
980
- * query parameter to include multiple classes. Use only one class filter per
981
- * request.
1027
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1028
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1029
+ * names with the object's `name` using colons. Accepts one or more class full
1030
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
982
1031
  */
983
1032
  classFullNames?: Array<string>;
984
1033
  /**
985
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
986
- * this query parameter to include multiple classes. Use only one class filter per
987
- * request.
1034
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1035
+ * more class IDs. Choose only one class filter per request: `classIds` or
1036
+ * `classFullNames`.
988
1037
  */
989
1038
  classIds?: Array<string>;
990
1039
  /**
@@ -994,46 +1043,50 @@ export interface ReportGeneralDetailParams {
994
1043
  */
995
1044
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
996
1045
  /**
997
- * Query param: Filter for report data by entity `fullName` values,
998
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
999
- * joining parent object names with the object's `name` using colons. Repeat this
1000
- * query parameter to include multiple entities. Use only one entity filter per
1001
- * request.
1046
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1047
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1048
+ * names with the object's `name` using colons. Accepts one or more entity full
1049
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1050
+ * `entityFullNames`.
1002
1051
  */
1003
1052
  entityFullNames?: Array<string>;
1004
1053
  /**
1005
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
1006
- * this query parameter to include multiple entities. Use only one entity filter
1007
- * per request.
1054
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1055
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1056
+ * `entityIds`, or `entityFullNames`.
1008
1057
  */
1009
1058
  entityIds?: Array<string>;
1010
1059
  /**
1011
- * Query param: Filter for report data by entity type, such as customer, vendor,
1012
- * employee, or other name. Use only one entity filter per request.
1060
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1061
+ * employee, or other name. Choose only one entity filter per request:
1062
+ * `entityType`, `entityIds`, or `entityFullNames`.
1013
1063
  */
1014
1064
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1015
1065
  /**
1016
- * Query param: The specific report columns to include, by column type. Repeat this
1017
- * query parameter to request multiple columns. When this parameter is present,
1018
- * QuickBooks Desktop omits its default report columns unless you include them
1019
- * here.
1066
+ * Query param: The report columns to include, by column type. Accepts one or more
1067
+ * columns.
1068
+ *
1069
+ * **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
1070
+ * default report columns unless you include them here.
1020
1071
  */
1021
1072
  includeColumns?: Array<'account' | 'aging' | 'amount' | 'amount_difference' | 'average_cost' | 'billed_date' | 'billing_status' | 'calculated_amount' | 'class' | 'cleared_status' | 'cost_price' | 'credit' | 'currency' | 'date' | 'debit' | 'delivery_date' | 'due_date' | 'estimate_active' | 'exchange_rate' | 'shipment_origin' | 'income_subject_to_tax' | 'invoiced' | 'item' | 'description' | 'last_modified_by' | 'latest_or_prior_state' | 'memo' | 'updated_at' | 'name' | 'name_account_number' | 'name_address' | 'name_city' | 'name_contact' | 'name_email' | 'name_fax' | 'name_phone' | 'name_state' | 'name_postal_code' | 'open_balance' | 'original_amount' | 'paid_amount' | 'paid_status' | 'paid_through_date' | 'payment_method' | 'payroll_item' | 'purchase_order_number' | 'print_status' | 'progress_amount' | 'progress_percent' | 'quantity' | 'quantity_available' | 'quantity_on_hand' | 'quantity_on_sales_order' | 'received_quantity' | 'ref_number' | 'running_balance' | 'sales_representative' | 'sales_tax_code' | 'serial_or_lot_number' | 'shipping_date' | 'shipping_method' | 'source_name' | 'split_account' | 'ssn_or_tax_identification_number' | 'tax_line' | 'tax_table_version' | 'terms' | 'transaction_id' | 'transaction_number' | 'transaction_type' | 'unit_price' | 'user_edit' | 'value_on_hand' | 'wage_base' | 'wage_base_tips'>;
1022
1073
  /**
1023
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
1024
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
1025
- * object names with the object's `name` using colons. Repeat this query parameter
1026
- * to include multiple items. Use only one item filter per request.
1074
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1075
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1076
+ * names with the object's `name` using colons. Accepts one or more item full
1077
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1078
+ * `itemFullNames`.
1027
1079
  */
1028
1080
  itemFullNames?: Array<string>;
1029
1081
  /**
1030
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
1031
- * query parameter to include multiple items. Use only one item filter per request.
1082
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1083
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1084
+ * or `itemFullNames`.
1032
1085
  */
1033
1086
  itemIds?: Array<string>;
1034
1087
  /**
1035
- * Query param: Filter for report data by item type. Use only one item filter per
1036
- * request.
1088
+ * Query param: Filter report rows by item type. Choose only one item filter per
1089
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1037
1090
  */
1038
1091
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1039
1092
  /**
@@ -1042,28 +1095,28 @@ export interface ReportGeneralDetailParams {
1042
1095
  */
1043
1096
  openBalanceAsOf?: 'report_end_date' | 'today';
1044
1097
  /**
1045
- * Query param: Filter for report data that is posting, non-posting, or either.
1098
+ * Query param: Filter report rows that are posting, non-posting, or either.
1046
1099
  * Posting status refers to whether QuickBooks records the transaction in an
1047
1100
  * account register.
1048
1101
  */
1049
1102
  postingStatus?: 'either' | 'non_posting' | 'posting';
1050
1103
  /**
1051
- * Query param: Filter for report data dated on or after this date, in ISO 8601
1052
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1053
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1054
- * the current fiscal year to date.
1104
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1105
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1106
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1107
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1055
1108
  */
1056
1109
  reportDateFrom?: string;
1057
1110
  /**
1058
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1059
- * with `reportDateFrom` or `reportDateTo`.
1111
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1112
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1060
1113
  */
1061
1114
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1062
1115
  /**
1063
- * Query param: Filter for report data dated on or before this date, in ISO 8601
1064
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1065
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1066
- * the current fiscal year to date.
1116
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1117
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1118
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1119
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1067
1120
  */
1068
1121
  reportDateTo?: string;
1069
1122
  /**
@@ -1072,23 +1125,25 @@ export interface ReportGeneralDetailParams {
1072
1125
  */
1073
1126
  summarizeRowsBy?: 'account' | 'balance_sheet' | 'class' | 'customer' | 'customer_type' | 'day' | 'employee' | 'four_week' | 'half_month' | 'income_statement' | 'item_detail' | 'item_type' | 'month' | 'payee' | 'payment_method' | 'payroll_item_detail' | 'payroll_ytd_detail' | 'quarter' | 'sales_representative' | 'sales_tax_code' | 'shipping_method' | 'tax_line' | 'terms' | 'total_only' | 'two_week' | 'vendor' | 'vendor_type' | 'week' | 'year';
1074
1127
  /**
1075
- * Query param: Filter for report data by transaction type(s). Repeat this query
1076
- * parameter to include multiple transaction types.
1128
+ * Query param: Filter report rows by transaction type. Accepts one or more
1129
+ * transaction types.
1077
1130
  */
1078
1131
  transactionTypes?: Array<'all' | 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment'>;
1079
1132
  /**
1080
- * Query param: Filter for report data updated on or after this date, in ISO 8601
1081
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1133
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1134
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1135
+ * `updatedAfter`/`updatedBefore`.
1082
1136
  */
1083
1137
  updatedAfter?: string;
1084
1138
  /**
1085
- * Query param: Filter for report data updated on or before this date, in ISO 8601
1086
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1139
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1140
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1141
+ * `updatedAfter`/`updatedBefore`.
1087
1142
  */
1088
1143
  updatedBefore?: string;
1089
1144
  /**
1090
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1091
- * combined with `updatedAfter` or `updatedBefore`.
1145
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1146
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1092
1147
  */
1093
1148
  updatedDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1094
1149
  }
@@ -1102,22 +1157,22 @@ export interface ReportGeneralSummaryParams {
1102
1157
  */
1103
1158
  conductorEndUserId: string;
1104
1159
  /**
1105
- * Query param: Filter for report data by account `fullName` values,
1106
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1107
- * joining parent object names with the object's `name` using colons. Repeat this
1108
- * query parameter to include multiple accounts. Use only one account filter per
1109
- * request.
1160
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
1161
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
1162
+ * object names with the object's `name` using colons. Accepts one or more account
1163
+ * full names. Choose only one account filter per request: `accountType`,
1164
+ * `accountIds`, or `accountFullNames`.
1110
1165
  */
1111
1166
  accountFullNames?: Array<string>;
1112
1167
  /**
1113
- * Query param: Filter for report data by QuickBooks-assigned account IDs. Repeat
1114
- * this query parameter to include multiple accounts. Use only one account filter
1115
- * per request.
1168
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1169
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1170
+ * `accountIds`, or `accountFullNames`.
1116
1171
  */
1117
1172
  accountIds?: Array<string>;
1118
1173
  /**
1119
- * Query param: Filter for report data by account type. Use only one account filter
1120
- * per request.
1174
+ * Query param: Filter report rows by account type. Choose only one account filter
1175
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1121
1176
  */
1122
1177
  accountType?: 'accounts_payable' | 'accounts_receivable' | 'allowed_for_1099' | 'ap_and_sales_tax' | 'ap_or_credit_card' | 'ar_and_ap' | 'asset' | 'balance_sheet' | 'bank' | 'bank_and_ar_and_ap_and_uf' | 'bank_and_uf' | 'cost_of_sales' | 'credit_card' | 'current_asset' | 'current_asset_and_expense' | 'current_liability' | 'equity' | 'equity_and_income_and_expense' | 'expense_and_other_expense' | 'fixed_asset' | 'income_and_expense' | 'income_and_other_income' | 'liability' | 'liability_and_equity' | 'long_term_liability' | 'non_posting' | 'ordinary_expense' | 'ordinary_income' | 'ordinary_income_and_cogs' | 'ordinary_income_and_expense' | 'other_asset' | 'other_current_asset' | 'other_current_liability' | 'other_expense' | 'other_income' | 'other_income_or_expense';
1123
1178
  /**
@@ -1128,17 +1183,16 @@ export interface ReportGeneralSummaryParams {
1128
1183
  */
1129
1184
  basis?: 'accrual' | 'cash' | 'none';
1130
1185
  /**
1131
- * Query param: Filter for report data by class `fullName` values,
1132
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1133
- * joining parent object names with the object's `name` using colons. Repeat this
1134
- * query parameter to include multiple classes. Use only one class filter per
1135
- * request.
1186
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1187
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1188
+ * names with the object's `name` using colons. Accepts one or more class full
1189
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1136
1190
  */
1137
1191
  classFullNames?: Array<string>;
1138
1192
  /**
1139
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
1140
- * this query parameter to include multiple classes. Use only one class filter per
1141
- * request.
1193
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1194
+ * more class IDs. Choose only one class filter per request: `classIds` or
1195
+ * `classFullNames`.
1142
1196
  */
1143
1197
  classIds?: Array<string>;
1144
1198
  /**
@@ -1154,48 +1208,53 @@ export interface ReportGeneralSummaryParams {
1154
1208
  */
1155
1209
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1156
1210
  /**
1157
- * Query param: Filter for report data by entity `fullName` values,
1158
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1159
- * joining parent object names with the object's `name` using colons. Repeat this
1160
- * query parameter to include multiple entities. Use only one entity filter per
1161
- * request.
1211
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1212
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1213
+ * names with the object's `name` using colons. Accepts one or more entity full
1214
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1215
+ * `entityFullNames`.
1162
1216
  */
1163
1217
  entityFullNames?: Array<string>;
1164
1218
  /**
1165
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
1166
- * this query parameter to include multiple entities. Use only one entity filter
1167
- * per request.
1219
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1220
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1221
+ * `entityIds`, or `entityFullNames`.
1168
1222
  */
1169
1223
  entityIds?: Array<string>;
1170
1224
  /**
1171
- * Query param: Filter for report data by entity type, such as customer, vendor,
1172
- * employee, or other name. Use only one entity filter per request.
1225
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1226
+ * employee, or other name. Choose only one entity filter per request:
1227
+ * `entityType`, `entityIds`, or `entityFullNames`.
1173
1228
  */
1174
1229
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1175
1230
  /**
1176
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1177
- * still omit subcolumns that it can easily compute from other returned values.
1231
+ * Query param: Whether to include subcolumns in the report.
1232
+ *
1233
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
1234
+ * compute from other returned values.
1178
1235
  */
1179
1236
  includeSubcolumns?: boolean;
1180
1237
  /**
1181
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
1182
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
1183
- * object names with the object's `name` using colons. Repeat this query parameter
1184
- * to include multiple items. Use only one item filter per request.
1238
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1239
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1240
+ * names with the object's `name` using colons. Accepts one or more item full
1241
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1242
+ * `itemFullNames`.
1185
1243
  */
1186
1244
  itemFullNames?: Array<string>;
1187
1245
  /**
1188
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
1189
- * query parameter to include multiple items. Use only one item filter per request.
1246
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1247
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1248
+ * or `itemFullNames`.
1190
1249
  */
1191
1250
  itemIds?: Array<string>;
1192
1251
  /**
1193
- * Query param: Filter for report data by item type. Use only one item filter per
1194
- * request.
1252
+ * Query param: Filter report rows by item type. Choose only one item filter per
1253
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1195
1254
  */
1196
1255
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1197
1256
  /**
1198
- * Query param: Filter for report data that is posting, non-posting, or either.
1257
+ * Query param: Filter report rows that are posting, non-posting, or either.
1199
1258
  * Posting status refers to whether QuickBooks records the transaction in an
1200
1259
  * account register.
1201
1260
  */
@@ -1205,22 +1264,22 @@ export interface ReportGeneralSummaryParams {
1205
1264
  */
1206
1265
  reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1207
1266
  /**
1208
- * Query param: Filter for report data dated on or after this date, in ISO 8601
1209
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1210
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1211
- * the current fiscal year to date.
1267
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1268
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1269
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1270
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1212
1271
  */
1213
1272
  reportDateFrom?: string;
1214
1273
  /**
1215
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1216
- * with `reportDateFrom` or `reportDateTo`.
1274
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1275
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1217
1276
  */
1218
1277
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1219
1278
  /**
1220
- * Query param: Filter for report data dated on or before this date, in ISO 8601
1221
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1222
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1223
- * the current fiscal year to date.
1279
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1280
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1281
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1282
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1224
1283
  */
1225
1284
  reportDateTo?: string;
1226
1285
  /**
@@ -1234,23 +1293,25 @@ export interface ReportGeneralSummaryParams {
1234
1293
  */
1235
1294
  summarizeColumnsBy?: 'account' | 'balance_sheet' | 'class' | 'customer' | 'customer_type' | 'day' | 'employee' | 'four_week' | 'half_month' | 'income_statement' | 'item_detail' | 'item_type' | 'month' | 'payee' | 'payment_method' | 'payroll_item_detail' | 'payroll_ytd_detail' | 'quarter' | 'sales_representative' | 'sales_tax_code' | 'shipping_method' | 'terms' | 'total_only' | 'two_week' | 'vendor' | 'vendor_type' | 'week' | 'year';
1236
1295
  /**
1237
- * Query param: Filter for report data by transaction type(s). Repeat this query
1238
- * parameter to include multiple transaction types.
1296
+ * Query param: Filter report rows by transaction type. Accepts one or more
1297
+ * transaction types.
1239
1298
  */
1240
1299
  transactionTypes?: Array<'all' | 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment'>;
1241
1300
  /**
1242
- * Query param: Filter for report data updated on or after this date, in ISO 8601
1243
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1301
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1302
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1303
+ * `updatedAfter`/`updatedBefore`.
1244
1304
  */
1245
1305
  updatedAfter?: string;
1246
1306
  /**
1247
- * Query param: Filter for report data updated on or before this date, in ISO 8601
1248
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1307
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1308
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1309
+ * `updatedAfter`/`updatedBefore`.
1249
1310
  */
1250
1311
  updatedBefore?: string;
1251
1312
  /**
1252
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1253
- * combined with `updatedAfter` or `updatedBefore`.
1313
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1314
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1254
1315
  */
1255
1316
  updatedDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1256
1317
  }
@@ -1264,36 +1325,35 @@ export interface ReportJobParams {
1264
1325
  */
1265
1326
  conductorEndUserId: string;
1266
1327
  /**
1267
- * Query param: Filter for report data by account `fullName` values,
1268
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1269
- * joining parent object names with the object's `name` using colons. Repeat this
1270
- * query parameter to include multiple accounts. Use only one account filter per
1271
- * request.
1328
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
1329
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
1330
+ * object names with the object's `name` using colons. Accepts one or more account
1331
+ * full names. Choose only one account filter per request: `accountType`,
1332
+ * `accountIds`, or `accountFullNames`.
1272
1333
  */
1273
1334
  accountFullNames?: Array<string>;
1274
1335
  /**
1275
- * Query param: Filter for report data by QuickBooks-assigned account IDs. Repeat
1276
- * this query parameter to include multiple accounts. Use only one account filter
1277
- * per request.
1336
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1337
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1338
+ * `accountIds`, or `accountFullNames`.
1278
1339
  */
1279
1340
  accountIds?: Array<string>;
1280
1341
  /**
1281
- * Query param: Filter for report data by account type. Use only one account filter
1282
- * per request.
1342
+ * Query param: Filter report rows by account type. Choose only one account filter
1343
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1283
1344
  */
1284
1345
  accountType?: 'accounts_payable' | 'accounts_receivable' | 'allowed_for_1099' | 'ap_and_sales_tax' | 'ap_or_credit_card' | 'ar_and_ap' | 'asset' | 'balance_sheet' | 'bank' | 'bank_and_ar_and_ap_and_uf' | 'bank_and_uf' | 'cost_of_sales' | 'credit_card' | 'current_asset' | 'current_asset_and_expense' | 'current_liability' | 'equity' | 'equity_and_income_and_expense' | 'expense_and_other_expense' | 'fixed_asset' | 'income_and_expense' | 'income_and_other_income' | 'liability' | 'liability_and_equity' | 'long_term_liability' | 'non_posting' | 'ordinary_expense' | 'ordinary_income' | 'ordinary_income_and_cogs' | 'ordinary_income_and_expense' | 'other_asset' | 'other_current_asset' | 'other_current_liability' | 'other_expense' | 'other_income' | 'other_income_or_expense';
1285
1346
  /**
1286
- * Query param: Filter for report data by class `fullName` values,
1287
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1288
- * joining parent object names with the object's `name` using colons. Repeat this
1289
- * query parameter to include multiple classes. Use only one class filter per
1290
- * request.
1347
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1348
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1349
+ * names with the object's `name` using colons. Accepts one or more class full
1350
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1291
1351
  */
1292
1352
  classFullNames?: Array<string>;
1293
1353
  /**
1294
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
1295
- * this query parameter to include multiple classes. Use only one class filter per
1296
- * request.
1354
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1355
+ * more class IDs. Choose only one class filter per request: `classIds` or
1356
+ * `classFullNames`.
1297
1357
  */
1298
1358
  classIds?: Array<string>;
1299
1359
  /**
@@ -1303,69 +1363,74 @@ export interface ReportJobParams {
1303
1363
  */
1304
1364
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1305
1365
  /**
1306
- * Query param: Filter for report data by entity `fullName` values,
1307
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1308
- * joining parent object names with the object's `name` using colons. Repeat this
1309
- * query parameter to include multiple entities. Use only one entity filter per
1310
- * request.
1366
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1367
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1368
+ * names with the object's `name` using colons. Accepts one or more entity full
1369
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1370
+ * `entityFullNames`.
1311
1371
  */
1312
1372
  entityFullNames?: Array<string>;
1313
1373
  /**
1314
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
1315
- * this query parameter to include multiple entities. Use only one entity filter
1316
- * per request.
1374
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1375
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1376
+ * `entityIds`, or `entityFullNames`.
1317
1377
  */
1318
1378
  entityIds?: Array<string>;
1319
1379
  /**
1320
- * Query param: Filter for report data by entity type, such as customer, vendor,
1321
- * employee, or other name. Use only one entity filter per request.
1380
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1381
+ * employee, or other name. Choose only one entity filter per request:
1382
+ * `entityType`, `entityIds`, or `entityFullNames`.
1322
1383
  */
1323
1384
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1324
1385
  /**
1325
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1326
- * still omit subcolumns that it can easily compute from other returned values.
1386
+ * Query param: Whether to include subcolumns in the report.
1387
+ *
1388
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
1389
+ * compute from other returned values.
1327
1390
  */
1328
1391
  includeSubcolumns?: boolean;
1329
1392
  /**
1330
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
1331
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
1332
- * object names with the object's `name` using colons. Repeat this query parameter
1333
- * to include multiple items. Use only one item filter per request.
1393
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1394
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1395
+ * names with the object's `name` using colons. Accepts one or more item full
1396
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1397
+ * `itemFullNames`.
1334
1398
  */
1335
1399
  itemFullNames?: Array<string>;
1336
1400
  /**
1337
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
1338
- * query parameter to include multiple items. Use only one item filter per request.
1401
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1402
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1403
+ * or `itemFullNames`.
1339
1404
  */
1340
1405
  itemIds?: Array<string>;
1341
1406
  /**
1342
- * Query param: Filter for report data by item type. Use only one item filter per
1343
- * request.
1407
+ * Query param: Filter report rows by item type. Choose only one item filter per
1408
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1344
1409
  */
1345
1410
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1346
1411
  /**
1347
- * Query param: Filter for report data that is posting, non-posting, or either.
1412
+ * Query param: Filter report rows that are posting, non-posting, or either.
1348
1413
  * Posting status refers to whether QuickBooks records the transaction in an
1349
1414
  * account register.
1350
1415
  */
1351
1416
  postingStatus?: 'either' | 'non_posting' | 'posting';
1352
1417
  /**
1353
- * Query param: Filter for report data dated on or after this date, in ISO 8601
1354
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1355
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1356
- * the current fiscal year to date.
1418
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1419
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1420
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1421
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1357
1422
  */
1358
1423
  reportDateFrom?: string;
1359
1424
  /**
1360
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1361
- * with `reportDateFrom` or `reportDateTo`.
1425
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1426
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1362
1427
  */
1363
1428
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1364
1429
  /**
1365
- * Query param: Filter for report data dated on or before this date, in ISO 8601
1366
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1367
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1368
- * the current fiscal year to date.
1430
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1431
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1432
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1433
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1369
1434
  */
1370
1435
  reportDateTo?: string;
1371
1436
  /**
@@ -1374,23 +1439,25 @@ export interface ReportJobParams {
1374
1439
  */
1375
1440
  summarizeColumnsBy?: 'account' | 'balance_sheet' | 'class' | 'customer' | 'customer_type' | 'day' | 'employee' | 'four_week' | 'half_month' | 'income_statement' | 'item_detail' | 'item_type' | 'month' | 'payee' | 'payment_method' | 'payroll_item_detail' | 'payroll_ytd_detail' | 'quarter' | 'sales_representative' | 'sales_tax_code' | 'shipping_method' | 'terms' | 'total_only' | 'two_week' | 'vendor' | 'vendor_type' | 'week' | 'year';
1376
1441
  /**
1377
- * Query param: Filter for report data by transaction type(s). Repeat this query
1378
- * parameter to include multiple transaction types.
1442
+ * Query param: Filter report rows by transaction type. Accepts one or more
1443
+ * transaction types.
1379
1444
  */
1380
1445
  transactionTypes?: Array<'all' | 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment'>;
1381
1446
  /**
1382
- * Query param: Filter for report data updated on or after this date, in ISO 8601
1383
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1447
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1448
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1449
+ * `updatedAfter`/`updatedBefore`.
1384
1450
  */
1385
1451
  updatedAfter?: string;
1386
1452
  /**
1387
- * Query param: Filter for report data updated on or before this date, in ISO 8601
1388
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1453
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1454
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1455
+ * `updatedAfter`/`updatedBefore`.
1389
1456
  */
1390
1457
  updatedBefore?: string;
1391
1458
  /**
1392
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1393
- * combined with `updatedAfter` or `updatedBefore`.
1459
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1460
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1394
1461
  */
1395
1462
  updatedDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1396
1463
  }
@@ -1404,17 +1471,17 @@ export interface ReportPayrollDetailParams {
1404
1471
  */
1405
1472
  conductorEndUserId: string;
1406
1473
  /**
1407
- * Query param: Filter for report data by account `fullName` values,
1408
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1409
- * joining parent object names with the object's `name` using colons. Repeat this
1410
- * query parameter to include multiple accounts. Use only one account filter per
1411
- * request.
1474
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
1475
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
1476
+ * object names with the object's `name` using colons. Accepts one or more account
1477
+ * full names. Choose only one account filter per request: `accountType`,
1478
+ * `accountIds`, or `accountFullNames`.
1412
1479
  */
1413
1480
  accountFullNames?: Array<string>;
1414
1481
  /**
1415
- * Query param: Filter for report data by QuickBooks-assigned account IDs. Repeat
1416
- * this query parameter to include multiple accounts. Use only one account filter
1417
- * per request.
1482
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1483
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1484
+ * `accountIds`, or `accountFullNames`.
1418
1485
  */
1419
1486
  accountIds?: Array<string>;
1420
1487
  /**
@@ -1422,22 +1489,21 @@ export interface ReportPayrollDetailParams {
1422
1489
  */
1423
1490
  accountsToInclude?: 'all' | 'in_use';
1424
1491
  /**
1425
- * Query param: Filter for report data by account type. Use only one account filter
1426
- * per request.
1492
+ * Query param: Filter report rows by account type. Choose only one account filter
1493
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1427
1494
  */
1428
1495
  accountType?: 'accounts_payable' | 'accounts_receivable' | 'allowed_for_1099' | 'ap_and_sales_tax' | 'ap_or_credit_card' | 'ar_and_ap' | 'asset' | 'balance_sheet' | 'bank' | 'bank_and_ar_and_ap_and_uf' | 'bank_and_uf' | 'cost_of_sales' | 'credit_card' | 'current_asset' | 'current_asset_and_expense' | 'current_liability' | 'equity' | 'equity_and_income_and_expense' | 'expense_and_other_expense' | 'fixed_asset' | 'income_and_expense' | 'income_and_other_income' | 'liability' | 'liability_and_equity' | 'long_term_liability' | 'non_posting' | 'ordinary_expense' | 'ordinary_income' | 'ordinary_income_and_cogs' | 'ordinary_income_and_expense' | 'other_asset' | 'other_current_asset' | 'other_current_liability' | 'other_expense' | 'other_income' | 'other_income_or_expense';
1429
1496
  /**
1430
- * Query param: Filter for report data by class `fullName` values,
1431
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1432
- * joining parent object names with the object's `name` using colons. Repeat this
1433
- * query parameter to include multiple classes. Use only one class filter per
1434
- * request.
1497
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1498
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1499
+ * names with the object's `name` using colons. Accepts one or more class full
1500
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1435
1501
  */
1436
1502
  classFullNames?: Array<string>;
1437
1503
  /**
1438
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
1439
- * this query parameter to include multiple classes. Use only one class filter per
1440
- * request.
1504
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1505
+ * more class IDs. Choose only one class filter per request: `classIds` or
1506
+ * `classFullNames`.
1441
1507
  */
1442
1508
  classIds?: Array<string>;
1443
1509
  /**
@@ -1447,46 +1513,50 @@ export interface ReportPayrollDetailParams {
1447
1513
  */
1448
1514
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1449
1515
  /**
1450
- * Query param: Filter for report data by entity `fullName` values,
1451
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1452
- * joining parent object names with the object's `name` using colons. Repeat this
1453
- * query parameter to include multiple entities. Use only one entity filter per
1454
- * request.
1516
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1517
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1518
+ * names with the object's `name` using colons. Accepts one or more entity full
1519
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1520
+ * `entityFullNames`.
1455
1521
  */
1456
1522
  entityFullNames?: Array<string>;
1457
1523
  /**
1458
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
1459
- * this query parameter to include multiple entities. Use only one entity filter
1460
- * per request.
1524
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1525
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1526
+ * `entityIds`, or `entityFullNames`.
1461
1527
  */
1462
1528
  entityIds?: Array<string>;
1463
1529
  /**
1464
- * Query param: Filter for report data by entity type, such as customer, vendor,
1465
- * employee, or other name. Use only one entity filter per request.
1530
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1531
+ * employee, or other name. Choose only one entity filter per request:
1532
+ * `entityType`, `entityIds`, or `entityFullNames`.
1466
1533
  */
1467
1534
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1468
1535
  /**
1469
- * Query param: The specific report columns to include, by column type. Repeat this
1470
- * query parameter to request multiple columns. When this parameter is present,
1471
- * QuickBooks Desktop omits its default report columns unless you include them
1472
- * here.
1536
+ * Query param: The report columns to include, by column type. Accepts one or more
1537
+ * columns.
1538
+ *
1539
+ * **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
1540
+ * default report columns unless you include them here.
1473
1541
  */
1474
1542
  includeColumns?: Array<'account' | 'aging' | 'amount' | 'amount_difference' | 'average_cost' | 'billed_date' | 'billing_status' | 'calculated_amount' | 'class' | 'cleared_status' | 'cost_price' | 'credit' | 'currency' | 'date' | 'debit' | 'delivery_date' | 'due_date' | 'estimate_active' | 'exchange_rate' | 'shipment_origin' | 'income_subject_to_tax' | 'invoiced' | 'item' | 'description' | 'last_modified_by' | 'latest_or_prior_state' | 'memo' | 'updated_at' | 'name' | 'name_account_number' | 'name_address' | 'name_city' | 'name_contact' | 'name_email' | 'name_fax' | 'name_phone' | 'name_state' | 'name_postal_code' | 'open_balance' | 'original_amount' | 'paid_amount' | 'paid_status' | 'paid_through_date' | 'payment_method' | 'payroll_item' | 'purchase_order_number' | 'print_status' | 'progress_amount' | 'progress_percent' | 'quantity' | 'quantity_available' | 'quantity_on_hand' | 'quantity_on_sales_order' | 'received_quantity' | 'ref_number' | 'running_balance' | 'sales_representative' | 'sales_tax_code' | 'serial_or_lot_number' | 'shipping_date' | 'shipping_method' | 'source_name' | 'split_account' | 'ssn_or_tax_identification_number' | 'tax_line' | 'tax_table_version' | 'terms' | 'transaction_id' | 'transaction_number' | 'transaction_type' | 'unit_price' | 'user_edit' | 'value_on_hand' | 'wage_base' | 'wage_base_tips'>;
1475
1543
  /**
1476
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
1477
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
1478
- * object names with the object's `name` using colons. Repeat this query parameter
1479
- * to include multiple items. Use only one item filter per request.
1544
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1545
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1546
+ * names with the object's `name` using colons. Accepts one or more item full
1547
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1548
+ * `itemFullNames`.
1480
1549
  */
1481
1550
  itemFullNames?: Array<string>;
1482
1551
  /**
1483
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
1484
- * query parameter to include multiple items. Use only one item filter per request.
1552
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1553
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1554
+ * or `itemFullNames`.
1485
1555
  */
1486
1556
  itemIds?: Array<string>;
1487
1557
  /**
1488
- * Query param: Filter for report data by item type. Use only one item filter per
1489
- * request.
1558
+ * Query param: Filter report rows by item type. Choose only one item filter per
1559
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1490
1560
  */
1491
1561
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1492
1562
  /**
@@ -1495,28 +1565,28 @@ export interface ReportPayrollDetailParams {
1495
1565
  */
1496
1566
  openBalanceAsOf?: 'report_end_date' | 'today';
1497
1567
  /**
1498
- * Query param: Filter for report data that is posting, non-posting, or either.
1568
+ * Query param: Filter report rows that are posting, non-posting, or either.
1499
1569
  * Posting status refers to whether QuickBooks records the transaction in an
1500
1570
  * account register.
1501
1571
  */
1502
1572
  postingStatus?: 'either' | 'non_posting' | 'posting';
1503
1573
  /**
1504
- * Query param: Filter for report data dated on or after this date, in ISO 8601
1505
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1506
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1507
- * the current fiscal year to date.
1574
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1575
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1576
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1577
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1508
1578
  */
1509
1579
  reportDateFrom?: string;
1510
1580
  /**
1511
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1512
- * with `reportDateFrom` or `reportDateTo`.
1581
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1582
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1513
1583
  */
1514
1584
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1515
1585
  /**
1516
- * Query param: Filter for report data dated on or before this date, in ISO 8601
1517
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1518
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1519
- * the current fiscal year to date.
1586
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1587
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1588
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1589
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1520
1590
  */
1521
1591
  reportDateTo?: string;
1522
1592
  /**
@@ -1525,18 +1595,20 @@ export interface ReportPayrollDetailParams {
1525
1595
  */
1526
1596
  summarizeRowsBy?: 'account' | 'balance_sheet' | 'class' | 'customer' | 'customer_type' | 'day' | 'employee' | 'four_week' | 'half_month' | 'income_statement' | 'item_detail' | 'item_type' | 'month' | 'payee' | 'payment_method' | 'payroll_item_detail' | 'payroll_ytd_detail' | 'quarter' | 'sales_representative' | 'sales_tax_code' | 'shipping_method' | 'tax_line' | 'terms' | 'total_only' | 'two_week' | 'vendor' | 'vendor_type' | 'week' | 'year';
1527
1597
  /**
1528
- * Query param: Filter for report data updated on or after this date, in ISO 8601
1529
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1598
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1599
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1600
+ * `updatedAfter`/`updatedBefore`.
1530
1601
  */
1531
1602
  updatedAfter?: string;
1532
1603
  /**
1533
- * Query param: Filter for report data updated on or before this date, in ISO 8601
1534
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1604
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1605
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1606
+ * `updatedAfter`/`updatedBefore`.
1535
1607
  */
1536
1608
  updatedBefore?: string;
1537
1609
  /**
1538
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1539
- * combined with `updatedAfter` or `updatedBefore`.
1610
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1611
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1540
1612
  */
1541
1613
  updatedDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1542
1614
  }
@@ -1550,36 +1622,35 @@ export interface ReportPayrollSummaryParams {
1550
1622
  */
1551
1623
  conductorEndUserId: string;
1552
1624
  /**
1553
- * Query param: Filter for report data by account `fullName` values,
1554
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1555
- * joining parent object names with the object's `name` using colons. Repeat this
1556
- * query parameter to include multiple accounts. Use only one account filter per
1557
- * request.
1625
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
1626
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
1627
+ * object names with the object's `name` using colons. Accepts one or more account
1628
+ * full names. Choose only one account filter per request: `accountType`,
1629
+ * `accountIds`, or `accountFullNames`.
1558
1630
  */
1559
1631
  accountFullNames?: Array<string>;
1560
1632
  /**
1561
- * Query param: Filter for report data by QuickBooks-assigned account IDs. Repeat
1562
- * this query parameter to include multiple accounts. Use only one account filter
1563
- * per request.
1633
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1634
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1635
+ * `accountIds`, or `accountFullNames`.
1564
1636
  */
1565
1637
  accountIds?: Array<string>;
1566
1638
  /**
1567
- * Query param: Filter for report data by account type. Use only one account filter
1568
- * per request.
1639
+ * Query param: Filter report rows by account type. Choose only one account filter
1640
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1569
1641
  */
1570
1642
  accountType?: 'accounts_payable' | 'accounts_receivable' | 'allowed_for_1099' | 'ap_and_sales_tax' | 'ap_or_credit_card' | 'ar_and_ap' | 'asset' | 'balance_sheet' | 'bank' | 'bank_and_ar_and_ap_and_uf' | 'bank_and_uf' | 'cost_of_sales' | 'credit_card' | 'current_asset' | 'current_asset_and_expense' | 'current_liability' | 'equity' | 'equity_and_income_and_expense' | 'expense_and_other_expense' | 'fixed_asset' | 'income_and_expense' | 'income_and_other_income' | 'liability' | 'liability_and_equity' | 'long_term_liability' | 'non_posting' | 'ordinary_expense' | 'ordinary_income' | 'ordinary_income_and_cogs' | 'ordinary_income_and_expense' | 'other_asset' | 'other_current_asset' | 'other_current_liability' | 'other_expense' | 'other_income' | 'other_income_or_expense';
1571
1643
  /**
1572
- * Query param: Filter for report data by class `fullName` values,
1573
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1574
- * joining parent object names with the object's `name` using colons. Repeat this
1575
- * query parameter to include multiple classes. Use only one class filter per
1576
- * request.
1644
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1645
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1646
+ * names with the object's `name` using colons. Accepts one or more class full
1647
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1577
1648
  */
1578
1649
  classFullNames?: Array<string>;
1579
1650
  /**
1580
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
1581
- * this query parameter to include multiple classes. Use only one class filter per
1582
- * request.
1651
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1652
+ * more class IDs. Choose only one class filter per request: `classIds` or
1653
+ * `classFullNames`.
1583
1654
  */
1584
1655
  classIds?: Array<string>;
1585
1656
  /**
@@ -1595,48 +1666,53 @@ export interface ReportPayrollSummaryParams {
1595
1666
  */
1596
1667
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1597
1668
  /**
1598
- * Query param: Filter for report data by entity `fullName` values,
1599
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1600
- * joining parent object names with the object's `name` using colons. Repeat this
1601
- * query parameter to include multiple entities. Use only one entity filter per
1602
- * request.
1669
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1670
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1671
+ * names with the object's `name` using colons. Accepts one or more entity full
1672
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1673
+ * `entityFullNames`.
1603
1674
  */
1604
1675
  entityFullNames?: Array<string>;
1605
1676
  /**
1606
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
1607
- * this query parameter to include multiple entities. Use only one entity filter
1608
- * per request.
1677
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1678
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1679
+ * `entityIds`, or `entityFullNames`.
1609
1680
  */
1610
1681
  entityIds?: Array<string>;
1611
1682
  /**
1612
- * Query param: Filter for report data by entity type, such as customer, vendor,
1613
- * employee, or other name. Use only one entity filter per request.
1683
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1684
+ * employee, or other name. Choose only one entity filter per request:
1685
+ * `entityType`, `entityIds`, or `entityFullNames`.
1614
1686
  */
1615
1687
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1616
1688
  /**
1617
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1618
- * still omit subcolumns that it can easily compute from other returned values.
1689
+ * Query param: Whether to include subcolumns in the report.
1690
+ *
1691
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
1692
+ * compute from other returned values.
1619
1693
  */
1620
1694
  includeSubcolumns?: boolean;
1621
1695
  /**
1622
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
1623
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
1624
- * object names with the object's `name` using colons. Repeat this query parameter
1625
- * to include multiple items. Use only one item filter per request.
1696
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1697
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1698
+ * names with the object's `name` using colons. Accepts one or more item full
1699
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1700
+ * `itemFullNames`.
1626
1701
  */
1627
1702
  itemFullNames?: Array<string>;
1628
1703
  /**
1629
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
1630
- * query parameter to include multiple items. Use only one item filter per request.
1704
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1705
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1706
+ * or `itemFullNames`.
1631
1707
  */
1632
1708
  itemIds?: Array<string>;
1633
1709
  /**
1634
- * Query param: Filter for report data by item type. Use only one item filter per
1635
- * request.
1710
+ * Query param: Filter report rows by item type. Choose only one item filter per
1711
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1636
1712
  */
1637
1713
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1638
1714
  /**
1639
- * Query param: Filter for report data that is posting, non-posting, or either.
1715
+ * Query param: Filter report rows that are posting, non-posting, or either.
1640
1716
  * Posting status refers to whether QuickBooks records the transaction in an
1641
1717
  * account register.
1642
1718
  */
@@ -1646,22 +1722,22 @@ export interface ReportPayrollSummaryParams {
1646
1722
  */
1647
1723
  reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1648
1724
  /**
1649
- * Query param: Filter for report data dated on or after this date, in ISO 8601
1650
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1651
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1652
- * the current fiscal year to date.
1725
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1726
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1727
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1728
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1653
1729
  */
1654
1730
  reportDateFrom?: string;
1655
1731
  /**
1656
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1657
- * with `reportDateFrom` or `reportDateTo`.
1732
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1733
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1658
1734
  */
1659
1735
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1660
1736
  /**
1661
- * Query param: Filter for report data dated on or before this date, in ISO 8601
1662
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1663
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1664
- * the current fiscal year to date.
1737
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1738
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1739
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1740
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1665
1741
  */
1666
1742
  reportDateTo?: string;
1667
1743
  /**
@@ -1675,18 +1751,20 @@ export interface ReportPayrollSummaryParams {
1675
1751
  */
1676
1752
  summarizeColumnsBy?: 'account' | 'balance_sheet' | 'class' | 'customer' | 'customer_type' | 'day' | 'employee' | 'four_week' | 'half_month' | 'income_statement' | 'item_detail' | 'item_type' | 'month' | 'payee' | 'payment_method' | 'payroll_item_detail' | 'payroll_ytd_detail' | 'quarter' | 'sales_representative' | 'sales_tax_code' | 'shipping_method' | 'terms' | 'total_only' | 'two_week' | 'vendor' | 'vendor_type' | 'week' | 'year';
1677
1753
  /**
1678
- * Query param: Filter for report data updated on or after this date, in ISO 8601
1679
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1754
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1755
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1756
+ * `updatedAfter`/`updatedBefore`.
1680
1757
  */
1681
1758
  updatedAfter?: string;
1682
1759
  /**
1683
- * Query param: Filter for report data updated on or before this date, in ISO 8601
1684
- * format (YYYY-MM-DD). This cannot be combined with `updatedDateMacro`.
1760
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1761
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1762
+ * `updatedAfter`/`updatedBefore`.
1685
1763
  */
1686
1764
  updatedBefore?: string;
1687
1765
  /**
1688
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1689
- * combined with `updatedAfter` or `updatedBefore`.
1766
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1767
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1690
1768
  */
1691
1769
  updatedDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1692
1770
  }
@@ -1700,17 +1778,16 @@ export interface ReportTimeParams {
1700
1778
  */
1701
1779
  conductorEndUserId: string;
1702
1780
  /**
1703
- * Query param: Filter for report data by class `fullName` values,
1704
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1705
- * joining parent object names with the object's `name` using colons. Repeat this
1706
- * query parameter to include multiple classes. Use only one class filter per
1707
- * request.
1781
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1782
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1783
+ * names with the object's `name` using colons. Accepts one or more class full
1784
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1708
1785
  */
1709
1786
  classFullNames?: Array<string>;
1710
1787
  /**
1711
- * Query param: Filter for report data by QuickBooks-assigned class IDs. Repeat
1712
- * this query parameter to include multiple classes. Use only one class filter per
1713
- * request.
1788
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1789
+ * more class IDs. Choose only one class filter per request: `classIds` or
1790
+ * `classFullNames`.
1714
1791
  */
1715
1792
  classIds?: Array<string>;
1716
1793
  /**
@@ -1720,44 +1797,49 @@ export interface ReportTimeParams {
1720
1797
  */
1721
1798
  columnsToReturn?: 'active_only' | 'non_zero' | 'all';
1722
1799
  /**
1723
- * Query param: Filter for report data by entity `fullName` values,
1724
- * case-insensitive. A `fullName` is a fully-qualified QuickBooks name formed by
1725
- * joining parent object names with the object's `name` using colons. Repeat this
1726
- * query parameter to include multiple entities. Use only one entity filter per
1727
- * request.
1800
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1801
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1802
+ * names with the object's `name` using colons. Accepts one or more entity full
1803
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1804
+ * `entityFullNames`.
1728
1805
  */
1729
1806
  entityFullNames?: Array<string>;
1730
1807
  /**
1731
- * Query param: Filter for report data by QuickBooks-assigned entity IDs. Repeat
1732
- * this query parameter to include multiple entities. Use only one entity filter
1733
- * per request.
1808
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1809
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1810
+ * `entityIds`, or `entityFullNames`.
1734
1811
  */
1735
1812
  entityIds?: Array<string>;
1736
1813
  /**
1737
- * Query param: Filter for report data by entity type, such as customer, vendor,
1738
- * employee, or other name. Use only one entity filter per request.
1814
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1815
+ * employee, or other name. Choose only one entity filter per request:
1816
+ * `entityType`, `entityIds`, or `entityFullNames`.
1739
1817
  */
1740
1818
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1741
1819
  /**
1742
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1743
- * still omit subcolumns that it can easily compute from other returned values.
1820
+ * Query param: Whether to include subcolumns in the report.
1821
+ *
1822
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
1823
+ * compute from other returned values.
1744
1824
  */
1745
1825
  includeSubcolumns?: boolean;
1746
1826
  /**
1747
- * Query param: Filter for report data by item `fullName` values, case-insensitive.
1748
- * A `fullName` is a fully-qualified QuickBooks name formed by joining parent
1749
- * object names with the object's `name` using colons. Repeat this query parameter
1750
- * to include multiple items. Use only one item filter per request.
1827
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1828
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1829
+ * names with the object's `name` using colons. Accepts one or more item full
1830
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1831
+ * `itemFullNames`.
1751
1832
  */
1752
1833
  itemFullNames?: Array<string>;
1753
1834
  /**
1754
- * Query param: Filter for report data by QuickBooks-assigned item IDs. Repeat this
1755
- * query parameter to include multiple items. Use only one item filter per request.
1835
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1836
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1837
+ * or `itemFullNames`.
1756
1838
  */
1757
1839
  itemIds?: Array<string>;
1758
1840
  /**
1759
- * Query param: Filter for report data by item type. Use only one item filter per
1760
- * request.
1841
+ * Query param: Filter report rows by item type. Choose only one item filter per
1842
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1761
1843
  */
1762
1844
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1763
1845
  /**
@@ -1765,22 +1847,22 @@ export interface ReportTimeParams {
1765
1847
  */
1766
1848
  reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1767
1849
  /**
1768
- * Query param: Filter for report data dated on or after this date, in ISO 8601
1769
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1770
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1771
- * the current fiscal year to date.
1850
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1851
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1852
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1853
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1772
1854
  */
1773
1855
  reportDateFrom?: string;
1774
1856
  /**
1775
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1776
- * with `reportDateFrom` or `reportDateTo`.
1857
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1858
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1777
1859
  */
1778
1860
  reportDateMacro?: 'all' | 'today' | 'this_week' | 'this_week_to_date' | 'this_month' | 'this_month_to_date' | 'this_quarter' | 'this_quarter_to_date' | 'this_year' | 'this_year_to_date' | 'yesterday' | 'last_week' | 'last_week_to_date' | 'last_month' | 'last_month_to_date' | 'last_quarter' | 'last_quarter_to_date' | 'last_year' | 'last_year_to_date' | 'next_week' | 'next_four_weeks' | 'next_month' | 'next_quarter' | 'next_year';
1779
1861
  /**
1780
- * Query param: Filter for report data dated on or before this date, in ISO 8601
1781
- * format (YYYY-MM-DD). This cannot be combined with `reportDateMacro`. If you omit
1782
- * `reportDateFrom`, `reportDateTo`, and `reportDateMacro`, QuickBooks Desktop uses
1783
- * the current fiscal year to date.
1862
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1863
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1864
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1865
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1784
1866
  */
1785
1867
  reportDateTo?: string;
1786
1868
  /**