conductor-node 14.14.0 → 14.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,7 +3,10 @@ import { APIResource } from "../../core/resource.mjs";
3
3
  import { buildHeaders } from "../../internal/headers.mjs";
4
4
  export class Reports extends APIResource {
5
5
  /**
6
- * Retrieves an aging report.
6
+ * Retrieves an accounts receivable, accounts payable, or collections aging report
7
+ * showing unpaid invoices and bills by aging criteria. This report is useful for
8
+ * analyzing receivables, payables, and collection work across summary or detail
9
+ * aging views.
7
10
  *
8
11
  * @example
9
12
  * ```ts
@@ -22,7 +25,11 @@ export class Reports extends APIResource {
22
25
  });
23
26
  }
24
27
  /**
25
- * Retrieves a budget summary report.
28
+ * Retrieves a QuickBooks Desktop budget summary report for Balance Sheet or Profit
29
+ * and Loss budgets, including budget overview, budget versus actual, and
30
+ * performance views. This report compares budgeted amounts against actual activity
31
+ * for a fiscal year and budget criterion; the target budget must already exist in
32
+ * QuickBooks Desktop.
26
33
  *
27
34
  * @example
28
35
  * ```ts
@@ -42,7 +49,10 @@ export class Reports extends APIResource {
42
49
  });
43
50
  }
44
51
  /**
45
- * Retrieves a custom detail report.
52
+ * Retrieves a custom transaction detail report built from the row grouping,
53
+ * included columns, date period, and filters you request. This report is useful
54
+ * when no preset detail report exposes the transaction rows or report-only columns
55
+ * you need; QuickBooks Desktop does not choose default columns for this report.
46
56
  *
47
57
  * @example
48
58
  * ```ts
@@ -62,7 +72,10 @@ export class Reports extends APIResource {
62
72
  });
63
73
  }
64
74
  /**
65
- * Retrieves a custom summary report.
75
+ * Retrieves a custom summary report built from the row and column axes, filters,
76
+ * date period, calendar, and basis options you request. This report is useful when
77
+ * preset summary reports do not match the dimensions you need; QuickBooks Desktop
78
+ * does not assume a default layout.
66
79
  *
67
80
  * @example
68
81
  * ```ts
@@ -82,7 +95,12 @@ export class Reports extends APIResource {
82
95
  });
83
96
  }
84
97
  /**
85
- * Retrieves a general detail report.
98
+ * Retrieves a QuickBooks Desktop general detail report with transaction-level
99
+ * rows, such as General Ledger, Journal, Open Invoices, unpaid bills, sales
100
+ * detail, purchase detail, audit trail, and transaction lists. This report is
101
+ * useful for inspecting the transactions behind balances, receivables, payables,
102
+ * sales, purchases, inventory valuation, and audit activity, including report-only
103
+ * columns that may not be available from standard object queries.
86
104
  *
87
105
  * @example
88
106
  * ```ts
@@ -101,7 +119,11 @@ export class Reports extends APIResource {
101
119
  });
102
120
  }
103
121
  /**
104
- * Retrieves a general summary report.
122
+ * Retrieves a QuickBooks Desktop general summary report, such as a balance sheet,
123
+ * profit and loss, trial balance, sales, purchase, inventory, customer balance,
124
+ * vendor balance, sales tax, or income tax summary. This report is useful for
125
+ * aggregated financial or operational totals with optional date periods, filters,
126
+ * calendar settings, and column summarization.
105
127
  *
106
128
  * @example
107
129
  * ```ts
@@ -120,7 +142,11 @@ export class Reports extends APIResource {
120
142
  });
121
143
  }
122
144
  /**
123
- * Retrieves a job report.
145
+ * Retrieves a QuickBooks Desktop job report for estimates versus actuals, item
146
+ * profitability, or job profitability. This report is useful for project costing,
147
+ * margin analysis, and estimate tracking by customer or job; job profitability
148
+ * detail and estimates-versus-actuals detail report types require a customer or
149
+ * job filter.
124
150
  *
125
151
  * @example
126
152
  * ```ts
@@ -139,7 +165,11 @@ export class Reports extends APIResource {
139
165
  });
140
166
  }
141
167
  /**
142
- * Retrieves a payroll detail report.
168
+ * Retrieves a QuickBooks Desktop payroll detail report, including employee state
169
+ * tax detail, payroll item detail, payroll review detail, payroll transaction
170
+ * detail, and payroll transactions by payee. This report is useful for auditing
171
+ * paycheck line items, payroll item usage, tax calculations, and payee-level
172
+ * payroll activity.
143
173
  *
144
174
  * @example
145
175
  * ```ts
@@ -158,7 +188,10 @@ export class Reports extends APIResource {
158
188
  });
159
189
  }
160
190
  /**
161
- * Retrieves a payroll summary report.
191
+ * Retrieves a QuickBooks Desktop payroll summary report, including payroll totals
192
+ * by employee, employee earnings by payroll item, and payroll liability balances.
193
+ * This report is useful for wage, tax, deduction, addition, employer contribution,
194
+ * and unpaid payroll liability reporting.
162
195
  *
163
196
  * @example
164
197
  * ```ts
@@ -177,7 +210,9 @@ export class Reports extends APIResource {
177
210
  });
178
211
  }
179
212
  /**
180
- * Retrieves a time report.
213
+ * Retrieves a QuickBooks Desktop time report by item, job, or name, with summary
214
+ * or detail rows depending on the selected report type. This report is useful for
215
+ * analyzing tracked time for billing, costing, staffing, or project review.
181
216
  *
182
217
  * @example
183
218
  * ```ts
@@ -1 +1 @@
1
- {"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../../src/resources/qbd/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAyB,EAAE,OAAwB;QACvD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE;YAC3D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,MAAiC,EAAE,OAAwB;QACvE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE;YACpE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,MAAgC,EAAE,OAAwB;QACrE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2CAA2C,EAAE;YACnE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,MAAiC,EAAE,OAAwB;QACvE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE;YACpE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAC,MAAiC,EAAE,OAAwB;QACvE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE;YACpE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAAkC,EAAE,OAAwB;QACzE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6CAA6C,EAAE;YACrE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAuB,EAAE,OAAwB;QACnD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,EAAE;YACzD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAC,MAAiC,EAAE,OAAwB;QACvE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE;YACpE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,MAAkC,EAAE,OAAwB;QACzE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6CAA6C,EAAE;YACrE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,MAAwB,EAAE,OAAwB;QACrD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE;YAC1D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"reports.mjs","sourceRoot":"","sources":["../../src/resources/qbd/reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAyB,EAAE,OAAwB;QACvD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE;YAC3D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,MAAiC,EAAE,OAAwB;QACvE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE;YACpE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,MAAgC,EAAE,OAAwB;QACrE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2CAA2C,EAAE;YACnE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,MAAiC,EAAE,OAAwB;QACvE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE;YACpE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,MAAiC,EAAE,OAAwB;QACvE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE;YACpE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,MAAkC,EAAE,OAAwB;QACzE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6CAA6C,EAAE;YACrE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,MAAuB,EAAE,OAAwB;QACnD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,EAAE;YACzD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,MAAiC,EAAE,OAAwB;QACvE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE;YACpE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,MAAkC,EAAE,OAAwB;QACzE,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6CAA6C,EAAE;YACrE,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAwB,EAAE,OAAwB;QACrD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE;YAC1D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3F,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -7,7 +7,10 @@ import { RequestOptions } from '../../internal/request-options';
7
7
 
8
8
  export class Reports extends APIResource {
9
9
  /**
10
- * Retrieves an aging report.
10
+ * Retrieves an accounts receivable, accounts payable, or collections aging report
11
+ * showing unpaid invoices and bills by aging criteria. This report is useful for
12
+ * analyzing receivables, payables, and collection work across summary or detail
13
+ * aging views.
11
14
  *
12
15
  * @example
13
16
  * ```ts
@@ -27,7 +30,11 @@ export class Reports extends APIResource {
27
30
  }
28
31
 
29
32
  /**
30
- * Retrieves a budget summary report.
33
+ * Retrieves a QuickBooks Desktop budget summary report for Balance Sheet or Profit
34
+ * and Loss budgets, including budget overview, budget versus actual, and
35
+ * performance views. This report compares budgeted amounts against actual activity
36
+ * for a fiscal year and budget criterion; the target budget must already exist in
37
+ * QuickBooks Desktop.
31
38
  *
32
39
  * @example
33
40
  * ```ts
@@ -48,7 +55,10 @@ export class Reports extends APIResource {
48
55
  }
49
56
 
50
57
  /**
51
- * Retrieves a custom detail report.
58
+ * Retrieves a custom transaction detail report built from the row grouping,
59
+ * included columns, date period, and filters you request. This report is useful
60
+ * when no preset detail report exposes the transaction rows or report-only columns
61
+ * you need; QuickBooks Desktop does not choose default columns for this report.
52
62
  *
53
63
  * @example
54
64
  * ```ts
@@ -69,7 +79,10 @@ export class Reports extends APIResource {
69
79
  }
70
80
 
71
81
  /**
72
- * Retrieves a custom summary report.
82
+ * Retrieves a custom summary report built from the row and column axes, filters,
83
+ * date period, calendar, and basis options you request. This report is useful when
84
+ * preset summary reports do not match the dimensions you need; QuickBooks Desktop
85
+ * does not assume a default layout.
73
86
  *
74
87
  * @example
75
88
  * ```ts
@@ -90,7 +103,12 @@ export class Reports extends APIResource {
90
103
  }
91
104
 
92
105
  /**
93
- * Retrieves a general detail report.
106
+ * Retrieves a QuickBooks Desktop general detail report with transaction-level
107
+ * rows, such as General Ledger, Journal, Open Invoices, unpaid bills, sales
108
+ * detail, purchase detail, audit trail, and transaction lists. This report is
109
+ * useful for inspecting the transactions behind balances, receivables, payables,
110
+ * sales, purchases, inventory valuation, and audit activity, including report-only
111
+ * columns that may not be available from standard object queries.
94
112
  *
95
113
  * @example
96
114
  * ```ts
@@ -110,7 +128,11 @@ export class Reports extends APIResource {
110
128
  }
111
129
 
112
130
  /**
113
- * Retrieves a general summary report.
131
+ * Retrieves a QuickBooks Desktop general summary report, such as a balance sheet,
132
+ * profit and loss, trial balance, sales, purchase, inventory, customer balance,
133
+ * vendor balance, sales tax, or income tax summary. This report is useful for
134
+ * aggregated financial or operational totals with optional date periods, filters,
135
+ * calendar settings, and column summarization.
114
136
  *
115
137
  * @example
116
138
  * ```ts
@@ -130,7 +152,11 @@ export class Reports extends APIResource {
130
152
  }
131
153
 
132
154
  /**
133
- * Retrieves a job report.
155
+ * Retrieves a QuickBooks Desktop job report for estimates versus actuals, item
156
+ * profitability, or job profitability. This report is useful for project costing,
157
+ * margin analysis, and estimate tracking by customer or job; job profitability
158
+ * detail and estimates-versus-actuals detail report types require a customer or
159
+ * job filter.
134
160
  *
135
161
  * @example
136
162
  * ```ts
@@ -150,7 +176,11 @@ export class Reports extends APIResource {
150
176
  }
151
177
 
152
178
  /**
153
- * Retrieves a payroll detail report.
179
+ * Retrieves a QuickBooks Desktop payroll detail report, including employee state
180
+ * tax detail, payroll item detail, payroll review detail, payroll transaction
181
+ * detail, and payroll transactions by payee. This report is useful for auditing
182
+ * paycheck line items, payroll item usage, tax calculations, and payee-level
183
+ * payroll activity.
154
184
  *
155
185
  * @example
156
186
  * ```ts
@@ -170,7 +200,10 @@ export class Reports extends APIResource {
170
200
  }
171
201
 
172
202
  /**
173
- * Retrieves a payroll summary report.
203
+ * Retrieves a QuickBooks Desktop payroll summary report, including payroll totals
204
+ * by employee, employee earnings by payroll item, and payroll liability balances.
205
+ * This report is useful for wage, tax, deduction, addition, employer contribution,
206
+ * and unpaid payroll liability reporting.
174
207
  *
175
208
  * @example
176
209
  * ```ts
@@ -190,7 +223,9 @@ export class Reports extends APIResource {
190
223
  }
191
224
 
192
225
  /**
193
- * Retrieves a time report.
226
+ * Retrieves a QuickBooks Desktop time report by item, job, or name, with summary
227
+ * or detail rows depending on the selected report type. This report is useful for
228
+ * analyzing tracked time for billing, costing, staffing, or project review.
194
229
  *
195
230
  * @example
196
231
  * ```ts
@@ -764,8 +799,10 @@ export interface ReportAgingParams {
764
799
 
765
800
  /**
766
801
  * Query param: The report columns to include, by column type. Accepts one or more
767
- * columns. When this parameter is present, QuickBooks Desktop omits its default
768
- * report columns unless you include them here.
802
+ * columns.
803
+ *
804
+ * **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
805
+ * default report columns unless you include them here.
769
806
  */
770
807
  includeColumns?: Array<
771
808
  | 'account'
@@ -1117,8 +1154,10 @@ export interface ReportBudgetSummaryParams {
1117
1154
  export interface ReportCustomDetailParams {
1118
1155
  /**
1119
1156
  * Query param: The report columns to include, by column type. Accepts one or more
1120
- * columns. When this parameter is present, QuickBooks Desktop omits its default
1121
- * report columns unless you include them here.
1157
+ * columns.
1158
+ *
1159
+ * **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
1160
+ * default report columns unless you include them here.
1122
1161
  */
1123
1162
  includeColumns: Array<
1124
1163
  | 'account'
@@ -1728,8 +1767,10 @@ export interface ReportCustomSummaryParams {
1728
1767
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
1729
1768
 
1730
1769
  /**
1731
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
1732
- * still omit subcolumns that it can easily compute from other returned values.
1770
+ * Query param: Whether to include subcolumns in the report.
1771
+ *
1772
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
1773
+ * compute from other returned values.
1733
1774
  */
1734
1775
  includeSubcolumns?: boolean;
1735
1776
 
@@ -2081,8 +2122,10 @@ export interface ReportGeneralDetailParams {
2081
2122
 
2082
2123
  /**
2083
2124
  * Query param: The report columns to include, by column type. Accepts one or more
2084
- * columns. When this parameter is present, QuickBooks Desktop omits its default
2085
- * report columns unless you include them here.
2125
+ * columns.
2126
+ *
2127
+ * **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
2128
+ * default report columns unless you include them here.
2086
2129
  */
2087
2130
  includeColumns?: Array<
2088
2131
  | 'account'
@@ -2529,8 +2572,10 @@ export interface ReportGeneralSummaryParams {
2529
2572
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
2530
2573
 
2531
2574
  /**
2532
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
2533
- * still omit subcolumns that it can easily compute from other returned values.
2575
+ * Query param: Whether to include subcolumns in the report.
2576
+ *
2577
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
2578
+ * compute from other returned values.
2534
2579
  */
2535
2580
  includeSubcolumns?: boolean;
2536
2581
 
@@ -2867,8 +2912,10 @@ export interface ReportJobParams {
2867
2912
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
2868
2913
 
2869
2914
  /**
2870
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
2871
- * still omit subcolumns that it can easily compute from other returned values.
2915
+ * Query param: Whether to include subcolumns in the report.
2916
+ *
2917
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
2918
+ * compute from other returned values.
2872
2919
  */
2873
2920
  includeSubcolumns?: boolean;
2874
2921
 
@@ -3199,8 +3246,10 @@ export interface ReportPayrollDetailParams {
3199
3246
 
3200
3247
  /**
3201
3248
  * Query param: The report columns to include, by column type. Accepts one or more
3202
- * columns. When this parameter is present, QuickBooks Desktop omits its default
3203
- * report columns unless you include them here.
3249
+ * columns.
3250
+ *
3251
+ * **IMPORTANT**: When this parameter is present, QuickBooks Desktop omits its
3252
+ * default report columns unless you include them here.
3204
3253
  */
3205
3254
  includeColumns?: Array<
3206
3255
  | 'account'
@@ -3575,8 +3624,10 @@ export interface ReportPayrollSummaryParams {
3575
3624
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
3576
3625
 
3577
3626
  /**
3578
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
3579
- * still omit subcolumns that it can easily compute from other returned values.
3627
+ * Query param: Whether to include subcolumns in the report.
3628
+ *
3629
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
3630
+ * compute from other returned values.
3580
3631
  */
3581
3632
  includeSubcolumns?: boolean;
3582
3633
 
@@ -3814,8 +3865,10 @@ export interface ReportTimeParams {
3814
3865
  entityType?: 'customer' | 'employee' | 'other_name' | 'vendor';
3815
3866
 
3816
3867
  /**
3817
- * Query param: Whether to include subcolumns in the report. QuickBooks Desktop may
3818
- * still omit subcolumns that it can easily compute from other returned values.
3868
+ * Query param: Whether to include subcolumns in the report.
3869
+ *
3870
+ * **NOTE**: QuickBooks Desktop may still omit subcolumns that it can easily
3871
+ * compute from other returned values.
3819
3872
  */
3820
3873
  includeSubcolumns?: boolean;
3821
3874
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '14.14.0'; // x-release-please-version
1
+ export const VERSION = '14.15.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "14.14.0";
1
+ export declare const VERSION = "14.15.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "14.14.0";
1
+ export declare const VERSION = "14.15.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '14.14.0'; // x-release-please-version
4
+ exports.VERSION = '14.15.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '14.14.0'; // x-release-please-version
1
+ export const VERSION = '14.15.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map