conductor-node 14.13.0 → 14.14.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.
@@ -406,17 +406,17 @@ export interface ReportAgingParams {
406
406
  */
407
407
  conductorEndUserId: string;
408
408
  /**
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.
409
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
410
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
411
+ * object names with the object's `name` using colons. Accepts one or more account
412
+ * full names. Choose only one account filter per request: `accountType`,
413
+ * `accountIds`, or `accountFullNames`.
414
414
  */
415
415
  accountFullNames?: Array<string>;
416
416
  /**
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.
417
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
418
+ * or more account IDs. Choose only one account filter per request: `accountType`,
419
+ * `accountIds`, or `accountFullNames`.
420
420
  */
421
421
  accountIds?: Array<string>;
422
422
  /**
@@ -424,8 +424,8 @@ export interface ReportAgingParams {
424
424
  */
425
425
  accountsToInclude?: 'all' | 'in_use';
426
426
  /**
427
- * Query param: Filter for report data by account type. Use only one account filter
428
- * per request.
427
+ * Query param: Filter report rows by account type. Choose only one account filter
428
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
429
429
  */
430
430
  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
431
  /**
@@ -434,17 +434,16 @@ export interface ReportAgingParams {
434
434
  */
435
435
  agingAsOf?: 'report_end_date' | 'today';
436
436
  /**
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.
437
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
438
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
439
+ * names with the object's `name` using colons. Accepts one or more class full
440
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
442
441
  */
443
442
  classFullNames?: Array<string>;
444
443
  /**
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.
444
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
445
+ * more class IDs. Choose only one class filter per request: `classIds` or
446
+ * `classFullNames`.
448
447
  */
449
448
  classIds?: Array<string>;
450
449
  /**
@@ -454,91 +453,95 @@ export interface ReportAgingParams {
454
453
  */
455
454
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
456
455
  /**
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.
456
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
457
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
458
+ * names with the object's `name` using colons. Accepts one or more entity full
459
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
460
+ * `entityFullNames`.
462
461
  */
463
462
  entityFullNames?: Array<string>;
464
463
  /**
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.
464
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
465
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
466
+ * `entityIds`, or `entityFullNames`.
468
467
  */
469
468
  entityIds?: Array<string>;
470
469
  /**
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.
470
+ * Query param: Filter report rows by entity type, such as customer, vendor,
471
+ * employee, or other name. Choose only one entity filter per request:
472
+ * `entityType`, `entityIds`, or `entityFullNames`.
473
473
  */
474
474
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
475
475
  /**
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.
476
+ * Query param: The report columns to include, by column type. Accepts one or more
477
+ * columns. When this parameter is present, QuickBooks Desktop omits its default
478
+ * report columns unless you include them here.
480
479
  */
481
480
  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
481
  /**
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.
482
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
483
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
484
+ * names with the object's `name` using colons. Accepts one or more item full
485
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
486
+ * `itemFullNames`.
487
487
  */
488
488
  itemFullNames?: Array<string>;
489
489
  /**
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.
490
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
491
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
492
+ * or `itemFullNames`.
492
493
  */
493
494
  itemIds?: Array<string>;
494
495
  /**
495
- * Query param: Filter for report data by item type. Use only one item filter per
496
- * request.
496
+ * Query param: Filter report rows by item type. Choose only one item filter per
497
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
497
498
  */
498
499
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
499
500
  /**
500
- * Query param: Filter for report data that is posting, non-posting, or either.
501
+ * Query param: Filter report rows that are posting, non-posting, or either.
501
502
  * Posting status refers to whether QuickBooks records the transaction in an
502
503
  * account register.
503
504
  */
504
505
  postingStatus?: 'either' | 'non_posting' | 'posting';
505
506
  /**
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.
507
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
508
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
509
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
510
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
510
511
  */
511
512
  reportDateFrom?: string;
512
513
  /**
513
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
514
- * with `reportDateFrom` or `reportDateTo`.
514
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
515
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
515
516
  */
516
517
  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
518
  /**
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.
519
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
520
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
521
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
522
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
522
523
  */
523
524
  reportDateTo?: string;
524
525
  /**
525
- * Query param: Filter for report data by transaction type(s). Repeat this query
526
- * parameter to include multiple transaction types.
526
+ * Query param: Filter report rows by transaction type. Accepts one or more
527
+ * transaction types.
527
528
  */
528
529
  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
530
  /**
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`.
531
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
532
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
533
+ * `updatedAfter`/`updatedBefore`.
532
534
  */
533
535
  updatedAfter?: string;
534
536
  /**
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`.
537
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
538
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
539
+ * `updatedAfter`/`updatedBefore`.
537
540
  */
538
541
  updatedBefore?: string;
539
542
  /**
540
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
541
- * combined with `updatedAfter` or `updatedBefore`.
543
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
544
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
542
545
  */
543
546
  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
547
  }
