conductor-node 14.12.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.
Files changed (57) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/internal/utils/log.d.mts.map +1 -1
  3. package/internal/utils/log.d.ts.map +1 -1
  4. package/internal/utils/log.js +2 -0
  5. package/internal/utils/log.js.map +1 -1
  6. package/internal/utils/log.mjs +2 -0
  7. package/internal/utils/log.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/qbd/bill-check-payments.d.mts +8 -8
  10. package/resources/qbd/bill-check-payments.d.ts +8 -8
  11. package/resources/qbd/bill-credit-card-payments.d.mts +4 -4
  12. package/resources/qbd/bill-credit-card-payments.d.ts +4 -4
  13. package/resources/qbd/index.d.mts +1 -0
  14. package/resources/qbd/index.d.mts.map +1 -1
  15. package/resources/qbd/index.d.ts +1 -0
  16. package/resources/qbd/index.d.ts.map +1 -1
  17. package/resources/qbd/index.js +4 -2
  18. package/resources/qbd/index.js.map +1 -1
  19. package/resources/qbd/index.mjs +1 -0
  20. package/resources/qbd/index.mjs.map +1 -1
  21. package/resources/qbd/invoices.d.mts +10 -8
  22. package/resources/qbd/invoices.d.mts.map +1 -1
  23. package/resources/qbd/invoices.d.ts +10 -8
  24. package/resources/qbd/invoices.d.ts.map +1 -1
  25. package/resources/qbd/qbd.d.mts +4 -0
  26. package/resources/qbd/qbd.d.mts.map +1 -1
  27. package/resources/qbd/qbd.d.ts +4 -0
  28. package/resources/qbd/qbd.d.ts.map +1 -1
  29. package/resources/qbd/qbd.js +4 -0
  30. package/resources/qbd/qbd.js.map +1 -1
  31. package/resources/qbd/qbd.mjs +4 -0
  32. package/resources/qbd/qbd.mjs.map +1 -1
  33. package/resources/qbd/receive-payments.d.mts +12 -12
  34. package/resources/qbd/receive-payments.d.ts +12 -12
  35. package/resources/qbd/receive-payments.js +4 -4
  36. package/resources/qbd/receive-payments.mjs +4 -4
  37. package/resources/qbd/reports.d.mts +1829 -0
  38. package/resources/qbd/reports.d.mts.map +1 -0
  39. package/resources/qbd/reports.d.ts +1829 -0
  40. package/resources/qbd/reports.d.ts.map +1 -0
  41. package/resources/qbd/reports.js +203 -0
  42. package/resources/qbd/reports.js.map +1 -0
  43. package/resources/qbd/reports.mjs +199 -0
  44. package/resources/qbd/reports.mjs.map +1 -0
  45. package/src/internal/utils/log.ts +2 -0
  46. package/src/resources/qbd/bill-check-payments.ts +8 -8
  47. package/src/resources/qbd/bill-credit-card-payments.ts +4 -4
  48. package/src/resources/qbd/index.ts +14 -0
  49. package/src/resources/qbd/invoices.ts +10 -8
  50. package/src/resources/qbd/qbd.ts +32 -0
  51. package/src/resources/qbd/receive-payments.ts +12 -12
  52. package/src/resources/qbd/reports.ts +3962 -0
  53. package/src/version.ts +1 -1
  54. package/version.d.mts +1 -1
  55. package/version.d.ts +1 -1
  56. package/version.js +1 -1
  57. package/version.mjs +1 -1
