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