@@ -563,36 +566,35 @@ export interface ReportBudgetSummaryParams {
563
566
  */
564
567
  budgetCriterion?: 'accounts' | 'accounts_and_classes' | 'accounts_and_customers';
565
568
  /**
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.
569
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
570
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
571
+ * names with the object's `name` using colons. Accepts one or more class full
572
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
571
573
  */
572
574
  classFullNames?: Array<string>;
573
575
  /**
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.
576
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
577
+ * more class IDs. Choose only one class filter per request: `classIds` or
578
+ * `classFullNames`.
577
579
  */
578
580
  classIds?: Array<string>;
579
581
  /**
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.
582
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
583
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
584
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
585
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
584
586
  */
585
587
  reportDateFrom?: string;
586
588
  /**
587
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
588
- * with `reportDateFrom` or `reportDateTo`.
589
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
590
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
589
591
  */
590
592
  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
593
  /**
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.
594
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
595
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
596
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
597
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
596
598
  */
597
599
  reportDateTo?: string;
598
600
  /**
@@ -607,10 +609,9 @@ export interface ReportBudgetSummaryParams {
607
609
  }
608
610
  export interface ReportCustomDetailParams {
609
611
  /**
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.
612
+ * Query param: The report columns to include, by column type. Accepts one or more
613
+ * columns. When this parameter is present, QuickBooks Desktop omits its default
614
+ * report columns unless you include them here.
614
615
  */
615
616
  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
617
  /**
@@ -623,17 +624,17 @@ export interface ReportCustomDetailParams {
623
624
  */
624
625
  conductorEndUserId: string;
625
626
  /**
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.
627
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
628
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
629
+ * object names with the object's `name` using colons. Accepts one or more account
630
+ * full names. Choose only one account filter per request: `accountType`,
631
+ * `accountIds`, or `accountFullNames`.
631
632
  */
632
633
  accountFullNames?: Array<string>;
633
634
  /**
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.
635
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
636
+ * or more account IDs. Choose only one account filter per request: `accountType`,
637
+ * `accountIds`, or `accountFullNames`.
637
638
  */
638
639
  accountIds?: Array<string>;
639
640
  /**
@@ -641,8 +642,8 @@ export interface ReportCustomDetailParams {
641
642
  */
642
643
  accountsToInclude?: 'all' | 'in_use';
643
644
  /**
644
- * Query param: Filter for report data by account type. Use only one account filter
645
- * per request.
645
+ * Query param: Filter report rows by account type. Choose only one account filter
646
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
646
647
  */
647
648
  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
649
  /**
@@ -653,17 +654,16 @@ export interface ReportCustomDetailParams {
653
654
  */
654
655
  basis?: 'accrual' | 'cash' | 'none';
655
656
  /**
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.
657
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
658
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
659
+ * names with the object's `name` using colons. Accepts one or more class full
660
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
661
661
  */
662
662
  classFullNames?: Array<string>;
663
663
  /**
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.
664
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
665
+ * more class IDs. Choose only one class filter per request: `classIds` or
666
+ * `classFullNames`.
667
667
  */
668
668
  classIds?: Array<string>;
669
669
  /**
@@ -673,39 +673,42 @@ export interface ReportCustomDetailParams {
673
673
  */
674
674
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
675
675
  /**
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.
676
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
677
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
678
+ * names with the object's `name` using colons. Accepts one or more entity full
679
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
680
+ * `entityFullNames`.
681
681
  */
682
682
  entityFullNames?: Array<string>;
683
683
  /**
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.
684
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
685
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
686
+ * `entityIds`, or `entityFullNames`.
687
687
  */
688
688
  entityIds?: Array<string>;
689
689
  /**
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.
690
+ * Query param: Filter report rows by entity type, such as customer, vendor,
691
+ * employee, or other name. Choose only one entity filter per request:
692
+ * `entityType`, `entityIds`, or `entityFullNames`.
692
693
  */
693
694
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
694
695
  /**
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.
696
+ * Query param: Filter report rows by item `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 item full
699
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
700
+ * `itemFullNames`.
699
701
  */
700
702
  itemFullNames?: Array<string>;
701
703
  /**
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.
704
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
705
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
706
+ * or `itemFullNames`.
704
707
  */
705
708
  itemIds?: Array<string>;
706
709
  /**
707
- * Query param: Filter for report data by item type. Use only one item filter per
708
- * request.
710
+ * Query param: Filter report rows by item type. Choose only one item filter per
711
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
709
712
  */
710
713
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
711
714
  /**
@@ -714,28 +717,28 @@ export interface ReportCustomDetailParams {
714
717
  */
715
718
  openBalanceAsOf?: 'report_end_date' | 'today';
716
719
  /**
717
- * Query param: Filter for report data that is posting, non-posting, or either.
720
+ * Query param: Filter report rows that are posting, non-posting, or either.
718
721
  * Posting status refers to whether QuickBooks records the transaction in an
719
722
  * account register.
720
723
  */
721
724
  postingStatus?: 'either' | 'non_posting' | 'posting';
722
725
  /**
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.
726
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
727
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
728
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
729
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
727
730
  */
728
731
  reportDateFrom?: string;
729
732
  /**
730
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
731
- * with `reportDateFrom` or `reportDateTo`.
733
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
734
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
732
735
  */
733
736
  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
737
  /**
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.
738
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
739
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
740
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
741
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
739
742
  */
740
743
  reportDateTo?: string;
741
744
  /**
@@ -745,23 +748,25 @@ export interface ReportCustomDetailParams {
745
748
  */
746
749
  reportType?: 'custom_transaction_detail';
747
750
  /**
748
- * Query param: Filter for report data by transaction type(s). Repeat this query
749
- * parameter to include multiple transaction types.
751
+ * Query param: Filter report rows by transaction type. Accepts one or more
752
+ * transaction types.
750
753
  */
751
754
  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
755
  /**
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`.
756
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
757
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
758
+ * `updatedAfter`/`updatedBefore`.
755
759
  */
756
760
  updatedAfter?: string;
757
761
  /**
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`.
762
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
763
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
764
+ * `updatedAfter`/`updatedBefore`.
760
765
  */
761
766
  updatedBefore?: string;
762
767
  /**
763
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
764
- * combined with `updatedAfter` or `updatedBefore`.
768
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
769
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
765
770
  */
766
771
  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
772
  }