@@ -0,0 +1,1829 @@
1
+ import { APIResource } from "../../core/resource.js";
2
+ import { APIPromise } from "../../core/api-promise.js";
3
+ import { RequestOptions } from "../../internal/request-options.js";
4
+ export declare class Reports extends APIResource {
5
+ /**
6
+ * Retrieves an aging report.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * const report = await conductor.qbd.reports.aging({
11
+ * reportType: 'ap_aging_detail',
12
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
13
+ * });
14
+ * ```
15
+ */
16
+ aging(params: ReportAgingParams, options?: RequestOptions): APIPromise<Report>;
17
+ /**
18
+ * Retrieves a budget summary report.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const report = await conductor.qbd.reports.budgetSummary({
23
+ * fiscalYear: 2026,
24
+ * reportType: 'balance_sheet_budget_overview',
25
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
26
+ * });
27
+ * ```
28
+ */
29
+ budgetSummary(params: ReportBudgetSummaryParams, options?: RequestOptions): APIPromise<Report>;
30
+ /**
31
+ * Retrieves a custom detail report.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const report = await conductor.qbd.reports.customDetail({
36
+ * includeColumns: ['date', 'transaction_type', 'amount'],
37
+ * summarizeRowsBy: 'account',
38
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
39
+ * });
40
+ * ```
41
+ */
42
+ customDetail(params: ReportCustomDetailParams, options?: RequestOptions): APIPromise<Report>;
43
+ /**
44
+ * Retrieves a custom summary report.
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * const report = await conductor.qbd.reports.customSummary({
49
+ * summarizeColumnsBy: 'month',
50
+ * summarizeRowsBy: 'account',
51
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
52
+ * });
53
+ * ```
54
+ */
55
+ customSummary(params: ReportCustomSummaryParams, options?: RequestOptions): APIPromise<Report>;
56
+ /**
57
+ * Retrieves a general detail report.
58
+ *
59
+ * @example
60
+ * ```ts
61
+ * const report = await conductor.qbd.reports.generalDetail({
62
+ * reportType: '1099_detail',
63
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
64
+ * });
65
+ * ```
66
+ */
67
+ generalDetail(params: ReportGeneralDetailParams, options?: RequestOptions): APIPromise<Report>;
68
+ /**
69
+ * Retrieves a general summary report.
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const report = await conductor.qbd.reports.generalSummary({
74
+ * reportType: 'balance_sheet_by_class',
75
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
76
+ * });
77
+ * ```
78
+ */
79
+ generalSummary(params: ReportGeneralSummaryParams, options?: RequestOptions): APIPromise<Report>;
80
+ /**
81
+ * Retrieves a job report.
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * const report = await conductor.qbd.reports.job({
86
+ * reportType: 'item_estimates_vs_actuals',
87
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
88
+ * });
89
+ * ```
90
+ */
91
+ job(params: ReportJobParams, options?: RequestOptions): APIPromise<Report>;
92
+ /**
93
+ * Retrieves a payroll detail report.
94
+ *
95
+ * @example
96
+ * ```ts
97
+ * const report = await conductor.qbd.reports.payrollDetail({
98
+ * reportType: 'employee_state_taxes_detail',
99
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
100
+ * });
101
+ * ```
102
+ */
103
+ payrollDetail(params: ReportPayrollDetailParams, options?: RequestOptions): APIPromise<Report>;
104
+ /**
105
+ * Retrieves a payroll summary report.
106
+ *
107
+ * @example
108
+ * ```ts
109
+ * const report = await conductor.qbd.reports.payrollSummary({
110
+ * reportType: 'employee_earnings_summary',
111
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
112
+ * });
113
+ * ```
114
+ */
115
+ payrollSummary(params: ReportPayrollSummaryParams, options?: RequestOptions): APIPromise<Report>;
116
+ /**
117
+ * Retrieves a time report.
118
+ *
119
+ * @example
120
+ * ```ts
121
+ * const report = await conductor.qbd.reports.time({
122
+ * reportType: 'time_by_item',
123
+ * conductorEndUserId: 'end_usr_1234567abcdefg',
124
+ * });
125
+ * ```
126
+ */
127
+ time(params: ReportTimeParams, options?: RequestOptions): APIPromise<Report>;
128
+ }
129
+ export interface Report {
130
+ /**
131
+ * The accounting basis.
132
+ */
133
+ basis: 'accrual' | 'cash' | 'none' | null;
134
+ /**
135
+ * The report category.
136
+ */
137
+ category: 'general_summary' | 'general_detail' | 'aging' | 'budget_summary' | 'job' | 'time' | 'custom_detail' | 'custom_summary' | 'payroll_detail' | 'payroll_summary';
138
+ /**
139
+ * The number of columns in the report.
140
+ */
141
+ columnCount: number | null;
142
+ /**
143
+ * The report columns, in display order. Use each column's `columnId` to match row
144
+ * cells to columns.
145
+ */
146
+ columns: Array<Report.Column>;
147
+ /**
148
+ * The number of title rows for the report columns.
149
+ */
150
+ columnTitleRowCount: number | null;
151
+ /**
152
+ * The type of object. This value is always `"qbd_report"`.
153
+ */
154
+ objectType: 'qbd_report';
155
+ /**
156
+ * The report type.
157
+ */
158
+ reportType: 'balance_sheet_by_class' | 'balance_sheet_previous_year_comparison' | 'balance_sheet_standard' | 'balance_sheet_summary' | 'customer_balance_summary' | 'expense_by_vendor_summary' | 'income_by_customer_summary' | 'inventory_stock_status_by_item' | 'inventory_stock_status_by_vendor' | 'income_tax_summary' | 'inventory_valuation_summary' | 'inventory_valuation_summary_by_site' | 'lot_number_in_stock_by_site' | 'physical_inventory_worksheet' | 'profit_and_loss_by_class' | 'profit_and_loss_by_job' | 'profit_and_loss_previous_year_comparison' | 'profit_and_loss_standard' | 'profit_and_loss_ytd_comparison' | 'purchase_by_item_summary' | 'purchase_by_vendor_summary' | 'sales_by_customer_summary' | 'sales_by_item_summary' | 'sales_by_sales_representative_summary' | 'sales_tax_liability' | 'sales_tax_revenue_summary' | 'serial_number_in_stock_by_site' | 'trial_balance' | 'vendor_balance_summary' | '1099_detail' | 'audit_trail' | 'balance_sheet_detail' | 'check_detail' | 'customer_balance_detail' | 'deposit_detail' | 'estimates_by_job' | 'expense_by_vendor_detail' | 'general_ledger' | 'income_by_customer_detail' | 'income_tax_detail' | 'inventory_valuation_detail' | 'job_progress_invoices_vs_estimates' | 'journal' | 'missing_checks' | 'open_invoices' | 'open_purchase_orders' | 'open_purchase_orders_by_job' | 'open_sales_order_by_customer' | 'open_sales_order_by_item' | 'pending_sales' | 'profit_and_loss_detail' | 'purchase_by_item_detail' | 'purchase_by_vendor_detail' | 'sales_by_customer_detail' | 'sales_by_item_detail' | 'sales_by_sales_representative_detail' | 'transaction_detail_by_account' | 'transaction_list_by_customer' | 'transaction_list_by_date' | 'transaction_list_by_vendor' | 'unpaid_bills_detail' | 'unbilled_costs_by_job' | 'vendor_balance_detail' | 'ap_aging_detail' | 'ap_aging_summary' | 'ar_aging_detail' | 'ar_aging_summary' | 'collections_report' | 'balance_sheet_budget_overview' | 'balance_sheet_budget_vs_actual' | 'profit_and_loss_budget_overview' | 'profit_and_loss_budget_performance' | 'profit_and_loss_budget_vs_actual' | 'item_estimates_vs_actuals' | 'item_profitability' | 'job_estimates_vs_actuals_detail' | 'job_estimates_vs_actuals_summary' | 'job_profitability_detail' | 'job_profitability_summary' | 'time_by_item' | 'time_by_job_detail' | 'time_by_job_summary' | 'time_by_name' | 'custom_transaction_detail' | 'custom_summary' | 'employee_state_taxes_detail' | 'payroll_item_detail' | 'payroll_review_detail' | 'payroll_transaction_detail' | 'payroll_transactions_by_payee' | 'employee_earnings_summary' | 'payroll_liability_balances' | 'payroll_summary';
159
+ /**
160
+ * The number of rows in the report.
161
+ */
162
+ rowCount: number | null;
163
+ /**
164
+ * The report rows, in display order. Rows can be text rows, detail data rows,
165
+ * subtotal rows, or total rows.
166
+ */
167
+ rows: Array<Report.QbdReportTextRow | Report.QbdReportDataRow | Report.QbdReportSubtotalRow | Report.QbdReportTotalRow>;
168
+ /**
169
+ * The report subtitle.
170
+ */
171
+ subtitle: string | null;
172
+ /**
173
+ * The report title.
174
+ */
175
+ title: string | null;
176
+ }
177
+ export declare namespace Report {
178
+ interface Column {
179
+ /**
180
+ * The report column identifier. QuickBooks Desktop numbers columns from left to
181
+ * right, starting at 1. Use this value to match row cells to columns.
182
+ */
183
+ columnId: string;
184
+ /**
185
+ * The report column type, describing the business meaning of the column, such as
186
+ * `date`, `amount`, or `transaction_type`.
187
+ */
188
+ columnType: string;
189
+ /**
190
+ * The raw value data type for this column, such as `string`, `amount`, or `date`.
191
+ * This is `null` if QuickBooks Desktop does not provide a data type.
192
+ */
193
+ dataType: string | null;
194
+ /**
195
+ * The column title cells. Reports can use multiple title rows.
196
+ */
197
+ titles: Array<Column.Title>;
198
+ }
199
+ namespace Column {
200
+ interface Title {
201
+ /**
202
+ * The one-based title row number. Reports can have multiple title rows.
203
+ */
204
+ rowNumber: number;
205
+ /**
206
+ * The title text for this column title row. This is `null` if QuickBooks Desktop
207
+ * does not provide one.
208
+ */
209
+ value: string | null;
210
+ }
211
+ }
212
+ interface QbdReportTextRow {
213
+ /**
214
+ * The row kind. This value is always `"text"`.
215
+ */
216
+ kind: 'text';
217
+ /**
218
+ * The one-based row number from the report.
219
+ */
220
+ rowNumber: number;
221
+ /**
222
+ * The text row value. Text rows are mainly used for headings. This is `null` if
223
+ * QuickBooks Desktop does not provide one.
224
+ */
225
+ text: string | null;
226
+ }
227
+ interface QbdReportDataRow {
228
+ /**
229
+ * The cells in this report row. Report rows are sparse, so cells appear only for
230
+ * columns where QuickBooks Desktop returned a value.
231
+ */
232
+ cells: Array<QbdReportDataRow.Cell>;
233
+ /**
234
+ * The row kind. This value is always `"data"`.
235
+ */
236
+ kind: 'data';
237
+ /**
238
+ * The row-level descriptor provided by QuickBooks Desktop. This is separate from
239
+ * the row's table values in `cells` and is `null` when QuickBooks Desktop does not
240
+ * provide one.
241
+ */
242
+ rowDescriptor: QbdReportDataRow.RowDescriptor | null;
243
+ /**
244
+ * The one-based row number from the report.
245
+ */
246
+ rowNumber: number;
247
+ }
248
+ namespace QbdReportDataRow {
249
+ interface Cell {
250
+ /**
251
+ * The column identifier for this cell. This matches a column's `columnId` and
252
+ * refers to the column's left-to-right position in the report.
253
+ */
254
+ columnId: string;
255
+ /**
256
+ * The value data type for this cell. If QuickBooks Desktop omits the cell data
257
+ * type, this uses the matching column's `dataType` when available.
258
+ */
259
+ dataType: string | null;
260
+ /**
261
+ * The cell value as a QuickBooks Desktop-formatted string. This is `null` if
262
+ * QuickBooks Desktop does not provide a value for the cell.
263
+ */
264
+ value: string | null;
265
+ }
266
+ /**
267
+ * The row-level descriptor provided by QuickBooks Desktop. This is separate from
268
+ * the row's table values in `cells` and is `null` when QuickBooks Desktop does not
269
+ * provide one.
270
+ */
271
+ interface RowDescriptor {
272
+ /**
273
+ * The kind of row-level descriptor, such as `account`, `customer`, or `vendor`.
274
+ * This is `null` if QuickBooks Desktop does not provide one.
275
+ */
276
+ type: string | null;
277
+ /**
278
+ * The row-level descriptor value. This can differ from the first cell value and is
279
+ * `null` if QuickBooks Desktop does not provide one.
280
+ */
281
+ value: string | null;
282
+ }
283
+ }
284
+ interface QbdReportSubtotalRow {
285
+ /**
286
+ * The cells in this report row. Report rows are sparse, so cells appear only for
287
+ * columns where QuickBooks Desktop returned a value.
288
+ */
289
+ cells: Array<QbdReportSubtotalRow.Cell>;
290
+ /**
291
+ * The row kind. This value is always `"subtotal"`.
292
+ */
293
+ kind: 'subtotal';
294
+ /**
295
+ * The row-level descriptor provided by QuickBooks Desktop. This is separate from
296
+ * the row's table values in `cells` and is `null` when QuickBooks Desktop does not
297
+ * provide one.
298
+ */
299
+ rowDescriptor: QbdReportSubtotalRow.RowDescriptor | null;
300
+ /**
301
+ * The one-based row number from the report.
302
+ */
303
+ rowNumber: number;
304
+ }
305
+ namespace QbdReportSubtotalRow {
306
+ interface Cell {
307
+ /**
308
+ * The column identifier for this cell. This matches a column's `columnId` and
309
+ * refers to the column's left-to-right position in the report.
310
+ */
311
+ columnId: string;
312
+ /**
313
+ * The value data type for this cell. If QuickBooks Desktop omits the cell data
314
+ * type, this uses the matching column's `dataType` when available.
315
+ */
316
+ dataType: string | null;
317
+ /**
318
+ * The cell value as a QuickBooks Desktop-formatted string. This is `null` if
319
+ * QuickBooks Desktop does not provide a value for the cell.
320
+ */
321
+ value: string | null;
322
+ }
323
+ /**
324
+ * The row-level descriptor provided by QuickBooks Desktop. This is separate from
325
+ * the row's table values in `cells` and is `null` when QuickBooks Desktop does not
326
+ * provide one.
327
+ */
328
+ interface RowDescriptor {
329
+ /**
330
+ * The kind of row-level descriptor, such as `account`, `customer`, or `vendor`.
331
+ * This is `null` if QuickBooks Desktop does not provide one.
332
+ */
333
+ type: string | null;
334
+ /**
335
+ * The row-level descriptor value. This can differ from the first cell value and is
336
+ * `null` if QuickBooks Desktop does not provide one.
337
+ */
338
+ value: string | null;
339
+ }
340
+ }
341
+ interface QbdReportTotalRow {
342
+ /**
343
+ * The cells in this report row. Report rows are sparse, so cells appear only for
344
+ * columns where QuickBooks Desktop returned a value.
345
+ */
346
+ cells: Array<QbdReportTotalRow.Cell>;
347
+ /**
348
+ * The row kind. This value is always `"total"`.
349
+ */
350
+ kind: 'total';
351
+ /**
352
+ * The row-level descriptor provided by QuickBooks Desktop. This is separate from
353
+ * the row's table values in `cells` and is `null` when QuickBooks Desktop does not
354
+ * provide one.
355
+ */
356
+ rowDescriptor: QbdReportTotalRow.RowDescriptor | null;
357
+ /**
358
+ * The one-based row number from the report.
359
+ */
360
+ rowNumber: number;
361
+ }
362
+ namespace QbdReportTotalRow {
363
+ interface Cell {
364
+ /**
365
+ * The column identifier for this cell. This matches a column's `columnId` and
366
+ * refers to the column's left-to-right position in the report.
367
+ */
368
+ columnId: string;
369
+ /**
370
+ * The value data type for this cell. If QuickBooks Desktop omits the cell data
371
+ * type, this uses the matching column's `dataType` when available.
372
+ */
373
+ dataType: string | null;
374
+ /**
375
+ * The cell value as a QuickBooks Desktop-formatted string. This is `null` if
376
+ * QuickBooks Desktop does not provide a value for the cell.
377
+ */
378
+ value: string | null;
379
+ }
380
+ /**
381
+ * The row-level descriptor provided by QuickBooks Desktop. This is separate from
382
+ * the row's table values in `cells` and is `null` when QuickBooks Desktop does not
383
+ * provide one.
384
+ */
385
+ interface RowDescriptor {
386
+ /**
387
+ * The kind of row-level descriptor, such as `account`, `customer`, or `vendor`.
388
+ * This is `null` if QuickBooks Desktop does not provide one.
389
+ */
390
+ type: string | null;
391
+ /**
392
+ * The row-level descriptor value. This can differ from the first cell value and is
393
+ * `null` if QuickBooks Desktop does not provide one.
394
+ */
395
+ value: string | null;
396
+ }
397
+ }
398
+ }
399
+ export interface ReportAgingParams {
400
+ /**
401
+ * Query param: The aging report type to retrieve.
402
+ */
403
+ reportType: 'ap_aging_detail' | 'ap_aging_summary' | 'ar_aging_detail' | 'ar_aging_summary' | 'collections_report';
404
+ /**
405
+ * Header param: The ID of the End-User to receive this request.
406
+ */
407
+ conductorEndUserId: string;
408
+ /**
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
+ */
415
+ accountFullNames?: Array<string>;
416
+ /**
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
+ */
421
+ accountIds?: Array<string>;
422
+ /**
423
+ * Query param: Whether to include all accounts or only accounts in use.
424
+ */
425
+ accountsToInclude?: 'all' | 'in_use';
426
+ /**
427
+ * Query param: Filter report rows by account type. Choose only one account filter
428
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
429
+ */
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
+ /**
432
+ * Query param: The date through which QuickBooks Desktop calculates aging
433
+ * information.
434
+ */
435
+ agingAsOf?: 'report_end_date' | 'today';
436
+ /**
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`.
441
+ */
442
+ classFullNames?: Array<string>;
443
+ /**
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`.
447
+ */
448
+ classIds?: Array<string>;
449
+ /**
450
+ * Query param: The report detail level to include. Use `all` for all rows,
451
+ * `all_except_summary` to omit summary rows, or `summary_only` to return only
452
+ * summary rows.
453
+ */
454
+ detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
455
+ /**
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`.
461
+ */
462
+ entityFullNames?: Array<string>;
463
+ /**
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`.
467
+ */
468
+ entityIds?: Array<string>;
469
+ /**
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
+ */
474
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
475
+ /**
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.
479
+ */
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'>;
481
+ /**
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
+ */
488
+ itemFullNames?: Array<string>;
489
+ /**
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`.
493
+ */
494
+ itemIds?: Array<string>;
495
+ /**
496
+ * Query param: Filter report rows by item type. Choose only one item filter per
497
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
498
+ */
499
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
500
+ /**
501
+ * Query param: Filter report rows that are posting, non-posting, or either.
502
+ * Posting status refers to whether QuickBooks records the transaction in an
503
+ * account register.
504
+ */
505
+ postingStatus?: 'either' | 'non_posting' | 'posting';
506
+ /**
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.
511
+ */
512
+ reportDateFrom?: string;
513
+ /**
514
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
515
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
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';
518
+ /**
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.
523
+ */
524
+ reportDateTo?: string;
525
+ /**
526
+ * Query param: Filter report rows by transaction type. Accepts one or more
527
+ * transaction types.
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'>;
530
+ /**
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`.
534
+ */
535
+ updatedAfter?: string;
536
+ /**
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`.
540
+ */
541
+ updatedBefore?: string;
542
+ /**
543
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
544
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
545
+ */
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';
547
+ }
548
+ export interface ReportBudgetSummaryParams {
549
+ /**
550
+ * Query param: The fiscal year of the QuickBooks budget. QuickBooks Desktop
551
+ * returns the full fiscal year for prior years and year-to-date data for the
552
+ * current fiscal year.
553
+ */
554
+ fiscalYear: number;
555
+ /**
556
+ * Query param: The budget summary report type to retrieve.
557
+ */
558
+ reportType: 'balance_sheet_budget_overview' | 'balance_sheet_budget_vs_actual' | 'profit_and_loss_budget_overview' | 'profit_and_loss_budget_performance' | 'profit_and_loss_budget_vs_actual';
559
+ /**
560
+ * Header param: The ID of the End-User to receive this request.
561
+ */
562
+ conductorEndUserId: string;
563
+ /**
564
+ * Query param: What the budget covers, such as accounts, accounts and classes, or
565
+ * accounts and customers.
566
+ */
567
+ budgetCriterion?: 'accounts' | 'accounts_and_classes' | 'accounts_and_customers';
568
+ /**
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`.
573
+ */
574
+ classFullNames?: Array<string>;
575
+ /**
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`.
579
+ */
580
+ classIds?: Array<string>;
581
+ /**
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.
586
+ */
587
+ reportDateFrom?: string;
588
+ /**
589
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
590
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
591
+ */
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';
593
+ /**
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.
598
+ */
599
+ reportDateTo?: string;
600
+ /**
601
+ * Query param: How QuickBooks Desktop calculates budget report columns and labels
602
+ * column headers.
603
+ */
604
+ summarizeColumnsBy?: 'class' | 'customer' | 'date';
605
+ /**
606
+ * Query param: How QuickBooks Desktop labels budget report rows.
607
+ */
608
+ summarizeRowsBy?: 'account' | 'class' | 'customer';
609
+ }
610
+ export interface ReportCustomDetailParams {
611
+ /**
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.
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'>;
617
+ /**
618
+ * Query param: How QuickBooks Desktop calculates report data and labels report
619
+ * rows.
620
+ */
621
+ 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';
622
+ /**
623
+ * Header param: The ID of the End-User to receive this request.
624
+ */
625
+ conductorEndUserId: string;
626
+ /**
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`.
632
+ */
633
+ accountFullNames?: Array<string>;
634
+ /**
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`.
638
+ */
639
+ accountIds?: Array<string>;
640
+ /**
641
+ * Query param: Whether to include all accounts or only accounts in use.
642
+ */
643
+ accountsToInclude?: 'all' | 'in_use';
644
+ /**
645
+ * Query param: Filter report rows by account type. Choose only one account filter
646
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
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';
649
+ /**
650
+ * Query param: The accounting basis to use for the report. Use `cash` to base
651
+ * income and expenses on when money changes hands, `accrual` to base them on
652
+ * invoice and bill dates, or `none` to use the QuickBooks Desktop default for the
653
+ * report.
654
+ */
655
+ basis?: 'accrual' | 'cash' | 'none';
656
+ /**
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
+ */
662
+ classFullNames?: Array<string>;
663
+ /**
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
+ */
668
+ classIds?: Array<string>;
669
+ /**
670
+ * Query param: The report detail level to include. Use `all` for all rows,
671
+ * `all_except_summary` to omit summary rows, or `summary_only` to return only
672
+ * summary rows.
673
+ */
674
+ detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
675
+ /**
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
+ */
682
+ entityFullNames?: Array<string>;
683
+ /**
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
+ */
688
+ entityIds?: Array<string>;
689
+ /**
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`.
693
+ */
694
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
695
+ /**
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`.
701
+ */
702
+ itemFullNames?: Array<string>;
703
+ /**
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`.
707
+ */
708
+ itemIds?: Array<string>;
709
+ /**
710
+ * Query param: Filter report rows by item type. Choose only one item filter per
711
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
712
+ */
713
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
714
+ /**
715
+ * Query param: The date through which QuickBooks Desktop calculates open balance
716
+ * information.
717
+ */
718
+ openBalanceAsOf?: 'report_end_date' | 'today';
719
+ /**
720
+ * Query param: Filter report rows that are posting, non-posting, or either.
721
+ * Posting status refers to whether QuickBooks records the transaction in an
722
+ * account register.
723
+ */
724
+ postingStatus?: 'either' | 'non_posting' | 'posting';
725
+ /**
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.
730
+ */
731
+ reportDateFrom?: string;
732
+ /**
733
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
734
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
735
+ */
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';
737
+ /**
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.
742
+ */
743
+ reportDateTo?: string;
744
+ /**
745
+ * Query param: The custom detail report type to retrieve. This endpoint supports
746
+ * only `custom_transaction_detail`, so this parameter is optional and defaults to
747
+ * `custom_transaction_detail`.
748
+ */
749
+ reportType?: 'custom_transaction_detail';
750
+ /**
751
+ * Query param: Filter report rows by transaction type. Accepts one or more
752
+ * transaction types.
753
+ */
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'>;
755
+ /**
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`.
759
+ */
760
+ updatedAfter?: string;
761
+ /**
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`.
765
+ */
766
+ updatedBefore?: string;
767
+ /**
768
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
769
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
770
+ */
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';
772
+ }
773
+ export interface ReportCustomSummaryParams {
774
+ /**
775
+ * Query param: How QuickBooks Desktop calculates report data and labels report
776
+ * column headers.
777
+ */
778
+ 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';
779
+ /**
780
+ * Query param: How QuickBooks Desktop calculates report data and labels report
781
+ * rows.
782
+ */
783
+ 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';
784
+ /**
785
+ * Header param: The ID of the End-User to receive this request.
786
+ */
787
+ conductorEndUserId: string;
788
+ /**
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`.
794
+ */
795
+ accountFullNames?: Array<string>;
796
+ /**
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`.
800
+ */
801
+ accountIds?: Array<string>;
802
+ /**
803
+ * Query param: Filter report rows by account type. Choose only one account filter
804
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
805
+ */
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';
807
+ /**
808
+ * Query param: The accounting basis to use for the report. Use `cash` to base
809
+ * income and expenses on when money changes hands, `accrual` to base them on
810
+ * invoice and bill dates, or `none` to use the QuickBooks Desktop default for the
811
+ * report.
812
+ */
813
+ basis?: 'accrual' | 'cash' | 'none';
814
+ /**
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`.
819
+ */
820
+ classFullNames?: Array<string>;
821
+ /**
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`.
825
+ */
826
+ classIds?: Array<string>;
827
+ /**
828
+ * Query param: Filters which report columns QuickBooks returns. Use `active_only`
829
+ * for active columns, `non_zero` for columns with non-zero values, or `all` for
830
+ * all columns.
831
+ */
832
+ columnsToReturn?: 'active_only' | 'non_zero' | 'all';
833
+ /**
834
+ * Query param: The report detail level to include. Use `all` for all rows,
835
+ * `all_except_summary` to omit summary rows, or `summary_only` to return only
836
+ * summary rows.
837
+ */
838
+ detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
839
+ /**
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`.
845
+ */
846
+ entityFullNames?: Array<string>;
847
+ /**
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`.
851
+ */
852
+ entityIds?: Array<string>;
853
+ /**
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`.
857
+ */
858
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
859
+ /**
860
+ * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
861
+ * still omit subcolumns that it can easily compute from other returned values.
862
+ */
863
+ includeSubcolumns?: boolean;
864
+ /**
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`.
870
+ */
871
+ itemFullNames?: Array<string>;
872
+ /**
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`.
876
+ */
877
+ itemIds?: Array<string>;
878
+ /**
879
+ * Query param: Filter report rows by item type. Choose only one item filter per
880
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
881
+ */
882
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
883
+ /**
884
+ * Query param: Filter report rows that are posting, non-posting, or either.
885
+ * Posting status refers to whether QuickBooks records the transaction in an
886
+ * account register.
887
+ */
888
+ postingStatus?: 'either' | 'non_posting' | 'posting';
889
+ /**
890
+ * Query param: The type of year to use for the report.
891
+ */
892
+ reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
893
+ /**
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.
898
+ */
899
+ reportDateFrom?: string;
900
+ /**
901
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
902
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
903
+ */
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';
905
+ /**
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.
910
+ */
911
+ reportDateTo?: string;
912
+ /**
913
+ * Query param: The custom summary report type to retrieve. This endpoint supports
914
+ * only `custom_summary`, so this parameter is optional and defaults to
915
+ * `custom_summary`.
916
+ */
917
+ reportType?: 'custom_summary';
918
+ /**
919
+ * Query param: Filters which report rows QuickBooks returns. Use `active_only` for
920
+ * active rows, `non_zero` for rows with non-zero values, or `all` for all rows.
921
+ */
922
+ rowsToReturn?: 'active_only' | 'non_zero' | 'all';
923
+ /**
924
+ * Query param: Filter report rows by transaction type. Accepts one or more
925
+ * transaction types.
926
+ */
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'>;
928
+ /**
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`.
932
+ */
933
+ updatedAfter?: string;
934
+ /**
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`.
938
+ */
939
+ updatedBefore?: string;
940
+ /**
941
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
942
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
943
+ */
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';
945
+ }
946
+ export interface ReportGeneralDetailParams {
947
+ /**
948
+ * Query param: The general detail report type to retrieve.
949
+ */
950
+ reportType: '1099_detail' | 'audit_trail' | 'balance_sheet_detail' | 'check_detail' | 'customer_balance_detail' | 'deposit_detail' | 'estimates_by_job' | 'expense_by_vendor_detail' | 'general_ledger' | 'income_by_customer_detail' | 'income_tax_detail' | 'inventory_valuation_detail' | 'job_progress_invoices_vs_estimates' | 'journal' | 'missing_checks' | 'open_invoices' | 'open_purchase_orders' | 'open_purchase_orders_by_job' | 'open_sales_order_by_customer' | 'open_sales_order_by_item' | 'pending_sales' | 'profit_and_loss_detail' | 'purchase_by_item_detail' | 'purchase_by_vendor_detail' | 'sales_by_customer_detail' | 'sales_by_item_detail' | 'sales_by_sales_representative_detail' | 'transaction_detail_by_account' | 'transaction_list_by_customer' | 'transaction_list_by_date' | 'transaction_list_by_vendor' | 'unpaid_bills_detail' | 'unbilled_costs_by_job' | 'vendor_balance_detail';
951
+ /**
952
+ * Header param: The ID of the End-User to receive this request.
953
+ */
954
+ conductorEndUserId: string;
955
+ /**
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`.
961
+ */
962
+ accountFullNames?: Array<string>;
963
+ /**
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`.
967
+ */
968
+ accountIds?: Array<string>;
969
+ /**
970
+ * Query param: Whether to include all accounts or only accounts in use.
971
+ */
972
+ accountsToInclude?: 'all' | 'in_use';
973
+ /**
974
+ * Query param: Filter report rows by account type. Choose only one account filter
975
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
976
+ */
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';
978
+ /**
979
+ * Query param: The accounting basis to use for the report. Use `cash` to base
980
+ * income and expenses on when money changes hands, `accrual` to base them on
981
+ * invoice and bill dates, or `none` to use the QuickBooks Desktop default for the
982
+ * report.
983
+ */
984
+ basis?: 'accrual' | 'cash' | 'none';
985
+ /**
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`.
990
+ */
991
+ classFullNames?: Array<string>;
992
+ /**
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`.
996
+ */
997
+ classIds?: Array<string>;
998
+ /**
999
+ * Query param: The report detail level to include. Use `all` for all rows,
1000
+ * `all_except_summary` to omit summary rows, or `summary_only` to return only
1001
+ * summary rows.
1002
+ */
1003
+ detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1004
+ /**
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`.
1010
+ */
1011
+ entityFullNames?: Array<string>;
1012
+ /**
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`.
1016
+ */
1017
+ entityIds?: Array<string>;
1018
+ /**
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`.
1022
+ */
1023
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1024
+ /**
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.
1028
+ */
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'>;
1030
+ /**
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`.
1036
+ */
1037
+ itemFullNames?: Array<string>;
1038
+ /**
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`.
1042
+ */
1043
+ itemIds?: Array<string>;
1044
+ /**
1045
+ * Query param: Filter report rows by item type. Choose only one item filter per
1046
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1047
+ */
1048
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1049
+ /**
1050
+ * Query param: The date through which QuickBooks Desktop calculates open balance
1051
+ * information.
1052
+ */
1053
+ openBalanceAsOf?: 'report_end_date' | 'today';
1054
+ /**
1055
+ * Query param: Filter report rows that are posting, non-posting, or either.
1056
+ * Posting status refers to whether QuickBooks records the transaction in an
1057
+ * account register.
1058
+ */
1059
+ postingStatus?: 'either' | 'non_posting' | 'posting';
1060
+ /**
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.
1065
+ */
1066
+ reportDateFrom?: string;
1067
+ /**
1068
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1069
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1070
+ */
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';
1072
+ /**
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.
1077
+ */
1078
+ reportDateTo?: string;
1079
+ /**
1080
+ * Query param: How QuickBooks Desktop calculates report data and labels report
1081
+ * rows.
1082
+ */
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';
1084
+ /**
1085
+ * Query param: Filter report rows by transaction type. Accepts one or more
1086
+ * transaction types.
1087
+ */
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'>;
1089
+ /**
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`.
1093
+ */
1094
+ updatedAfter?: string;
1095
+ /**
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`.
1099
+ */
1100
+ updatedBefore?: string;
1101
+ /**
1102
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1103
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1104
+ */
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';
1106
+ }
1107
+ export interface ReportGeneralSummaryParams {
1108
+ /**
1109
+ * Query param: The general summary report type to retrieve.
1110
+ */
1111
+ reportType: 'balance_sheet_by_class' | 'balance_sheet_previous_year_comparison' | 'balance_sheet_standard' | 'balance_sheet_summary' | 'customer_balance_summary' | 'expense_by_vendor_summary' | 'income_by_customer_summary' | 'inventory_stock_status_by_item' | 'inventory_stock_status_by_vendor' | 'income_tax_summary' | 'inventory_valuation_summary' | 'inventory_valuation_summary_by_site' | 'lot_number_in_stock_by_site' | 'physical_inventory_worksheet' | 'profit_and_loss_by_class' | 'profit_and_loss_by_job' | 'profit_and_loss_previous_year_comparison' | 'profit_and_loss_standard' | 'profit_and_loss_ytd_comparison' | 'purchase_by_item_summary' | 'purchase_by_vendor_summary' | 'sales_by_customer_summary' | 'sales_by_item_summary' | 'sales_by_sales_representative_summary' | 'sales_tax_liability' | 'sales_tax_revenue_summary' | 'serial_number_in_stock_by_site' | 'trial_balance' | 'vendor_balance_summary';
1112
+ /**
1113
+ * Header param: The ID of the End-User to receive this request.
1114
+ */
1115
+ conductorEndUserId: string;
1116
+ /**
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`.
1122
+ */
1123
+ accountFullNames?: Array<string>;
1124
+ /**
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`.
1128
+ */
1129
+ accountIds?: Array<string>;
1130
+ /**
1131
+ * Query param: Filter report rows by account type. Choose only one account filter
1132
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1133
+ */
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';
1135
+ /**
1136
+ * Query param: The accounting basis to use for the report. Use `cash` to base
1137
+ * income and expenses on when money changes hands, `accrual` to base them on
1138
+ * invoice and bill dates, or `none` to use the QuickBooks Desktop default for the
1139
+ * report.
1140
+ */
1141
+ basis?: 'accrual' | 'cash' | 'none';
1142
+ /**
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`.
1147
+ */
1148
+ classFullNames?: Array<string>;
1149
+ /**
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`.
1153
+ */
1154
+ classIds?: Array<string>;
1155
+ /**
1156
+ * Query param: Filters which report columns QuickBooks returns. Use `active_only`
1157
+ * for active columns, `non_zero` for columns with non-zero values, or `all` for
1158
+ * all columns.
1159
+ */
1160
+ columnsToReturn?: 'active_only' | 'non_zero' | 'all';
1161
+ /**
1162
+ * Query param: The report detail level to include. Use `all` for all rows,
1163
+ * `all_except_summary` to omit summary rows, or `summary_only` to return only
1164
+ * summary rows.
1165
+ */
1166
+ detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1167
+ /**
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`.
1173
+ */
1174
+ entityFullNames?: Array<string>;
1175
+ /**
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`.
1179
+ */
1180
+ entityIds?: Array<string>;
1181
+ /**
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`.
1185
+ */
1186
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1187
+ /**
1188
+ * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1189
+ * still omit subcolumns that it can easily compute from other returned values.
1190
+ */
1191
+ includeSubcolumns?: boolean;
1192
+ /**
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`.
1198
+ */
1199
+ itemFullNames?: Array<string>;
1200
+ /**
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`.
1204
+ */
1205
+ itemIds?: Array<string>;
1206
+ /**
1207
+ * Query param: Filter report rows by item type. Choose only one item filter per
1208
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1209
+ */
1210
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1211
+ /**
1212
+ * Query param: Filter report rows that are posting, non-posting, or either.
1213
+ * Posting status refers to whether QuickBooks records the transaction in an
1214
+ * account register.
1215
+ */
1216
+ postingStatus?: 'either' | 'non_posting' | 'posting';
1217
+ /**
1218
+ * Query param: The type of year to use for the report.
1219
+ */
1220
+ reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1221
+ /**
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.
1226
+ */
1227
+ reportDateFrom?: string;
1228
+ /**
1229
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1230
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1231
+ */
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';
1233
+ /**
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.
1238
+ */
1239
+ reportDateTo?: string;
1240
+ /**
1241
+ * Query param: Filters which report rows QuickBooks returns. Use `active_only` for
1242
+ * active rows, `non_zero` for rows with non-zero values, or `all` for all rows.
1243
+ */
1244
+ rowsToReturn?: 'active_only' | 'non_zero' | 'all';
1245
+ /**
1246
+ * Query param: How QuickBooks Desktop calculates report data and labels report
1247
+ * column headers.
1248
+ */
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';
1250
+ /**
1251
+ * Query param: Filter report rows by transaction type. Accepts one or more
1252
+ * transaction types.
1253
+ */
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'>;
1255
+ /**
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`.
1259
+ */
1260
+ updatedAfter?: string;
1261
+ /**
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`.
1265
+ */
1266
+ updatedBefore?: string;
1267
+ /**
1268
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1269
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1270
+ */
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';
1272
+ }
1273
+ export interface ReportJobParams {
1274
+ /**
1275
+ * Query param: The job report type to retrieve.
1276
+ */
1277
+ reportType: 'item_estimates_vs_actuals' | 'item_profitability' | 'job_estimates_vs_actuals_detail' | 'job_estimates_vs_actuals_summary' | 'job_profitability_detail' | 'job_profitability_summary';
1278
+ /**
1279
+ * Header param: The ID of the End-User to receive this request.
1280
+ */
1281
+ conductorEndUserId: string;
1282
+ /**
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`.
1288
+ */
1289
+ accountFullNames?: Array<string>;
1290
+ /**
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`.
1294
+ */
1295
+ accountIds?: Array<string>;
1296
+ /**
1297
+ * Query param: Filter report rows by account type. Choose only one account filter
1298
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1299
+ */
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';
1301
+ /**
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`.
1306
+ */
1307
+ classFullNames?: Array<string>;
1308
+ /**
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`.
1312
+ */
1313
+ classIds?: Array<string>;
1314
+ /**
1315
+ * Query param: The report detail level to include. Use `all` for all rows,
1316
+ * `all_except_summary` to omit summary rows, or `summary_only` to return only
1317
+ * summary rows.
1318
+ */
1319
+ detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1320
+ /**
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`.
1326
+ */
1327
+ entityFullNames?: Array<string>;
1328
+ /**
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`.
1332
+ */
1333
+ entityIds?: Array<string>;
1334
+ /**
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`.
1338
+ */
1339
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1340
+ /**
1341
+ * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1342
+ * still omit subcolumns that it can easily compute from other returned values.
1343
+ */
1344
+ includeSubcolumns?: boolean;
1345
+ /**
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`.
1351
+ */
1352
+ itemFullNames?: Array<string>;
1353
+ /**
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`.
1357
+ */
1358
+ itemIds?: Array<string>;
1359
+ /**
1360
+ * Query param: Filter report rows by item type. Choose only one item filter per
1361
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1362
+ */
1363
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1364
+ /**
1365
+ * Query param: Filter report rows that are posting, non-posting, or either.
1366
+ * Posting status refers to whether QuickBooks records the transaction in an
1367
+ * account register.
1368
+ */
1369
+ postingStatus?: 'either' | 'non_posting' | 'posting';
1370
+ /**
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.
1375
+ */
1376
+ reportDateFrom?: string;
1377
+ /**
1378
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1379
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1380
+ */
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';
1382
+ /**
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.
1387
+ */
1388
+ reportDateTo?: string;
1389
+ /**
1390
+ * Query param: How QuickBooks Desktop calculates report data and labels report
1391
+ * column headers.
1392
+ */
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';
1394
+ /**
1395
+ * Query param: Filter report rows by transaction type. Accepts one or more
1396
+ * transaction types.
1397
+ */
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'>;
1399
+ /**
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`.
1403
+ */
1404
+ updatedAfter?: string;
1405
+ /**
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`.
1409
+ */
1410
+ updatedBefore?: string;
1411
+ /**
1412
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1413
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1414
+ */
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';
1416
+ }
1417
+ export interface ReportPayrollDetailParams {
1418
+ /**
1419
+ * Query param: The payroll detail report type to retrieve.
1420
+ */
1421
+ reportType: 'employee_state_taxes_detail' | 'payroll_item_detail' | 'payroll_review_detail' | 'payroll_transaction_detail' | 'payroll_transactions_by_payee';
1422
+ /**
1423
+ * Header param: The ID of the End-User to receive this request.
1424
+ */
1425
+ conductorEndUserId: string;
1426
+ /**
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`.
1432
+ */
1433
+ accountFullNames?: Array<string>;
1434
+ /**
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`.
1438
+ */
1439
+ accountIds?: Array<string>;
1440
+ /**
1441
+ * Query param: Whether to include all accounts or only accounts in use.
1442
+ */
1443
+ accountsToInclude?: 'all' | 'in_use';
1444
+ /**
1445
+ * Query param: Filter report rows by account type. Choose only one account filter
1446
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1447
+ */
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';
1449
+ /**
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`.
1454
+ */
1455
+ classFullNames?: Array<string>;
1456
+ /**
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`.
1460
+ */
1461
+ classIds?: Array<string>;
1462
+ /**
1463
+ * Query param: The report detail level to include. Use `all` for all rows,
1464
+ * `all_except_summary` to omit summary rows, or `summary_only` to return only
1465
+ * summary rows.
1466
+ */
1467
+ detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1468
+ /**
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`.
1474
+ */
1475
+ entityFullNames?: Array<string>;
1476
+ /**
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`.
1480
+ */
1481
+ entityIds?: Array<string>;
1482
+ /**
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`.
1486
+ */
1487
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1488
+ /**
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.
1492
+ */
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'>;
1494
+ /**
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`.
1500
+ */
1501
+ itemFullNames?: Array<string>;
1502
+ /**
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`.
1506
+ */
1507
+ itemIds?: Array<string>;
1508
+ /**
1509
+ * Query param: Filter report rows by item type. Choose only one item filter per
1510
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1511
+ */
1512
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1513
+ /**
1514
+ * Query param: The date through which QuickBooks Desktop calculates open balance
1515
+ * information.
1516
+ */
1517
+ openBalanceAsOf?: 'report_end_date' | 'today';
1518
+ /**
1519
+ * Query param: Filter report rows that are posting, non-posting, or either.
1520
+ * Posting status refers to whether QuickBooks records the transaction in an
1521
+ * account register.
1522
+ */
1523
+ postingStatus?: 'either' | 'non_posting' | 'posting';
1524
+ /**
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.
1529
+ */
1530
+ reportDateFrom?: string;
1531
+ /**
1532
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1533
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1534
+ */
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';
1536
+ /**
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.
1541
+ */
1542
+ reportDateTo?: string;
1543
+ /**
1544
+ * Query param: How QuickBooks Desktop calculates report data and labels report
1545
+ * rows.
1546
+ */
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';
1548
+ /**
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`.
1552
+ */
1553
+ updatedAfter?: string;
1554
+ /**
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`.
1558
+ */
1559
+ updatedBefore?: string;
1560
+ /**
1561
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1562
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1563
+ */
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';
1565
+ }
1566
+ export interface ReportPayrollSummaryParams {
1567
+ /**
1568
+ * Query param: The payroll summary report type to retrieve.
1569
+ */
1570
+ reportType: 'employee_earnings_summary' | 'payroll_liability_balances' | 'payroll_summary';
1571
+ /**
1572
+ * Header param: The ID of the End-User to receive this request.
1573
+ */
1574
+ conductorEndUserId: string;
1575
+ /**
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`.
1581
+ */
1582
+ accountFullNames?: Array<string>;
1583
+ /**
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`.
1587
+ */
1588
+ accountIds?: Array<string>;
1589
+ /**
1590
+ * Query param: Filter report rows by account type. Choose only one account filter
1591
+ * per request: `accountType`, `accountIds`, or `accountFullNames`.
1592
+ */
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';
1594
+ /**
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`.
1599
+ */
1600
+ classFullNames?: Array<string>;
1601
+ /**
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`.
1605
+ */
1606
+ classIds?: Array<string>;
1607
+ /**
1608
+ * Query param: Filters which report columns QuickBooks returns. Use `active_only`
1609
+ * for active columns, `non_zero` for columns with non-zero values, or `all` for
1610
+ * all columns.
1611
+ */
1612
+ columnsToReturn?: 'active_only' | 'non_zero' | 'all';
1613
+ /**
1614
+ * Query param: The report detail level to include. Use `all` for all rows,
1615
+ * `all_except_summary` to omit summary rows, or `summary_only` to return only
1616
+ * summary rows.
1617
+ */
1618
+ detailLevel?: 'all' | 'all_except_summary' | 'summary_only';
1619
+ /**
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`.
1625
+ */
1626
+ entityFullNames?: Array<string>;
1627
+ /**
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`.
1631
+ */
1632
+ entityIds?: Array<string>;
1633
+ /**
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`.
1637
+ */
1638
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1639
+ /**
1640
+ * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1641
+ * still omit subcolumns that it can easily compute from other returned values.
1642
+ */
1643
+ includeSubcolumns?: boolean;
1644
+ /**
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`.
1650
+ */
1651
+ itemFullNames?: Array<string>;
1652
+ /**
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`.
1656
+ */
1657
+ itemIds?: Array<string>;
1658
+ /**
1659
+ * Query param: Filter report rows by item type. Choose only one item filter per
1660
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1661
+ */
1662
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1663
+ /**
1664
+ * Query param: Filter report rows that are posting, non-posting, or either.
1665
+ * Posting status refers to whether QuickBooks records the transaction in an
1666
+ * account register.
1667
+ */
1668
+ postingStatus?: 'either' | 'non_posting' | 'posting';
1669
+ /**
1670
+ * Query param: The type of year to use for the report.
1671
+ */
1672
+ reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1673
+ /**
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.
1678
+ */
1679
+ reportDateFrom?: string;
1680
+ /**
1681
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1682
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1683
+ */
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';
1685
+ /**
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.
1690
+ */
1691
+ reportDateTo?: string;
1692
+ /**
1693
+ * Query param: Filters which report rows QuickBooks returns. Use `active_only` for
1694
+ * active rows, `non_zero` for rows with non-zero values, or `all` for all rows.
1695
+ */
1696
+ rowsToReturn?: 'active_only' | 'non_zero' | 'all';
1697
+ /**
1698
+ * Query param: How QuickBooks Desktop calculates report data and labels report
1699
+ * column headers.
1700
+ */
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';
1702
+ /**
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`.
1706
+ */
1707
+ updatedAfter?: string;
1708
+ /**
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`.
1712
+ */
1713
+ updatedBefore?: string;
1714
+ /**
1715
+ * Query param: A QuickBooks Desktop relative updated-date macro. Choose either
1716
+ * `updatedDateMacro` or `updatedAfter`/`updatedBefore`.
1717
+ */
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';
1719
+ }
1720
+ export interface ReportTimeParams {
1721
+ /**
1722
+ * Query param: The time report type to retrieve.
1723
+ */
1724
+ reportType: 'time_by_item' | 'time_by_job_detail' | 'time_by_job_summary' | 'time_by_name';
1725
+ /**
1726
+ * Header param: The ID of the End-User to receive this request.
1727
+ */
1728
+ conductorEndUserId: string;
1729
+ /**
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`.
1734
+ */
1735
+ classFullNames?: Array<string>;
1736
+ /**
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`.
1740
+ */
1741
+ classIds?: Array<string>;
1742
+ /**
1743
+ * Query param: Filters which report columns QuickBooks returns. Use `active_only`
1744
+ * for active columns, `non_zero` for columns with non-zero values, or `all` for
1745
+ * all columns.
1746
+ */
1747
+ columnsToReturn?: 'active_only' | 'non_zero' | 'all';
1748
+ /**
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`.
1754
+ */
1755
+ entityFullNames?: Array<string>;
1756
+ /**
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`.
1760
+ */
1761
+ entityIds?: Array<string>;
1762
+ /**
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`.
1766
+ */
1767
+ entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1768
+ /**
1769
+ * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1770
+ * still omit subcolumns that it can easily compute from other returned values.
1771
+ */
1772
+ includeSubcolumns?: boolean;
1773
+ /**
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`.
1779
+ */
1780
+ itemFullNames?: Array<string>;
1781
+ /**
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`.
1785
+ */
1786
+ itemIds?: Array<string>;
1787
+ /**
1788
+ * Query param: Filter report rows by item type. Choose only one item filter per
1789
+ * request: `itemType`, `itemIds`, or `itemFullNames`.
1790
+ */
1791
+ itemType?: 'all_except_fixed_asset' | 'assembly' | 'discount' | 'fixed_asset' | 'inventory' | 'inventory_and_assembly' | 'non_inventory' | 'other_charge' | 'payment' | 'sales' | 'sales_tax' | 'service';
1792
+ /**
1793
+ * Query param: The type of year to use for the report.
1794
+ */
1795
+ reportCalendar?: 'calendar_year' | 'fiscal_year' | 'tax_year';
1796
+ /**
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.
1801
+ */
1802
+ reportDateFrom?: string;
1803
+ /**
1804
+ * Query param: A QuickBooks Desktop relative date macro for the report period.
1805
+ * Choose either `reportDateMacro` or `reportDateFrom`/`reportDateTo`.
1806
+ */
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';
1808
+ /**
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.
1813
+ */
1814
+ reportDateTo?: string;
1815
+ /**
1816
+ * Query param: Filters which report rows QuickBooks returns. Use `active_only` for
1817
+ * active rows, `non_zero` for rows with non-zero values, or `all` for all rows.
1818
+ */
1819
+ rowsToReturn?: 'active_only' | 'non_zero' | 'all';
1820
+ /**
1821
+ * Query param: How QuickBooks Desktop calculates report data and labels report
1822
+ * column headers.
1823
+ */
1824
+ 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';
1825
+ }
1826
+ export declare namespace Reports {
1827
+ export { type Report as Report, type ReportAgingParams as ReportAgingParams, type ReportBudgetSummaryParams as ReportBudgetSummaryParams, type ReportCustomDetailParams as ReportCustomDetailParams, type ReportCustomSummaryParams as ReportCustomSummaryParams, type ReportGeneralDetailParams as ReportGeneralDetailParams, type ReportGeneralSummaryParams as ReportGeneralSummaryParams, type ReportJobParams as ReportJobParams, type ReportPayrollDetailParams as ReportPayrollDetailParams, type ReportPayrollSummaryParams as ReportPayrollSummaryParams, type ReportTimeParams as ReportTimeParams, };
1828
+ }
1829
+ //# sourceMappingURL=reports.d.ts.map