@@ -781,22 +786,22 @@ export interface ReportCustomSummaryParams {
781
786
  */
782
787
  conductorEndUserId: string;
783
788
  /**
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.
789
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
790
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
791
+ * object names with the object's `name` using colons. Accepts one or more account
792
+ * full names. Choose only one account filter per request: `accountType`,
793
+ * `accountIds`, or `accountFullNames`.
789
794
  */
790
795
  accountFullNames?: Array<string>;
791
796
  /**
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.
797
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
798
+ * or more account IDs. Choose only one account filter per request: `accountType`,
799
+ * `accountIds`, or `accountFullNames`.
795
800
  */
796
801
  accountIds?: Array<string>;
797
802
  /**
798
- * Query param: Filter for report data by account type. Use only one account filter
799
- * per request.
803
+ * Query param: Filter report rows by account type. Choose only one account filter
804
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
800
805
  */
801
806
  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
807
  /**
@@ -807,17 +812,16 @@ export interface ReportCustomSummaryParams {
807
812
  */
808
813
  basis?: 'accrual' | 'cash' | 'none';
809
814
  /**
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.
815
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
816
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
817
+ * names with the object's `name` using colons. Accepts one or more class full
818
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
815
819
  */
816
820
  classFullNames?: Array<string>;
817
821
  /**
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.
822
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
823
+ * more class IDs. Choose only one class filter per request: `classIds` or
824
+ * `classFullNames`.
821
825
  */
822
826
  classIds?: Array<string>;
823
827
  /**
@@ -833,22 +837,23 @@ export interface ReportCustomSummaryParams {
833
837
  */
834
838
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
835
839
  /**
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.
840
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
841
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
842
+ * names with the object's `name` using colons. Accepts one or more entity full
843
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
844
+ * `entityFullNames`.
841
845
  */
842
846
  entityFullNames?: Array<string>;
843
847
  /**
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.
848
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
849
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
850
+ * `entityIds`, or `entityFullNames`.
847
851
  */
848
852
  entityIds?: Array<string>;
849
853
  /**
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.
854
+ * Query param: Filter report rows by entity type, such as customer, vendor,
855
+ * employee, or other name. Choose only one entity filter per request:
856
+ * `entityType`, `entityIds`, or `entityFullNames`.
852
857
  */
853
858
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
854
859
  /**
@@ -857,24 +862,26 @@ export interface ReportCustomSummaryParams {
857
862
  */
858
863
  includeSubcolumns?: boolean;
859
864
  /**
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.
865
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
866
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
867
+ * names with the object's `name` using colons. Accepts one or more item full
868
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
869
+ * `itemFullNames`.
864
870
  */
865
871
  itemFullNames?: Array<string>;
866
872
  /**
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.
873
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
874
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
875
+ * or `itemFullNames`.
869
876
  */
870
877
  itemIds?: Array<string>;
871
878
  /**
872
- * Query param: Filter for report data by item type. Use only one item filter per
873
- * request.
879
+ * Query param: Filter report rows by item type. Choose only one item filter per
880
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
874
881
  */
875
882
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
876
883
  /**
877
- * Query param: Filter for report data that is posting, non-posting, or either.
884
+ * Query param: Filter report rows that are posting, non-posting, or either.
878
885
  * Posting status refers to whether QuickBooks records the transaction in an
879
886
  * account register.
880
887
  */
@@ -884,22 +891,22 @@ export interface ReportCustomSummaryParams {
884
891
  */
885
892
  reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
886
893
  /**
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.
894
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
895
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
896
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
897
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
891
898
  */
892
899
  reportDateFrom?: string;
893
900
  /**
894
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
895
- * with `reportDateFrom` or `reportDateTo`.
901
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
902
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
896
903
  */
897
904
  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
905
  /**
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.
906
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
907
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
908
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
909
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
903
910
  */
904
911
  reportDateTo?: string;
905
912
  /**
@@ -914,23 +921,25 @@ export interface ReportCustomSummaryParams {
914
921
  */
915
922
  rowsToReturn?: 'active_only' | 'non_zero' | 'all';
916
923
  /**
917
- * Query param: Filter for report data by transaction type(s). Repeat this query
918
- * parameter to include multiple transaction types.
924
+ * Query param: Filter report rows by transaction type. Accepts one or more
925
+ * transaction types.
919
926
  */
920
927
  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
928
  /**
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`.
929
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
930
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
931
+ * `updatedAfter`/`updatedBefore`.
924
932
  */
925
933
  updatedAfter?: string;
926
934
  /**
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`.
935
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
936
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
937
+ * `updatedAfter`/`updatedBefore`.
929
938
  */
930
939
  updatedBefore?: string;
931
940
  /**
932
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
933
- * combined with `updatedAfter` or `updatedBefore`.
941
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
942
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
934
943
  */
935
944
  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
945
  }
@@ -944,17 +953,17 @@ export interface ReportGeneralDetailParams {
944
953
  */
945
954
  conductorEndUserId: string;
946
955
  /**
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.
956
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
957
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
958
+ * object names with the object's `name` using colons. Accepts one or more account
959
+ * full names. Choose only one account filter per request: `accountType`,
960
+ * `accountIds`, or `accountFullNames`.
952
961
  */
953
962
  accountFullNames?: Array<string>;
954
963
  /**
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.
964
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
965
+ * or more account IDs. Choose only one account filter per request: `accountType`,
966
+ * `accountIds`, or `accountFullNames`.
958
967
  */
959
968
  accountIds?: Array<string>;
960
969
  /**
@@ -962,8 +971,8 @@ export interface ReportGeneralDetailParams {
962
971
  */
963
972
  accountsToInclude?: 'all' | 'in_use';
964
973
  /**
965
- * Query param: Filter for report data by account type. Use only one account filter
966
- * per request.
974
+ * Query param: Filter report rows by account type. Choose only one account filter
975
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
967
976
  */
968
977
  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
978
  /**
@@ -974,17 +983,16 @@ export interface ReportGeneralDetailParams {
974
983
  */
975
984
  basis?: 'accrual' | 'cash' | 'none';
976
985
  /**
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.
986
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
987
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
988
+ * names with the object's `name` using colons. Accepts one or more class full
989
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
982
990
  */
983
991
  classFullNames?: Array<string>;
984
992
  /**
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.
993
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
994
+ * more class IDs. Choose only one class filter per request: `classIds` or
995
+ * `classFullNames`.
988
996
  */
989
997
  classIds?: Array<string>;
990
998
  /**
@@ -994,46 +1002,48 @@ export interface ReportGeneralDetailParams {
994
1002
  */
995
1003
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
996
1004
  /**
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.
1005
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1006
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1007
+ * names with the object's `name` using colons. Accepts one or more entity full
1008
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1009
+ * `entityFullNames`.
1002
1010
  */
1003
1011
  entityFullNames?: Array<string>;
1004
1012
  /**
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.
1013
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1014
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1015
+ * `entityIds`, or `entityFullNames`.
1008
1016
  */
1009
1017
  entityIds?: Array<string>;
1010
1018
  /**
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.
1019
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1020
+ * employee, or other name. Choose only one entity filter per request:
1021
+ * `entityType`, `entityIds`, or `entityFullNames`.
1013
1022
  */
1014
1023
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1015
1024
  /**
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.
1025
+ * Query param: The report columns to include, by column type. Accepts one or more
1026
+ * columns. When this parameter is present, QuickBooks Desktop omits its default
1027
+ * report columns unless you include them here.
1020
1028
  */
1021
1029
  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
1030
  /**
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.
1031
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1032
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1033
+ * names with the object's `name` using colons. Accepts one or more item full
1034
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1035
+ * `itemFullNames`.
1027
1036
  */
1028
1037
  itemFullNames?: Array<string>;
1029
1038
  /**
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.
1039
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1040
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1041
+ * or `itemFullNames`.
1032
1042
  */
1033
1043
  itemIds?: Array<string>;
1034
1044
  /**
1035
- * Query param: Filter for report data by item type. Use only one item filter per
1036
- * request.
1045
+ * Query param: Filter report rows by item type. Choose only one item filter per
1046
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1037
1047
  */
1038
1048
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1039
1049
  /**
@@ -1042,28 +1052,28 @@ export interface ReportGeneralDetailParams {
1042
1052
  */
1043
1053
  openBalanceAsOf?: 'report_end_date' | 'today';
1044
1054
  /**
1045
- * Query param: Filter for report data that is posting, non-posting, or either.
1055
+ * Query param: Filter report rows that are posting, non-posting, or either.
1046
1056
  * Posting status refers to whether QuickBooks records the transaction in an
1047
1057
  * account register.
1048
1058
  */
1049
1059
  postingStatus?: 'either' | 'non_posting' | 'posting';
1050
1060
  /**
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.
1061
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1062
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1063
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1064
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1055
1065
  */
1056
1066
  reportDateFrom?: string;
1057
1067
  /**
1058
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1059
- * with `reportDateFrom` or `reportDateTo`.
1068
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1069
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1060
1070
  */
1061
1071
  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
1072
  /**
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.
1073
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1074
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1075
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1076
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1067
1077
  */
1068
1078
  reportDateTo?: string;
1069
1079
  /**
@@ -1072,23 +1082,25 @@ export interface ReportGeneralDetailParams {
1072
1082
  */
1073
1083
  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
1084
  /**
1075
- * Query param: Filter for report data by transaction type(s). Repeat this query
1076
- * parameter to include multiple transaction types.
1085
+ * Query param: Filter report rows by transaction type. Accepts one or more
1086
+ * transaction types.
1077
1087
  */
1078
1088
  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
1089
  /**
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`.
1090
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1091
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1092
+ * `updatedAfter`/`updatedBefore`.
1082
1093
  */
1083
1094
  updatedAfter?: string;
1084
1095
  /**
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`.
1096
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1097
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1098
+ * `updatedAfter`/`updatedBefore`.
1087
1099
  */
1088
1100
  updatedBefore?: string;
1089
1101
  /**
1090
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1091
- * combined with `updatedAfter` or `updatedBefore`.
1102
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1103
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1092
1104
  */
1093
1105
  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
1106
  }
@@ -1102,22 +1114,22 @@ export interface ReportGeneralSummaryParams {
1102
1114
  */
1103
1115
  conductorEndUserId: string;
1104
1116
  /**
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.
1117
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
1118
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
1119
+ * object names with the object's `name` using colons. Accepts one or more account
1120
+ * full names. Choose only one account filter per request: `accountType`,
1121
+ * `accountIds`, or `accountFullNames`.
1110
1122
  */
1111
1123
  accountFullNames?: Array<string>;
1112
1124
  /**
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.
1125
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1126
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1127
+ * `accountIds`, or `accountFullNames`.
1116
1128
  */
1117
1129
  accountIds?: Array<string>;
1118
1130
  /**
1119
- * Query param: Filter for report data by account type. Use only one account filter
1120
- * per request.
1131
+ * Query param: Filter report rows by account type. Choose only one account filter
1132
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1121
1133
  */
1122
1134
  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
1135
  /**
@@ -1128,17 +1140,16 @@ export interface ReportGeneralSummaryParams {
1128
1140
  */
1129
1141
  basis?: 'accrual' | 'cash' | 'none';
1130
1142
  /**
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.
1143
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1144
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1145
+ * names with the object's `name` using colons. Accepts one or more class full
1146
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1136
1147
  */
1137
1148
  classFullNames?: Array<string>;
1138
1149
  /**
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.
1150
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1151
+ * more class IDs. Choose only one class filter per request: `classIds` or
1152
+ * `classFullNames`.
1142
1153
  */
1143
1154
  classIds?: Array<string>;
1144
1155
  /**
@@ -1154,22 +1165,23 @@ export interface ReportGeneralSummaryParams {
1154
1165
  */
1155
1166
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1156
1167
  /**
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.
1168
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1169
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1170
+ * names with the object's `name` using colons. Accepts one or more entity full
1171
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1172
+ * `entityFullNames`.
1162
1173
  */
1163
1174
  entityFullNames?: Array<string>;
1164
1175
  /**
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.
1176
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1177
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1178
+ * `entityIds`, or `entityFullNames`.
1168
1179
  */
1169
1180
  entityIds?: Array<string>;
1170
1181
  /**
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.
1182
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1183
+ * employee, or other name. Choose only one entity filter per request:
1184
+ * `entityType`, `entityIds`, or `entityFullNames`.
1173
1185
  */
1174
1186
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1175
1187
  /**
@@ -1178,24 +1190,26 @@ export interface ReportGeneralSummaryParams {
1178
1190
  */
1179
1191
  includeSubcolumns?: boolean;
1180
1192
  /**
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.
1193
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1194
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1195
+ * names with the object's `name` using colons. Accepts one or more item full
1196
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1197
+ * `itemFullNames`.
1185
1198
  */
1186
1199
  itemFullNames?: Array<string>;
1187
1200
  /**
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.
1201
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1202
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1203
+ * or `itemFullNames`.
1190
1204
  */
1191
1205
  itemIds?: Array<string>;
1192
1206
  /**
1193
- * Query param: Filter for report data by item type. Use only one item filter per
1194
- * request.
1207
+ * Query param: Filter report rows by item type. Choose only one item filter per
1208
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1195
1209
  */
1196
1210
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1197
1211
  /**
1198
- * Query param: Filter for report data that is posting, non-posting, or either.
1212
+ * Query param: Filter report rows that are posting, non-posting, or either.
1199
1213
  * Posting status refers to whether QuickBooks records the transaction in an
1200
1214
  * account register.
1201
1215
  */
@@ -1205,22 +1219,22 @@ export interface ReportGeneralSummaryParams {
1205
1219
  */
1206
1220
  reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1207
1221
  /**
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.
1222
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1223
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1224
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1225
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1212
1226
  */
1213
1227
  reportDateFrom?: string;
1214
1228
  /**
1215
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1216
- * with `reportDateFrom` or `reportDateTo`.
1229
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1230
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1217
1231
  */
1218
1232
  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
1233
  /**
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.
1234
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1235
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1236
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1237
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1224
1238
  */
1225
1239
  reportDateTo?: string;
1226
1240
  /**
@@ -1234,23 +1248,25 @@ export interface ReportGeneralSummaryParams {
1234
1248
  */
1235
1249
  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
1250
  /**
1237
- * Query param: Filter for report data by transaction type(s). Repeat this query
1238
- * parameter to include multiple transaction types.
1251
+ * Query param: Filter report rows by transaction type. Accepts one or more
1252
+ * transaction types.
1239
1253
  */
1240
1254
  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
1255
  /**
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`.
1256
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1257
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1258
+ * `updatedAfter`/`updatedBefore`.
1244
1259
  */
1245
1260
  updatedAfter?: string;
1246
1261
  /**
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`.
1262
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1263
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1264
+ * `updatedAfter`/`updatedBefore`.
1249
1265
  */
1250
1266
  updatedBefore?: string;
1251
1267
  /**
1252
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1253
- * combined with `updatedAfter` or `updatedBefore`.
1268
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1269
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1254
1270
  */
1255
1271
  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
1272
  }
@@ -1264,36 +1280,35 @@ export interface ReportJobParams {
1264
1280
  */
1265
1281
  conductorEndUserId: string;
1266
1282
  /**
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.
1283
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
1284
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
1285
+ * object names with the object's `name` using colons. Accepts one or more account
1286
+ * full names. Choose only one account filter per request: `accountType`,
1287
+ * `accountIds`, or `accountFullNames`.
1272
1288
  */
1273
1289
  accountFullNames?: Array<string>;
1274
1290
  /**
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.
1291
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1292
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1293
+ * `accountIds`, or `accountFullNames`.
1278
1294
  */
1279
1295
  accountIds?: Array<string>;
1280
1296
  /**
1281
- * Query param: Filter for report data by account type. Use only one account filter
1282
- * per request.
1297
+ * Query param: Filter report rows by account type. Choose only one account filter
1298
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1283
1299
  */
1284
1300
  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
1301
  /**
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.
1302
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1303
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1304
+ * names with the object's `name` using colons. Accepts one or more class full
1305
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1291
1306
  */
1292
1307
  classFullNames?: Array<string>;
1293
1308
  /**
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.
1309
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1310
+ * more class IDs. Choose only one class filter per request: `classIds` or
1311
+ * `classFullNames`.
1297
1312
  */
1298
1313
  classIds?: Array<string>;
1299
1314
  /**
@@ -1303,22 +1318,23 @@ export interface ReportJobParams {
1303
1318
  */
1304
1319
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1305
1320
  /**
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.
1321
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1322
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1323
+ * names with the object's `name` using colons. Accepts one or more entity full
1324
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1325
+ * `entityFullNames`.
1311
1326
  */
1312
1327
  entityFullNames?: Array<string>;
1313
1328
  /**
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.
1329
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1330
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1331
+ * `entityIds`, or `entityFullNames`.
1317
1332
  */
1318
1333
  entityIds?: Array<string>;
1319
1334
  /**
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.
1335
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1336
+ * employee, or other name. Choose only one entity filter per request:
1337
+ * `entityType`, `entityIds`, or `entityFullNames`.
1322
1338
  */
1323
1339
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1324
1340
  /**
@@ -1327,45 +1343,47 @@ export interface ReportJobParams {
1327
1343
  */
1328
1344
  includeSubcolumns?: boolean;
1329
1345
  /**
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.
1346
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1347
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1348
+ * names with the object's `name` using colons. Accepts one or more item full
1349
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1350
+ * `itemFullNames`.
1334
1351
  */
1335
1352
  itemFullNames?: Array<string>;
1336
1353
  /**
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.
1354
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1355
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1356
+ * or `itemFullNames`.
1339
1357
  */
1340
1358
  itemIds?: Array<string>;
1341
1359
  /**
1342
- * Query param: Filter for report data by item type. Use only one item filter per
1343
- * request.
1360
+ * Query param: Filter report rows by item type. Choose only one item filter per
1361
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1344
1362
  */
1345
1363
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1346
1364
  /**
1347
- * Query param: Filter for report data that is posting, non-posting, or either.
1365
+ * Query param: Filter report rows that are posting, non-posting, or either.
1348
1366
  * Posting status refers to whether QuickBooks records the transaction in an
1349
1367
  * account register.
1350
1368
  */
1351
1369
  postingStatus?: 'either' | 'non_posting' | 'posting';
1352
1370
  /**
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.
1371
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1372
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1373
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1374
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1357
1375
  */
1358
1376
  reportDateFrom?: string;
1359
1377
  /**
1360
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1361
- * with `reportDateFrom` or `reportDateTo`.
1378
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1379
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1362
1380
  */
1363
1381
  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
1382
  /**
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.
1383
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1384
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1385
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1386
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1369
1387
  */
1370
1388
  reportDateTo?: string;
1371
1389
  /**
@@ -1374,23 +1392,25 @@ export interface ReportJobParams {
1374
1392
  */
1375
1393
  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
1394
  /**
1377
- * Query param: Filter for report data by transaction type(s). Repeat this query
1378
- * parameter to include multiple transaction types.
1395
+ * Query param: Filter report rows by transaction type. Accepts one or more
1396
+ * transaction types.
1379
1397
  */
1380
1398
  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
1399
  /**
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`.
1400
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1401
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1402
+ * `updatedAfter`/`updatedBefore`.
1384
1403
  */
1385
1404
  updatedAfter?: string;
1386
1405
  /**
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`.
1406
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1407
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1408
+ * `updatedAfter`/`updatedBefore`.
1389
1409
  */
1390
1410
  updatedBefore?: string;
1391
1411
  /**
1392
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1393
- * combined with `updatedAfter` or `updatedBefore`.
1412
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1413
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1394
1414
  */
1395
1415
  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
1416
  }
@@ -1404,17 +1424,17 @@ export interface ReportPayrollDetailParams {
1404
1424
  */
1405
1425
  conductorEndUserId: string;
1406
1426
  /**
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.
1427
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
1428
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
1429
+ * object names with the object's `name` using colons. Accepts one or more account
1430
+ * full names. Choose only one account filter per request: `accountType`,
1431
+ * `accountIds`, or `accountFullNames`.
1412
1432
  */
1413
1433
  accountFullNames?: Array<string>;
1414
1434
  /**
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.
1435
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1436
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1437
+ * `accountIds`, or `accountFullNames`.
1418
1438
  */
1419
1439
  accountIds?: Array<string>;
1420
1440
  /**
@@ -1422,22 +1442,21 @@ export interface ReportPayrollDetailParams {
1422
1442
  */
1423
1443
  accountsToInclude?: 'all' | 'in_use';
1424
1444
  /**
1425
- * Query param: Filter for report data by account type. Use only one account filter
1426
- * per request.
1445
+ * Query param: Filter report rows by account type. Choose only one account filter
1446
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1427
1447
  */
1428
1448
  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
1449
  /**
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.
1450
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1451
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1452
+ * names with the object's `name` using colons. Accepts one or more class full
1453
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1435
1454
  */
1436
1455
  classFullNames?: Array<string>;
1437
1456
  /**
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.
1457
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1458
+ * more class IDs. Choose only one class filter per request: `classIds` or
1459
+ * `classFullNames`.
1441
1460
  */
1442
1461
  classIds?: Array<string>;
1443
1462
  /**
@@ -1447,46 +1466,48 @@ export interface ReportPayrollDetailParams {
1447
1466
  */
1448
1467
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1449
1468
  /**
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.
1469
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1470
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1471
+ * names with the object's `name` using colons. Accepts one or more entity full
1472
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1473
+ * `entityFullNames`.
1455
1474
  */
1456
1475
  entityFullNames?: Array<string>;
1457
1476
  /**
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.
1477
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1478
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1479
+ * `entityIds`, or `entityFullNames`.
1461
1480
  */
1462
1481
  entityIds?: Array<string>;
1463
1482
  /**
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.
1483
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1484
+ * employee, or other name. Choose only one entity filter per request:
1485
+ * `entityType`, `entityIds`, or `entityFullNames`.
1466
1486
  */
1467
1487
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1468
1488
  /**
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.
1489
+ * Query param: The report columns to include, by column type. Accepts one or more
1490
+ * columns. When this parameter is present, QuickBooks Desktop omits its default
1491
+ * report columns unless you include them here.
1473
1492
  */
1474
1493
  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
1494
  /**
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.
1495
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1496
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1497
+ * names with the object's `name` using colons. Accepts one or more item full
1498
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1499
+ * `itemFullNames`.
1480
1500
  */
1481
1501
  itemFullNames?: Array<string>;
1482
1502
  /**
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.
1503
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1504
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1505
+ * or `itemFullNames`.
1485
1506
  */
1486
1507
  itemIds?: Array<string>;
1487
1508
  /**
1488
- * Query param: Filter for report data by item type. Use only one item filter per
1489
- * request.
1509
+ * Query param: Filter report rows by item type. Choose only one item filter per
1510
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1490
1511
  */
1491
1512
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1492
1513
  /**
@@ -1495,28 +1516,28 @@ export interface ReportPayrollDetailParams {
1495
1516
  */
1496
1517
  openBalanceAsOf?: 'report_end_date' | 'today';
1497
1518
  /**
1498
- * Query param: Filter for report data that is posting, non-posting, or either.
1519
+ * Query param: Filter report rows that are posting, non-posting, or either.
1499
1520
  * Posting status refers to whether QuickBooks records the transaction in an
1500
1521
  * account register.
1501
1522
  */
1502
1523
  postingStatus?: 'either' | 'non_posting' | 'posting';
1503
1524
  /**
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.
1525
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1526
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1527
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1528
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1508
1529
  */
1509
1530
  reportDateFrom?: string;
1510
1531
  /**
1511
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1512
- * with `reportDateFrom` or `reportDateTo`.
1532
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1533
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1513
1534
  */
1514
1535
  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
1536
  /**
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.
1537
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1538
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1539
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1540
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1520
1541
  */
1521
1542
  reportDateTo?: string;
1522
1543
  /**
@@ -1525,18 +1546,20 @@ export interface ReportPayrollDetailParams {
1525
1546
  */
1526
1547
  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
1548
  /**
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`.
1549
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1550
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1551
+ * `updatedAfter`/`updatedBefore`.
1530
1552
  */
1531
1553
  updatedAfter?: string;
1532
1554
  /**
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`.
1555
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1556
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1557
+ * `updatedAfter`/`updatedBefore`.
1535
1558
  */
1536
1559
  updatedBefore?: string;
1537
1560
  /**
1538
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1539
- * combined with `updatedAfter` or `updatedBefore`.
1561
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1562
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1540
1563
  */
1541
1564
  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
1565
  }
@@ -1550,36 +1573,35 @@ export interface ReportPayrollSummaryParams {
1550
1573
  */
1551
1574
  conductorEndUserId: string;
1552
1575
  /**
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.
1576
+ * Query param: Filter report rows by account `fullName` values, case-insensitive.
1577
+ * A `fullName` is a fully qualified QuickBooks name formed by joining parent
1578
+ * object names with the object's `name` using colons. Accepts one or more account
1579
+ * full names. Choose only one account filter per request: `accountType`,
1580
+ * `accountIds`, or `accountFullNames`.
1558
1581
  */
1559
1582
  accountFullNames?: Array<string>;
1560
1583
  /**
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.
1584
+ * Query param: Filter report rows by QuickBooks-assigned account IDs. Accepts one
1585
+ * or more account IDs. Choose only one account filter per request: `accountType`,
1586
+ * `accountIds`, or `accountFullNames`.
1564
1587
  */
1565
1588
  accountIds?: Array<string>;
1566
1589
  /**
1567
- * Query param: Filter for report data by account type. Use only one account filter
1568
- * per request.
1590
+ * Query param: Filter report rows by account type. Choose only one account filter
1591
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1569
1592
  */
1570
1593
  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
1594
  /**
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.
1595
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1596
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1597
+ * names with the object's `name` using colons. Accepts one or more class full
1598
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1577
1599
  */
1578
1600
  classFullNames?: Array<string>;
1579
1601
  /**
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.
1602
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1603
+ * more class IDs. Choose only one class filter per request: `classIds` or
1604
+ * `classFullNames`.
1583
1605
  */
1584
1606
  classIds?: Array<string>;
1585
1607
  /**
@@ -1595,22 +1617,23 @@ export interface ReportPayrollSummaryParams {
1595
1617
  */
1596
1618
  detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1597
1619
  /**
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.
1620
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1621
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1622
+ * names with the object's `name` using colons. Accepts one or more entity full
1623
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1624
+ * `entityFullNames`.
1603
1625
  */
1604
1626
  entityFullNames?: Array<string>;
1605
1627
  /**
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.
1628
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1629
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1630
+ * `entityIds`, or `entityFullNames`.
1609
1631
  */
1610
1632
  entityIds?: Array<string>;
1611
1633
  /**
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.
1634
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1635
+ * employee, or other name. Choose only one entity filter per request:
1636
+ * `entityType`, `entityIds`, or `entityFullNames`.
1614
1637
  */
1615
1638
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1616
1639
  /**
@@ -1619,24 +1642,26 @@ export interface ReportPayrollSummaryParams {
1619
1642
  */
1620
1643
  includeSubcolumns?: boolean;
1621
1644
  /**
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.
1645
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1646
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1647
+ * names with the object's `name` using colons. Accepts one or more item full
1648
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1649
+ * `itemFullNames`.
1626
1650
  */
1627
1651
  itemFullNames?: Array<string>;
1628
1652
  /**
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.
1653
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1654
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1655
+ * or `itemFullNames`.
1631
1656
  */
1632
1657
  itemIds?: Array<string>;
1633
1658
  /**
1634
- * Query param: Filter for report data by item type. Use only one item filter per
1635
- * request.
1659
+ * Query param: Filter report rows by item type. Choose only one item filter per
1660
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1636
1661
  */
1637
1662
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1638
1663
  /**
1639
- * Query param: Filter for report data that is posting, non-posting, or either.
1664
+ * Query param: Filter report rows that are posting, non-posting, or either.
1640
1665
  * Posting status refers to whether QuickBooks records the transaction in an
1641
1666
  * account register.
1642
1667
  */
@@ -1646,22 +1671,22 @@ export interface ReportPayrollSummaryParams {
1646
1671
  */
1647
1672
  reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1648
1673
  /**
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.
1674
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1675
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1676
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1677
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1653
1678
  */
1654
1679
  reportDateFrom?: string;
1655
1680
  /**
1656
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1657
- * with `reportDateFrom` or `reportDateTo`.
1681
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1682
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1658
1683
  */
1659
1684
  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
1685
  /**
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.
1686
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1687
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1688
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1689
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1665
1690
  */
1666
1691
  reportDateTo?: string;
1667
1692
  /**
@@ -1675,18 +1700,20 @@ export interface ReportPayrollSummaryParams {
1675
1700
  */
1676
1701
  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
1702
  /**
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`.
1703
+ * Query param: Filter report rows updated on or after this date, in ISO 8601
1704
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1705
+ * `updatedAfter`/`updatedBefore`.
1680
1706
  */
1681
1707
  updatedAfter?: string;
1682
1708
  /**
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`.
1709
+ * Query param: Filter report rows updated on or before this date, in ISO 8601
1710
+ * format (YYYY-MM-DD). Choose either `updatedDateMacro` or
1711
+ * `updatedAfter`/`updatedBefore`.
1685
1712
  */
1686
1713
  updatedBefore?: string;
1687
1714
  /**
1688
- * Query param: A QuickBooks Desktop relative updated-date macro. This cannot be
1689
- * combined with `updatedAfter` or `updatedBefore`.
1715
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1716
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1690
1717
  */
1691
1718
  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
1719
  }
@@ -1700,17 +1727,16 @@ export interface ReportTimeParams {
1700
1727
  */
1701
1728
  conductorEndUserId: string;
1702
1729
  /**
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.
1730
+ * Query param: Filter report rows by class `fullName` values, case-insensitive. A
1731
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1732
+ * names with the object's `name` using colons. Accepts one or more class full
1733
+ * names. Choose only one class filter per request: `classIds` or `classFullNames`.
1708
1734
  */
1709
1735
  classFullNames?: Array<string>;
1710
1736
  /**
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.
1737
+ * Query param: Filter report rows by QuickBooks-assigned class IDs. Accepts one or
1738
+ * more class IDs. Choose only one class filter per request: `classIds` or
1739
+ * `classFullNames`.
1714
1740
  */
1715
1741
  classIds?: Array<string>;
1716
1742
  /**
@@ -1720,22 +1746,23 @@ export interface ReportTimeParams {
1720
1746
  */
1721
1747
  columnsToReturn?: 'active_only' | 'non_zero' | 'all';
1722
1748
  /**
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.
1749
+ * Query param: Filter report rows by entity `fullName` values, case-insensitive. A
1750
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1751
+ * names with the object's `name` using colons. Accepts one or more entity full
1752
+ * names. Choose only one entity filter per request: `entityType`, `entityIds`, or
1753
+ * `entityFullNames`.
1728
1754
  */
1729
1755
  entityFullNames?: Array<string>;
1730
1756
  /**
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.
1757
+ * Query param: Filter report rows by QuickBooks-assigned entity IDs. Accepts one
1758
+ * or more entity IDs. Choose only one entity filter per request: `entityType`,
1759
+ * `entityIds`, or `entityFullNames`.
1734
1760
  */
1735
1761
  entityIds?: Array<string>;
1736
1762
  /**
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.
1763
+ * Query param: Filter report rows by entity type, such as customer, vendor,
1764
+ * employee, or other name. Choose only one entity filter per request:
1765
+ * `entityType`, `entityIds`, or `entityFullNames`.
1739
1766
  */
1740
1767
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1741
1768
  /**
@@ -1744,20 +1771,22 @@ export interface ReportTimeParams {
1744
1771
  */
1745
1772
  includeSubcolumns?: boolean;
1746
1773
  /**
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.
1774
+ * Query param: Filter report rows by item `fullName` values, case-insensitive. A
1775
+ * `fullName` is a fully qualified QuickBooks name formed by joining parent object
1776
+ * names with the object's `name` using colons. Accepts one or more item full
1777
+ * names. Choose only one item filter per request: `itemType`, `itemIds`, or
1778
+ * `itemFullNames`.
1751
1779
  */
1752
1780
  itemFullNames?: Array<string>;
1753
1781
  /**
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.
1782
+ * Query param: Filter report rows by QuickBooks-assigned item IDs. Accepts one or
1783
+ * more item IDs. Choose only one item filter per request: `itemType`, `itemIds`,
1784
+ * or `itemFullNames`.
1756
1785
  */
1757
1786
  itemIds?: Array<string>;
1758
1787
  /**
1759
- * Query param: Filter for report data by item type. Use only one item filter per
1760
- * request.
1788
+ * Query param: Filter report rows by item type. Choose only one item filter per
1789
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1761
1790
  */
1762
1791
  itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1763
1792
  /**
@@ -1765,22 +1794,22 @@ export interface ReportTimeParams {
1765
1794
  */
1766
1795
  reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1767
1796
  /**
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.
1797
+ * Query param: Filter report rows dated on or after this date, in ISO 8601 format
1798
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1799
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1800
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1772
1801
  */
1773
1802
  reportDateFrom?: string;
1774
1803
  /**
1775
- * Query param: A QuickBooks Desktop relative date macro. This cannot be combined
1776
- * with `reportDateFrom` or `reportDateTo`.
1804
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1805
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1777
1806
  */
1778
1807
  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
1808
  /**
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.
1809
+ * Query param: Filter report rows dated on or before this date, in ISO 8601 format
1810
+ * (YYYY-MM-DD). Choose either `reportDateMacro` or
1811
+ * `reportDateFrom`/`reportDateTo`. If you omit `reportDateFrom`, `reportDateTo`,
1812
+ * and `reportDateMacro`, QuickBooks Desktop uses the current fiscal year to date.
1784
1813
  */
1785
1814
  reportDateTo?: string;
1786
1815
  /**